AED bank virtual account endorsement

Request the AED bank virtual account endorsement when an account needs access to AED bank virtual account details.

Prerequisites

Complete onboarding for the account.
Complete the account’s standard KYC/KYB flow.
Store the Due account ID, such as acct_DqvgNSAuQv5OEK9v.
Use the account ID in the Due-Account-Id header when requesting the endorsement.

How AED bank virtual account endorsements work

Request the aed_bank_v1 endorsement for the account before creating AED bank virtual accounts that require this endorsement.

If the endorsement response creates a KYC/KYB submission, complete the requirements returned in the submission.requirements array. After the endorsement is approved, create the AED virtual account through the regular virtual account creation flow.

Request the endorsement

Call the endorsement endpoint with the aed_bank_v1 code.

POST /v1/kyc/endorsements/aed_bank_v1

curl --request POST \
  --url https://api.sandbox.due.network/v1/kyc/endorsements/aed_bank_v1 \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Due-Account-Id: acct_DqvgNSAuQv5OEK9v'

Replace:

Value	Description
`<API_KEY>`	Your Due API key.
`acct_DqvgNSAuQv5OEK9v`	The account ID that needs AED bank virtual accounts.
`aed_bank_v1`	The endorsement code for AED bank virtual accounts.

Requirements examples

If the endorsement response creates a KYC/KYB submission, complete the requirements returned in the submission.requirements array. The exact requirements depend on the account type.

Individual requirements example

[
  {
    "kind": "static",
    "info": [
      { "key": "nationality", "type": "iso3166_1_alpha2" }
    ],
    "documents": [
      {
        "category": "ID",
        "oneOf": [
          { "type": "PASSPORT" },
          {
            "type": "ID_CARD",
            "variants": ["FRONT_SIDE", "BACK_SIDE"],
            "issuingCountries": ["AE"]
          },
          {
            "type": "RESIDENCE_PERMIT",
            "variants": ["FRONT_SIDE", "BACK_SIDE"],
            "issuingCountries": ["AE"]
          }
        ]
      }
    ]
  }
]

Business requirements example

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

Wait for approval

After requesting the endorsement, listen for the endorsement.status_changed webhook event and confirm the aed_bank_v1 endorsement is approved before creating AED virtual accounts that require this endorsement.

The event data includes the endorsement owner, code, and status:

{
  "endorsement": {
    "ownerId": "acct_DorIPWFDPGpx0evs",
    "code": "aed_bank_v1",
    "status": "processing"
  }
}

Use endorsement.code to identify the AED endorsement and endorsement.status to track whether it is still processing or approved.

When you receive the webhook, you can also retrieve the endorsement status for the account:

GET /v1/kyc/endorsements/aed_bank_v1

If the endorsement creates a submission, complete the submission first. The endorsement can only be approved after the required information and documents have been provided and reviewed.

Create the AED virtual account

After the endorsement is approved, create the AED virtual account through the regular virtual account creation flow.

Use the account ID in the Due-Account-Id header when creating the virtual account.