AED Onboarding - API
Learn how to onboard individual and business customers to AED 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 - update 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 |
Trigger Onboarding
Once the required data is in place, initiate onboarding via Onboard Customer:
POST /v1/customers/{customer_id}/onboarding/aed
🛑 Error codes:
| Code | Cause | FIx |
|---|---|---|
missing_currency_data | No identification on the customer | Add identification via Update Customer |
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_expiryis required forfreezone, not forinternational.registration_date- the business registration/incorporation date. Optional forfreezone, but mandatory forinternational.
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? | registration_date required? |
|---|---|---|---|
freezone | Registered in a UAE free zone | ✅ | ❌ |
international | Registered outside the UAE | ❌ | ✅ |
Trigger Onboarding
Once the required data is in place, initiate onboarding via Onboard Customer:
POST /v1/customers/{customer_id}/onboarding/aed
🛑 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 |
Verification & Approval (Both Customer Types)
AED onboarding is reviewed asynchronously. Once approved, you will receive an onboarding.completed webhook and the customer's onboarding status will update to completed.
You can confirm the status via Get Customer Onboarding Status:
GET /v1/customers/{customer_id}/onboarding/aed
Updated 8 days ago