AED Onboarding via API
Learn how to onboard individual and business customers to AED accounts via the Lorum API.
AED onboarding is synchronous and completes immediately — no webhook required.
Individual Customer
Follow the steps below to onboard an individual customer to AED.
Provide Identification Data
The customer's identification document must be on file before onboarding can be triggered.
New customer — include the identification field in Add Individual:
POST /v1/customers/individuals
Existing customer — patch via Update Customer:
PATCH /v1/customers/{customer_id}
✅ Accepted identification types:
| Type | Description | Required Attributes |
|---|---|---|
passport | Any valid passport | number, expiry_date, country_of_issuance |
national_id | Emirates ID only - country_of_issuance must be AE | number, expiry_date, country_of_issuance |
national_idis only supported for UAE Emirates ID. Any othercountry_of_issuancereturns a400error.
🛑 Error codes:
| Code | Cause | FIx |
|---|---|---|
missing_currency_data | No identification on the customer | Add identification via Update Customer |
Trigger Onboarding
Once the required data is in place, initiate onboarding via Onboard Customer:
POST /v1/customers/{customer_id}/onboarding/aed
Confirm the result via Get Customer Onboarding Status:
GET /v1/customers/{customer_id}/onboarding/aed
Business Customer
Follow the steps below to onboard a business customer to AED.
Provide Business Data
Two fields are required before triggering onboarding:
- currency_extra — must include an aed entry with license_issuer. trade_license_expiry is required for mainland and freezone, not for international.
- registration_date — optional in general, but mandatory for AED onboarding.
New customer — include both fields in Add Business:
POST /v1/customers/businesses
Existing customer — update via Update Customer:
PATCH /v1/customers/{customer_id}
✅ Accepted license_issuer values:
license_issuer values:| Value | Description | trade_license_expiry required? |
|---|---|---|
mainland | Registered with the UAE mainland authority | ✅ |
freezone | Registered in a UAE free zone | ✅ |
international | Registered outside the UAE | ❌ |
🛑 Error codes:
| Code | Cause | Fix |
|---|---|---|
missing_currency_data | No aed block in currency_extra | Add AED currency_extra via Update Customer and retry |
business_registration_date_missing | registration_date missing | Add registration_date via Update Customer and retry |
Trigger Onboarding
Once the required data is in place, initiate onboarding via Onboard Customer:
POST /v1/customers/{customer_id}/onboarding/aed
Confirm the result via Get Customer Onboarding Status:
GET /v1/customers/{customer_id}/onboarding/aed
Updated 4 days ago
What’s Next
Onboard onto the other currencies we have to offer: