Due

https://due.readme.io/docs
Admin
Due provides modern borderless payment infrastructure for global businesses and fintechs, enabling...
Tokens:120,383
Snippets:865
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Virtual Account - Key Example

Source: https://due.readme.io/docs/virtual-accounts

Example of a composite key used to retrieve a specific virtual account.

```text
wlt_e9RPxFnbySqoiIBQ/bank_sepa/EUR/base-sepolia/USDC/test_va
```

--------------------------------

### Get Single Market Rate - Example (GBP/JPY)

Source: https://due.readme.io/docs/fx-engine

Example curl command to fetch the GBP/JPY market rate.

```bash
curl -s https://api.due.network/fx/markets/GBP/JPY | jq .
```

--------------------------------

### List All Markets - Example Request

Source: https://due.readme.io/docs/fx-engine

Example curl command to fetch all markets and pretty-print with jq.

```bash
curl -s https://api.due.network/fx/markets | jq .
```

--------------------------------

### Webhook subscription example

Source: https://due.readme.io/docs/requests-for-information

Example webhook subscription configuration for transfer and information-request events.

```json
{
  "url": "https://example.com/webhooks/due",
  "events": ["transfer.status_changed", "information_request.updated"],
  "description": "Transfer and information-request updates"
}
```

--------------------------------

### Response for GET v1/schemas

Source: https://due.readme.io/docs/schemas

Example response for the GET v1/schemas request, showing schema descriptors for bank_sepa and evm.

```json
[
  {
    "id": "bank_sepa",
    "category": "bank",
    "fields": [
      {
        "key": "accountType",
        "type": "string",
        "oneOf": ["individual", "business"],
        "required": true
      },
      {
        "key": "IBAN",
        "type": "iban",
        "required": true
      },
      {
        "key": "companyName",
        "type": "string",
        "requiredIf": "accountType=business"
      }
    ]
  },
  {
    "id": "evm",
    "category": "crypto",
    "fields": [
      {
        "key": "address",
        "type": "eth_addr",
        "required": true
      }
    ]
  }
]
```

--------------------------------

### Requirement JSON Examples

Source: https://due.readme.io/docs/individual-kyc-process

JSON examples illustrating static, conditional, oneOf, and document structures.

```json
{
  "kind": "static",
  "info": [
    {
      "key": "firstName",
      "type": "string"
    },
    {
      "key": "lastName",
      "type": "string"
    }
  ],
  "documents": [
    {
      "category": "ID",
      "oneOf": [
        { "type": "PASSPORT" },
        { "type": "ID_CARD", "variants": ["FRONT_SIDE", "BACK_SIDE"] }
      ]
    }
  ],
  "questionnaires": [
    {
      "templateId": "pep_sanctions",
      "questions": [...]
    }
  ]
}
```

```json
{
  "kind": "conditional",
  "if": [
    { "type": "PASSPORT" }
  ],
  "then": [
    {
      "info": [
        {
          "key": "passportExpiryDate",
          "type": "date"
        }
      ],
      "required": true
    }
  ]
}
```

```json
{
  "kind": "oneOf",
  "oneOf": [
    {
      "kind": "static",
      "info": [
        {
          "key": "address",
          "type": "object",
          "fields": [
            { "key": "country", "type": "iso3166_1_alpha2" },
            { "key": "postCode", "type": "string" },
            { "key": "town", "type": "string" }
          ]
        }
      ]
    },
    {
      "kind": "static",
      "documents": [
        {
          "category": "PROOF_OF_ADDRESS",
          "oneOf": [
            { "type": "UTILITY_BILL" },
            { "type": "OTHER" }
          ]
        }
      ]
    }
  ]
}
```

```json
{
  "category": "ID",
  "oneOf": [
    { "type": "PASSPORT" },
    { "type": "ID_CARD", "variants": ["FRONT_SIDE", "BACK_SIDE"] },
    { "type": "RESIDENCE_PERMIT", "variants": ["FRONT_SIDE", "BACK_SIDE"] }
  ]
}
```

--------------------------------

### Business requirements example

Source: https://due.readme.io/docs/eur-named-virtual-account-endorsement

Example of business requirements returned in the endorsement response.

```json
[
  {
    "kind": "static",
    "info": [
      { "key": "email", "type": "email" },
      { "key": "phone", "type": "e164" },
      { "key": "website", "type": "string" },
      { "key": "registrationNumber", "type": "string" },
      {
        "key": "address",
        "type": "object",
        "fields": [
          { "key": "country", "type": "iso3166_1_alpha2" },
          { "key": "postCode", "type": "swift_x" },
          { "key": "town", "type": "swift_x" },
          { "key": "street", "type": "swift_x" }
        ]
      }
    ]
  }
]
```

--------------------------------

### Get Single Market Rate - Cross-Rate Example (MXN/EUR)

Source: https://due.readme.io/docs/fx-engine

Example curl command to fetch the MXN/EUR cross-rate.

```bash
curl -s https://api.due.network/fx/markets/MXN/EUR | jq .
```

--------------------------------

### Signature Example

Source: https://due.readme.io/docs/create-credential

Example hex-encoded signature output from the signing command.

```text
30450220129dd58a1b64a0d04
```

--------------------------------

### Individual requirements example

Source: https://due.readme.io/docs/eur-named-virtual-account-endorsement

Example of individual requirements returned in the endorsement response.

```json
[
  {
    "kind": "static",
    "info": [
      { "key": "nationality", "type": "iso3166_1_alpha2" },
      { "key": "birthCountry", "type": "iso3166_1_alpha2" },
      { "key": "phone", "type": "e164" },
      { "key": "email", "type": "email" },
      {
        "key": "address",
        "type": "object",
        "fields": [
          { "key": "postCode", "type": "swift_x" },
          { "key": "town", "type": "swift_x" },
          { "key": "street", "type": "swift_x" }
        ]
      }
    ]
  }
]
```

--------------------------------

### Get financial institutions with curl

Source: https://due.readme.io/docs/recipients

Fetches financial institutions for a specific country and provider. The first example queries Nigerian banks (NG/bank_africa), the second queries Kenyan mobile money providers (KE/momo_africa). Both require the Authorization and Due-Account-Id headers.

```bash
curl -H "Authorization: Bearer your_api_key" \
  -H "Due-Account-Id: your_account_id" \
  https://api.due.network/v1/financial_institutions/NG/bank_africa
```

```bash
curl -H "Authorization: Bearer your_api_key" \
  -H "Due-Account-Id: your_account_id" \
  https://api.due.network/v1/financial_institutions/KE/momo_africa
```

--------------------------------

### curl example for EUR/USD 15-minute history

Source: https://due.readme.io/docs/fx-engine

Command-line example using curl and jq to fetch 15-minute historical data for EUR/USD. The response is a JSON array of objects with date and rate fields.

```bash
curl -s "https://api.due.network/fx/markets/EUR/USD/history?interval=15" | jq .
```

--------------------------------

### KYB submission example

Source: https://due.readme.io/docs/sumsub-kyb-sharing

Example of a KYB submission object showing missing requirements.

```json
{
  "id": "ksub_company_123",
  "ownerId": "acct_company_123",
  "applicantId": "acct_company_123",
  "status": "open",
  "info": {},
  "requirements": [
    {
      "kind": "static",
      "info": [
        { "key": "companyName", "type": "string" },
        { "key": "registrationNumber", "type": "string" },
        { "key": "address", "type": "object" }
      ]
    }
  ],
  "documents": [],
  "questionnaires": []
}
```

--------------------------------

### Create Account Response

Source: https://due.readme.io/docs/tos-acceptance

Example response from the Create account endpoint, showing the TOS object structure.

```json
{
  "id": "acct_...",
  // ...
  "tos": {
    "id": "ta_...",
    "entityName": "DUE LTD",
    "status": "pending",
    "link": "/tos/token_1234567890",
    "documentLinks": {
      "tos": "https://link.to/terms_of_service",
      "privacyPolicy": "https://link.to/privacy_policy"
    },
    "acceptedAt": null,
    "token": "token_1234567890"
  }
}
```

--------------------------------

### ToS event example

Source: https://due.readme.io/docs/list-of-events

Example webhook payload for a bp.tos_accepted event, including the account data, KYC status, and terms of service acceptance details.

```json
{
		"id": "wh_evt__123",
  "type": "bp.tos_accepted",
  "data": {
    "id": "acct_98765ABCDE",
    "type": "individual",
    "name": "Demo Account",
    "email": "demo@due.network",
    "country": "DEU",
    "category": "self-employed",
    "status": "passed",
    "kyc": {
      "status": "passed",
      "link": "http://example.com",
    },
    "tos": {
      "id": "ta_aygJdj8aQpC1IAjz",
      "entityName": "Due Ltd",
      "status": "accepted",
      "link": "https://www.opendue.com/legal/t-and-c",
      "documentLinks": [{
        "tos": "tos123",
        "privacyPolicy": "tos123",
      }],
      "acceptedAt": "2025-09-22T12:00:00Z",
      "token": "token123"
    }
  },
	"occurredAt": "2025-09-22T12:00:00Z",
	"attemptedAt": "2025-09-22T12:00:00Z"
}
```

--------------------------------

### Requirements array examples

Source: https://due.readme.io/docs/kyc-endorsements

Two JSON examples showing the structure of the requirements array for a business endorsement: one for company information fields and one for required document categories.

```json
{
  "kind": "static",
  "info": [
    { "key": "companyName", "type": "string" },
    { "key": "registrationNumber", "type": "string" },
    { "key": "registrationDate", "type": "date" },
    { "key": "taxId", "type": "string" }
  ]
}
```

```json
{
  "kind": "static",
  "documents": [
    { "category": "COMPANY_DETAILS", "oneOf": [{ "type": "INCORPORATION_CERT" }] },
    { "category": "COMPANY_CONTROL_STRUCTURE", "oneOf": [{ "type": "DIRECTORS_REGISTRY" }] },
    { "category": "COMPANY_AUTHORIZATION", "oneOf": [{ "type": "CORPORATE_RESOLUTION" }] },
    { "category": "TAX_REGISTRATION", "oneOf": [{ "type": "COMPANY_FISCAL_REG_CERT" }] },
    { "category": "TAX_COMPLIANCE", "oneOf": [{ "type": "FATCA" }] },
    { "category": "FINANCIAL_STATEMENTS", "oneOf": [{ "type": "FINANCIAL_STATEMENTS" }] },
    { "category": "PROOF_OF_ADDRESS", "oneOf": [{ "type": "PROOF_OF_ADDRESS" }] },
    { "category": "SOURCE_OF_FUNDS", "oneOf": [{ "type": "TAX_ID_NUMBER" }] }
  ]
}
```

--------------------------------

### Account ID, Endorsement Code, and Channel Request

Source: https://due.readme.io/docs/kyc-endorsements

This snippet shows the account ID example, the endorsement code example, and the HTTP request with the JSON response containing the channel details and endorsementsRequired field.

```text
acct_DqvgNSAuQv5OEK9v
```

```text
usd_pr_bank_business_v1
```

```http
GET /v1/channels


{
        "rail": "ach",
        "railSettings": {
            "rail": "ach",
            "speed": "1-2 days",
            "memoConfig": {
                "minCharacters": 0,
                "maxCharacters": 10,
                "required": false
            },
            "schemas": [
                "bank_us"
            ]
        },
        "currencyCode": "USD",
        "feeBps": 20,
        "feeFixed": "20",
        "limitMin": "1",
        "limitMax": "500000",
        "kycLevels": [],
        "type": "deposit",
        "accountType": "business",
        "permissions": {
            "restrictedResidencies": [
                "US"
            ],
            "restrictedCategories": [
                "gambling"
            ]
        },
        "purposeCodes": {},
        "endorsementsRequired": [
            "usd_pr_bank_business_v1"
        ]
    }
```

--------------------------------

### Individual requirements example

Source: https://due.readme.io/docs/aud-bank-virtual-account-endorsement

Example of the submission.requirements array for an individual account. Complete these fields when the endorsement response creates a KYC/KYB submission.

```json
[
  {
    "kind": "static",
    "info": [
      { "key": "firstName", "type": "string" },
      { "key": "lastName", "type": "string" },
      { "key": "nationality", "type": "iso3166_1_alpha2" },
      { "key": "email", "type": "email" },
      { "key": "phone", "type": "e164" },
      {
        "key": "address",
        "type": "object",
        "fields": [
          { "key": "country", "type": "iso3166_1_alpha2" },
          { "key": "postCode", "type": "swift_x" },
          { "key": "town", "type": "swift_x" },
          { "key": "street", "type": "swift_x" },
          { "key": "state", "type": "iso3166_2" }
        ]
      }
    ]
  }
]
```

--------------------------------

### List wallets - GET /v1/wallets

Source: https://due.readme.io/docs/wallets

Lists all wallets linked to the account via GET /v1/wallets. Requires Due-Account-Id header. Returns 200 OK with an array of wallet records.

```bash
curl --request GET https://api.due.network/v1/wallets \
  --header "Authorization: Bearer $DUE_API_KEY" \
  --header "Accept: application/json" \
  --header "Due-Account-Id: acct_123"
```

--------------------------------

### Virtual Account Creation Response

Source: https://due.readme.io/docs/virtual-accounts

Example of a virtual account creation response with details.

```json
{
  "id": "va_oy3U6R3Xa7D9Y",
  "key": "wlt_e9RPxFnbySqoiIBQ/bank_sepa/EUR/base-sepolia/USDC/test_va",
  "ownerId": "acct_DppceB5ndoBnRQMH",
  "walletId": "wlt_e9RPxFnbySqoiIBQ",
  "currencyIn": "EUR",
  "railOut": "base-sepolia",
  "currencyOut": "USDC",
  "reference": "test_va",
  "details": {
    "IBAN": "IE25MODR99035504017602",
    "accountType": "business",
    "companyName": "Due Payments EOOD",
    "schema": "bank_sepa",
    "swiftCode": "MODRIE22"
  }
}
```

--------------------------------

### Business requirements example response.json

Source: https://due.readme.io/docs/aed-bank-virtual-account-endorsement

This JSON example shows the business requirements format that may be returned in the submission.requirements array. It includes companyName and registrationNumber fields.

```json
[
  {
    "kind": "static",
    "info": [
      { "key": "companyName", "type": "string" },
      { "key": "registrationNumber", "type": "string" }
    ]
  }
]
```

--------------------------------

### Example submission requirements for usd_bank_erebor_v1

Source: https://due.readme.io/docs/erebor-usd-virtual-account-endorsement

Example submission requirements returned by the endorsement request. Use submission.requirements as the source of truth for the fields, agreements, and questionnaires you must complete. The requirements include conditional fields (e.g., SSN for US residents), static fields, agreements with documentSetIds, and a questionnaire template.

```json
[
  {
    "if": {
      "info": [{ "key": "residenceCountry", "type": "string", "oneOf": ["US"] }],
      "kind": "static"
    },
    "kind": "conditional",
    "then": {
      "info": [{ "key": "ssn", "type": "string" }],
      "kind": "static"
    }
  },
  {
    "info": [
      { "key": "nationality", "type": "iso3166_1_alpha2" },
      { "key": "phone", "type": "e164" },
      { "key": "email", "type": "email" },
      {
        "key": "address",
        "type": "object",
        "fields": [
          { "key": "country", "type": "iso3166_1_alpha2" },
          { "key": "postCode", "type": "swift_x" },
          { "key": "town", "type": "swift_x" },
          { "key": "street", "type": "swift_x" },
          { "key": "state", "type": "iso3166_2" }
        ]
      }
    ],
    "kind": "static",
    "agreements": [
      {
        "consentText": "I consent to sign electronically and agree this e-signature is legally binding.",
        "documentSetId": "ds_RirCkN88vbWPLlGX"
      },
      {
        "consentText": "By checking the box and clicking \"Submit,\" you acknowledge that you have received, reviewed, and agree to be bound by the terms of the Erebor Bank, N.A. deposit account relationship agreement and related disclosures, which together form your agreement with Erebor Bank, N.A.\nYou also certify that all information you have provided is true, accurate, and complete, and you authorize Erebor Bank, N.A. to verify your identity and obtain information about you from third parties as permitted by law.",
        "documentSetId": "ds_RinPm0BIL4fM3t5Y"
      }
    ]
  },
  {
    "kind": "static",
    "questionnaires": [
      {
        "questions": [
          {
            "id": "employment_status",
            "title": "What is your employment status?",
            "schema": {
              "type": "choice",
              "options": [
                { "id": "full_time", "label": "Full-time" },
                { "id": "part_time", "label": "Part-time" },
                { "id": "unemployed", "label": "Unemployed" }
              ]
            },
            "requiredWhen": null
          },
          {
            "id": "annual_income",
            "title": "What is your annual income (in USD)?",
            "schema": { "type": "number" },
            "requiredWhen": null
          }
        ],
        "templateId": "ereborBankQs"
      }
    ]
  }
]
```

--------------------------------

### List RFIs for an account

Source: https://due.readme.io/docs/requests-for-information

List all RFIs for an account using the GET endpoint.

```bash
curl "https://api.due.network/v1/information_requests" \
  -H "Authorization: Bearer <token>"
```

--------------------------------

### Correct Due-Account-Id Header

Source: https://due.readme.io/docs/kyc-endorsements

Correct example of the Due-Account-Id header.

```text
Due-Account-Id: acct_DqvgNSAuQv5OEK9v
```

--------------------------------

### GET /v1/channels

Source: https://due.readme.io/docs/virtual-accounts

Discover available configurations for virtual accounts by listing supported input and output combinations.

```APIDOC
## [GET] /v1/channels

### Description
Use the channels endpoint to find supported input and output combinations. For a default destination purpose, select a value from the settlement channel’s `purpose_codes` list and pass it as `destinationPurposeCode` when you create the virtual account.

### Method
GET

### Endpoint
https://api.due.network/v1/channels

### Parameters
No parameters documented in the source.

### Request Example
```bash
# Get available static deposit methods
curl -H "Authorization: Bearer your_api_key" \
-H "Due-Account-Id: your_account_id" \
https://api.due.network/v1/channels | jq '.[] | select(.type == "static_deposit")'

# Get available settlement methods (withdrawal type)  
curl -H "Authorization: Bearer your_api_key" \
-H "Due-Account-Id: your_account_id" \
https://api.due.network/v1/channels | jq '.[] | select(.type == "withdrawal")'
```

### Response
#### Success Response (200)
No response schema provided in the source.

#### Response Example
No response example provided in the source.

```

--------------------------------

### Generate Quote

Source: https://due.readme.io/docs/stablecoin-to-fiat-transfers

Get real-time pricing for a crypto-to-fiat conversion by providing source details.

```bash
curl -X POST https://api.due.network/v1/transfers/quote \
-H "Authorization: Bearer your_api_key" \
-H "Due-Account-Id: your_account_id" \
-H "Content-Type: application/json" \
-d '{
  "source": {
    "rail": "ethereum",
    "currency": "USDC",
    "amount": "1000.00"
  }
}'
```

--------------------------------

### Integration Example (cURL)

Source: https://due.readme.io/docs/tos-acceptance

Shell script demonstrating how to fetch account data, extract TOS token, and submit acceptance.

```bash
# Step 1 - Fetch account to get TOS data
ACCOUNT=$(curl -s -X GET "https://api.due.network/v1/accounts/ACCOUNT_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json")

TOKEN=$(echo "$ACCOUNT" | jq -r ".tos.token")

echo "TOS:            $(echo "$ACCOUNT" | jq -r ".tos.documentLinks.tos")"
echo "Privacy Policy: $(echo "$ACCOUNT" | jq -r ".tos.documentLinks.privacyPolicy")"

# Step 3 - Submit TOS acceptance with the user's real IP
curl -X POST "https://api.due.network/v1/tos/$TOKEN" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ipAddress": "203.0.113.42"}'
```

--------------------------------

### Main demo workflow

Source: https://due.readme.io/docs/python-demo-script

The main() function orchestrates the entire demo: prompts for API token and account ID, loads or generates a primary keypair, creates a credential, creates a wallet, links it to the account, generates a backup keypair, approves the backup credential, creates a second wallet, and lists final credentials. It requires the environment variable PRIMARY_KEY to optionally load an existing PEM key.

```python
def main():
    print("=" * 60)
    print("Due Managed Wallets — API Demo")
    print("=" * 60)

    token = input("\nAPI token (Bearer): ").strip()
    account_id = input("Account ID: ").strip()

    if not token or not account_id:
        print("Both token and account ID are required.")
        return

    # Step 1 — Load or generate primary keypair & resolve credential
    key_file = os.environ.get("PRIMARY_KEY")  # path to existing PEM
    if key_file and os.path.exists(key_file):
        print(f"\n[1] Loading primary key from {key_file}...")
        pk1, pub1 = load_private_key(key_file)
        # Find existing credential by matching public key
        cred1 = find_credential_by_pubkey(token, pub1)
        if cred1:
            print(f"  Found existing credential: {cred1}")
        else:
            print("  No existing credential found for this key, creating...")
            cred1 = step_create_credential(token, "Primary key", pk1, pub1)
    else:
        print("\n[1] Generating primary keypair...")
        pk1, pub1 = generate_keypair()
        out_path = key_file or "primary_key.pem"
        with open(out_path, "w") as f:
            f.write(export_private_pem(pk1))
        print(f"  Private key saved to: {out_path}")
        cred1 = step_create_credential(token, "Primary key", pk1, pub1)

    # Step 2 — Create wallet
    print("\n[2] Creating wallet...")
    wallet_id, address = step_create_wallet(token, pk1, cred1)

    # Step 3 — Link wallet to account
    print("\n[3] Linking wallet to account...")
    step_link_wallet(token, address, account_id)

    # Step 4 — Generate second keypair & create backup credential
    print("\n[4] Generating backup keypair...")
    pk2, pub2 = generate_keypair()
    cred2 = step_create_credential(token, "Backup key", pk2, pub2)

    # Step 5 — Approve backup credential (signed by primary)
    print("\n[5] Approving backup credential...")
    step_approve_credential(token, cred2, pk1, cred1)

    # Step 6 — Create second wallet using backup key
    print("\n[6] Creating second wallet (using backup key)...")
    wallet_id2, address2 = step_create_wallet(token, pk2, cred2)

    # Final — List credentials
    print("\n[7] Final credential state:")
    step_list_credentials(token)

    print("\n" + "=" * 60)
    print("Demo complete!")
    print("=" * 60)


if __name__ == "__main__":
    main()
```

--------------------------------

### Integration Example (Python)

Source: https://due.readme.io/docs/tos-acceptance

Python function that fetches account data, extracts TOS token, and submits acceptance with the user's IP.

```python
import requests

API_BASE = "https://api.due.network"
API_KEY = "YOUR_API_KEY"

def accept_tos(account_id: str, client_ip: str) -> dict:
    # Step 1 - Fetch account to get TOS data
    account = requests.get(
        f"{API_BASE}/v1/accounts/{account_id}",
        headers={
            "Authorization": f"Bearer {API_KEY}",
            "Content-Type": "application/json"
        }
    )
    account.raise_for_status()
    account = account.json()

    tos = account["tos"]
    token = tos["token"]

    # Step 2 - Present documents to user
    tos_url = tos["documentLinks"]["tos"]
    privacy_url = tos["documentLinks"]["privacyPolicy"]
    # Display these PDFs to the user in your UI

    # Step 3 - Submit TOS acceptance with the user's real IP
    response = requests.post(
        f"{API_BASE}/v1/tos/{token}",
        headers={
            "Authorization": f"Bearer {API_KEY}",
            "Content-Type": "application/json"
        },
        json={
            "ipAddress": client_ip
        }
    )
    response.raise_for_status()
    result = response.json()

    if result["status"] == "accepted":
        return {
            "status": "accepted",
            "acceptedAt": result["acceptedAt"]
        }

    return {"status": "pending"}
```

--------------------------------

### Response - List of Financial Institutions

Source: https://due.readme.io/docs/financial-institutions

Example JSON response from the GET /financial_institutions endpoint. Contains an array of institutions with id, name, country, and schemas fields.

```json
[
  {
    "id": "fininst_qGGYZKST47dI8bRm",
    "name": "Enterprise Bank",
    "country": "NG",
    "schemas": ["bank_africa"]
  },
  {
    "id": "fininst_xyz123abc456def789",
    "name": "Access Bank Nigeria",
    "country": "NG", 
    "schemas": ["bank_africa"]
  },
  {
    "id": "fininst_mtn456def789ghi012",
    "name": "MTN Mobile Money",
    "country": "NG",
    "schemas": ["momo_africa"]
  }
]
```

--------------------------------

### Create Business Account

Source: https://due.readme.io/docs/sumsub-kyb-sharing

Create a business account and save the returned account ID.

```bash
curl --request POST \
  --url https://api.due.network/v1/accounts \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "business",
    "name": "Example Company Ltd",
    "email": "compliance@example.com",
    "country": "GB",
    "category": "company"
  }'
```

```json
{
  "id": "acct_company_123",
  "type": "business",
  "name": "Example Company Ltd"
}
```

--------------------------------

### Get Available Channels - GET /v1/channels

Source: https://due.readme.io/docs/rails-and-channels

Retrieves all enabled payment channels. The response includes an array of channel objects with rail, currency, fees, type, KYC levels, rail settings, and purpose codes. The example shows SEPA, ACH, and Ethereum channels with their respective configurations.

```http
GET /v1/channels
```

```json
{
  "channels": [
    {
      "rail": "sepa",
      "currencyCode": "EUR",
      "feeBps": 36,
      "feeFixed": "0.90",
      "type": "withdrawal",
      "kycLevels": [],
      "railSettings": {
        "speed": "Instant",
        "memoConfig": {
          "maxCharacters": 35,
          "minCharacters": 6
        },
        "schemas": ["bank_sepa"]
      }
    },
    {
      "rail": "ach",
      "currency_code": "USD",
      "feeBps": 30,
      "feeFixed": "0.50", 
      "type": "withdrawal",
      "kycLevels": [],
      "railSettings": {
        "speed": "1-2 days",
        "memoConfig": {
          "maxCharacters": 10,
          "minCharacters": 0
        },
        "schemas": ["bank_us"]
      },
      "purposeCodes": {
        "any": ["OTHER"],
        "individual": ["FAMILY_SUPPORT"],
        "business": ["LOAN_PAYMENT"] 
      }
    },
    {
      "rail": "ethereum",
      "currencyCode": "USDC",
      "feeBps": 0,
      "feeFixed": "0.00",
      "type": "withdrawal", 
      "kycLevels": [],
      "railSettings": {
        "speed": "Instant",
        "memoConfig": null,
        "schemas": ["evm"]
      }
    }
  ]
}
```

--------------------------------

### Python: Create wallet (vault) using Pattern 2

Source: https://due.readme.io/docs/python-demo-script

Creates a wallet by calling challenge_response on /v1/vaults with an empty payload. Returns the wallet ID and address.

```python
def step_create_wallet(
    token: str,
    private_key: ec.EllipticCurvePrivateKey,
    cred_id: str,
) -> tuple[str, str]:
    """Create a wallet (vault) using Pattern 2. Returns (wallet_id, address)."""
    print("\n--- Creating wallet (vault) ---")
    resp = challenge_response("/v1/vaults", {}, private_key, cred_id, token)
    wallet_id = resp["id"]
    address = resp["address"]
    print(f"  Wallet ID: {wallet_id}")
    print(f"  Address:   {address}")
    return wallet_id, address
```

--------------------------------

### Python SDK for Due Recipients API

Source: https://due.readme.io/docs/recipients

Python SDK wrapper for the Due Recipients API. Provides methods to create, list, get, and delete recipients, plus retrieve schemas, channels, and financial institutions. The usage example creates a US bank recipient, filters bank schemas, and fetches Nigerian banks.

```python
import requests

class DueRecipientsAPI:
    def __init__(self, api_key: str, account_id: str):
        self.base_url = "https://api.due.network/v1"
        self.headers = {
            "Authorization": f"Bearer {api_key}",
            "Due-Account-Id": account_id,
            "Content-Type": "application/json"
        }
    
    def create_recipient(self, recipient_data: dict) -> dict:
        response = requests.post(f"{self.base_url}/recipients", 
                               headers=self.headers, json=recipient_data)
        response.raise_for_status()
        return response.json()
    
    def list_recipients(self, with_deleted: bool = False) -> dict:
        params = {"with_deleted": with_deleted} if with_deleted else {}
        response = requests.get(f"{self.base_url}/recipients", 
                              headers=self.headers, params=params)
        return response.json()
    
    def get_recipient(self, recipient_id: str) -> dict:
        response = requests.get(f"{self.base_url}/recipients/{recipient_id}", 
                              headers=self.headers)
        return response.json()
    
    def delete_recipient(self, recipient_id: str) -> dict:
        response = requests.delete(f"{self.base_url}/recipients/{recipient_id}", 
                                 headers=self.headers)
        return response.json()
    
    def get_schemas(self) -> list:
        response = requests.get(f"{self.base_url}/schemas", headers=self.headers)
        return response.json()
    
    def get_channels(self) -> list:
        response = requests.get(f"{self.base_url}/channels", headers=self.headers)
        return response.json()
    
    def get_financial_institutions(self, country: str, schema: str) -> list:
        response = requests.get(f"{self.base_url}/financial_institutions/{country}/{schema}", 
                              headers=self.headers)
        return response.json()

# Usage
api = DueRecipientsAPI("your_api_key", "your_account_id")

# Create US bank recipient
us_recipient = api.create_recipient({
    "id": "emp_sarah_001",
    "country": "US",
    "name": "Sarah Johnson", 
    "email": "sarah@company.com",
    "details": {
        "bankName": "Bank of America",
        "accountName": "Sarah Johnson",
        "accountNumber": "987654321",
        "routingNumber": "021000021",
        "beneficiaryAddress": {
            "street_line_1": "456 Oak St",
            "city": "Los Angeles",
            "state": "CA",
            "postal_code": "90210",
            "country": "USA"
        }
    }
})

# Get available schemas
schemas = api.get_schemas()
bank_schemas = [s for s in schemas if s['category'] == 'bank']
print(f"Available bank schemas: {[s['id'] for s in bank_schemas]}")

# Get Nigerian banks for institution selection
ng_banks = api.get_financial_institutions("NG", "bank_africa")
print(f"Nigerian banks: {[b['name'] for b in ng_banks]}")
```

--------------------------------

### GET /recipients/{id}

Source: https://due.readme.io/docs/recipients-1

Gets recipient details.

```APIDOC
## GET /recipients/{id}

### Description
Gets recipient details.

### Method
GET

### Endpoint
`/recipients/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - Recipient ID

### Response
#### Success Response (200)
- **id** (string) - Recipient ID
- **label** (string) - Recipient label
- **details** (object) - Payment details
- **isExternal** (boolean) - Whether external
- **isActive** (boolean) - Whether active
```

--------------------------------

### Python: Create credential using Pattern 1 (direct signing)

Source: https://due.readme.io/docs/python-demo-script

Creates a credential by initializing with /v1/vaults/credentials/init, signing a JSON payload with the private key, and submitting to /v1/vaults/credentials. Returns the credential ID and prints whether it is approved.

```python
def step_create_credential(
    token: str, name: str, private_key: ec.EllipticCurvePrivateKey, public_pem: str,
) -> str:
    """Create a credential using Pattern 1 (direct signing). Returns credentialId."""
    print(f"\n--- Creating credential: {name} ---")

    # Init
    init = api_call("POST", "/v1/vaults/credentials/init",
                     body={"kind": "Key", "name": name}, token=token)
    challenge = init["challenge"]
    client_data_hash = init["clientDataHash"]
    print(f"  Challenge received: {challenge[:40]}...")

    # Build JSON to sign
    challenge_json = json.dumps(
        {"clientDataHash": client_data_hash, "publicKey": public_pem},
        separators=(",", ":"),
    )
    sig = sign_hex(private_key, challenge_json.encode())

    # Submit
    cred = api_call("POST", "/v1/vaults/credentials", token=token, body={
        "kind": "Key",
        "signature": sig,
        "publicKey": public_pem,
        "challenge": challenge,
    })
    cred_id = cred["id"]
    approved = cred.get("approveUntil") is None
    print(f"  Credential created: {cred_id}")
    print(f"  Approved: {approved}")
    return cred_id
```

--------------------------------

### Submission ID Example

Source: https://due.readme.io/docs/kyc-endorsements

Example of a submission ID returned by the endorsement response.

```text
ksub_i11Sowou6GxhBRux
```

--------------------------------

### Complete viem example for signing Due signable

Source: https://due.readme.io/docs/signing-due-signables-from-kernel-v3-smart-accounts

Complete function that signs a Due signable hash for a Kernel v3 smart account using viem. It uses privateKeyToAccount and signTypedData, then prepends the mode byte. The modeByte parameter defaults to 0x00 (sudo/root mode).

```typescript
import { hashTypedData, signTypedData, concat, toHex } from "viem"
import { privateKeyToAccount } from "viem/accounts"

async function signForKernelViem(
  privateKey: `0x${string}`,
  kernelAccountAddress: `0x${string}`,
  chainId: number,
  originalHash: `0x${string}`,
  modeByte: number = 0x00,
): Promise<`0x${string}`> {
  const account = privateKeyToAccount(privateKey)

  const signature = await signTypedData({
    privateKey,
    domain: {
      name: "Kernel",
      version: "0.3.3",
      chainId: BigInt(chainId),
      verifyingContract: kernelAccountAddress,
    },
    types: {
      Kernel: [{ name: "hash", type: "bytes32" }],
    },
    primaryType: "Kernel",
    message: { hash: originalHash },
  })

  return concat([toHex(modeByte, { size: 1 }), signature])
}
```

--------------------------------

### Discovering Available Configurations

Source: https://due.readme.io/docs/virtual-accounts

Discover available input and output configurations using the channels endpoint.

```bash
# Get available static deposit methods
curl -H "Authorization: Bearer your_api_key" \
-H "Due-Account-Id: your_account_id" \
https://api.due.network/v1/channels | jq '.[] | select(.type == "static_deposit")'
```

```bash
# Get available settlement methods (withdrawal type)  
curl -H "Authorization: Bearer your_api_key" \
-H "Due-Account-Id: your_account_id" \
https://api.due.network/v1/channels | jq '.[] | select(.type == "withdrawal")'
```

--------------------------------

### Webhook Event Example

Source: https://due.readme.io/docs/tos-acceptance

Example webhook event payload dispatched when a TOS is accepted.

```json
{
  "id": "evt_...",
  "type": "bp.tos_accepted",
  "data": {
    "id": "acct_...",
    "type": "individual",
    "name": "John Snow",
    "email": "demo@due.network",
    "country": "US",
    "category": "self-employed",
    "status": "passed",
    "kyc": "69.420"
  }
}
```

--------------------------------

### Create Due Wallet - Initial Request

Source: https://due.readme.io/docs/create-due-vault

Initial request to create a Due wallet. The payload is empty `{}` for wallet creation. Expect a 403 error with a challenge in response.

```bash
curl --location 'https://api.due.network/v1/vaults' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{}'
```

--------------------------------

### Create an account

Source: https://due.readme.io/docs/individual-kyc-process

Create an individual account and extract the account ID from the response.

```shell
curl --request POST \
     --url https://api.due.network/v1/accounts \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <API_KEY>' \
     --header 'content-type: application/json' \
     --data '
{
  "type": "individual",
  "name": "John Snow",
  "email": "john@example.com",
  "country": "GB",
  "category": "employed"
}
'

```

```json
{
    "id": "acct_DlsiOQ7RxG1hgJVL",
    // ...
}

```

--------------------------------

### Create JSON File with Client Data and Public Key

Source: https://due.readme.io/docs/create-credential

Creates a JSON file containing the clientDataHash and the public key in PEM format, avoiding escape issues.

```bash
# Create JSON file with clientDataHash and public key
cat > challenge.json << EOF
{"clientDataHash":"<clientDataHash_from_response>","publicKey":$(cat public.pem | jq -Rs .)}
EOF
```

--------------------------------

### Sharing response example

Source: https://due.readme.io/docs/sumsub-kyb-sharing

Example of the sharing response showing a pending resubmission status and submission ID.

```json
{
  "status": "resubmission_pending",
  "submissionId": "ksub_company_123"
}
```

--------------------------------

### Transfer status changed event example

Source: https://due.readme.io/docs/requests-for-information

Example transfer.status_changed event payload indicating action_required status.

```json
{
  "id": "wh_evt_xxx",
  "type": "transfer.status_changed",
  "data": {
    "id": "tf_xxx",
    "ownerId": "acct_xxx",
    "status": "action_required"
  },
  "occurredAt": "2025-09-22T12:00:00Z",
  "attemptedAt": "2025-09-22T12:00:00Z"
}
```

--------------------------------

### Create Transfer

Source: https://due.readme.io/docs/stablecoin-to-fiat-transfers

Initialize a crypto-to-fiat transfer using a quote, sender wallet, and recipient.

```bash
curl -X POST https://api.due.network/v1/transfers \
-H "Authorization: Bearer your_api_key" \
-H "Due-Account-Id: your_account_id" \
-H "Content-Type: application/json" \
-d '{
  "quote": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "sender": "{wallet_id}",
  "recipient": "{recipient_id}",
  "memo": "Crypto payout - Invoice #12345"
}'
```

--------------------------------

### Get Available Channels - GET /channels

Source: https://due.readme.io/docs/transfer-flow

Discover supported payment rails and currencies with fees and processing speeds.

```http
GET /channels
```

--------------------------------

### Transfer event example

Source: https://due.readme.io/docs/list-of-events

Example webhook payload for a transfer.status_changed event, including the full transfer object with source, destination, and other details.

```json
{
  "id": "wh_evt__123",
  "type": "transfer.status_changed",
  "data": {
    "id": "tf_XYZ123456789",
    "ownerId": "acct_98765ABCDE",
    "status": "payment_processed",
    "source": {
      "amount": "150.00",
      "fee": "2.50",
      "currency": "USDC",
      "rail": "polygon"
    },
    "destination": {
      "amount": "147.50",
      "fee": "2.50",
      "currency": "USD",
      "rail": "ach",
      "id": "rcp_QWERTY98765",
      "label": "Test Recipient",
      "details": {
        "accountName": "Demo Account",
        "accountNumber": "123456789",
        "bankName": "Example Bank",
        "routingNumber": "110000000",
        "schema": "bank_us"
      }
    },
    "fxRate": 1,
    "createdAt": "2025-09-22T12:00:00Z",
    "expiresAt": "2025-09-22T12:05:00Z"
  },
    "occurredAt": "2025-09-22T12:00:00Z",
			"attemptedAt": "2025-09-22T12:00:00Z"
}
```

--------------------------------

### Webhook response example

Source: https://due.readme.io/docs/gbp-bank-virtual-account-endorsement

Example of a webhook response for the endorsement.status_changed event. Shows the endorsement object with ownerId, code, and status fields.

```json
{
  "endorsement": {
    "ownerId": "acct_DsQYd4DB1dOWIwYQ",
    "code": "gbp_bank_v1",
    "status": "awaiting_approval"
  }
}
```

--------------------------------

### GET /virtual_accounts/{key}

Source: https://due.readme.io/docs/virtual-accounts

Gets a virtual account by its key. This endpoint retrieves the details of a specific virtual account using its unique key.

```APIDOC
## GET /virtual_accounts/{key}

### Description
Gets a virtual account by key.

### Method
GET

### Endpoint
/virtual_accounts/{key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The unique key of the virtual account.

### Request Example
No request example provided in source.

### Response
#### Success Response (200)
No response schema provided in source.

#### Response Example
No response example provided in source.

```

--------------------------------

### Retrieve account feature flags

Source: https://due.readme.io/docs/feature-flags

Gets the current feature-flag preferences for an account using a GET request. The account ID is required in both the URL and the Due-Account-Id header.

```shell
curl -X GET "https://api.due.network/accounts/acct_abc123/feature_flags" \
  -H "Due-Account-Id: acct_abc123"
```
Tokens:
Raw