latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

Managed Custody KYC

Create the account and onboarding session

Mints or reuses the user's URID, provisions the UR-managed wallet, and opens an onboarding session. This is the first step of both Managed Custody KYC paths: the SDK path starts in state ConfirmYourCountryOfResidence and the shared-token path starts in state PartnerDataIngestion. Repeated calls with the same X-External-User-Id while a session is active return the existing session with idempotentReplay set to true.

post/api/fma/v1/create-account

Headers

X-External-User-Idstring required

Your partner-side user id. This endpoint identifies the user by X-External-User-Id only; there is no X-Ur-Id yet.

X-Api-Signaturestring required

Partner Auth EIP-191 signature over the canonical message plus the deadline.

X-Api-Deadlinestring required

Unix timestamp in seconds after which the signature is no longer valid.

X-Api-PublicKeystring required

Partner public key used to verify the signature.

Request body

emailstring required

The user's email address. Must be unique across UR partners; reusing the same email under a different partner returns L1_CONFLICT (code 30015).

nationalitystring

ISO 3166-1 alpha-3 country code. Sending it lets UR fail country gates before the URID is minted.

residencystring

ISO 3166-1 alpha-3 country code of residence.

dobstring

Date of birth in YYYY-MM-DD format.

documentExpirystring

Passport or ID expiry date in YYYY-MM-DD format.

Response

Business result envelope. code 0 means success; business rejections return HTTP 200 with a non-zero code.

codeinteger

Business result code. 0 means success; business rejections return HTTP 200 with a non-zero code.

messagestring

Human-readable diagnostic for non-zero codes.