USD Onboarding via API
Learn how to onboard individual and business customers to USD accounts via the Lorum API, including document upload requirements and UBO verification.
USD onboarding is asynchronous and requires document uploads. Individual customers follow a 3-step flow; business customers follow a 4-step flow and must have at least one USD-onboarded individual shareholder before starting.
Webhook: Enable the Onboarding category in the portal under Settings > App to receive status notifications.
Provide Currency-Specific Data (Both Customer Types)
New individual — include USD-specific fields in Add Individual:
POST /v1/customers/individuals
New business — include USD-specific fields in Add Business:
POST /v1/customers/businesses
Existing customer (either type) — update via Update Customer:
PATCH /v1/customers/{customer_id}
Individual Customer
Follow the steps below to onboard an individual customer to USD.
Upload & Link Required Documents
Upload each document via Upload Document :
POST /v1/documents
Link it to the customer via Link Document:
POST /v1/customers/{customer_id}/documents
See Individual Customer Onboarding Requirements.
Trigger Onboarding
Once all documents are uploaded and linked, initiate onboarding via Onboard Customer:
POST /v1/customers/{customer_id}/onboarding/usd.
Business Customer
Follow the steps below to onboard an business customer to USD.
Prerequisites: Identify and Onboard UBOs
Before starting, identify all individuals who collectively hold 51% or more of the business. Each must be fully USD-onboarded as an individual (steps 1–3 above) before being added as a shareholder.
Add USD-Onboarded Shareholder(s)
Add each UBO via Add Shareholder
POST /v1/customers/{customer_id}/shareholders.
_Each shareholder must be onboarded as an Individual Customer. See Individual Customer Onboarding here_
Upload and Link Required Documents
Upload each document via Upload Document :
POST /v1/documents
Link it to the customer via Link Document:
POST /v1/customers/{customer_id}/documents
💼 All business customers:
See Business Customer Onboarding Requirements.
Trigger Onboarding
Once all documents are uploaded and linked, initiate onboarding via Onboard Customer:
POST /v1/customers/{customer_id}/onboarding/usd.
Verification & Approval (Both Customer Types)
USD onboarding is reviewed asynchronously. Once approved, you will receive an onboarding.* webhook and the customer's onboarding status will update to approved.
Confirm the result via Get Customer Onboarding Status:
GET /v1/customers/{customer_id}/onboarding/usd.
Updated 4 days ago
What’s Next
Onboard onto the other currencies we have to offer: