Onboarding

Upload associate identity documents

Changed on

Uploads identity and address verification documents for a specific associate as multipart/form-data.

Use associateId from the onboarding status response (GET /onboarding/v1/applications/{onboardingId}/status).

Jurisdiction guidance:

  • EU: selfie/liveness and proof of address are generally mandatory.
  • US: selfie may be optional while tax and control-person requirements can apply.

If a submitted document is rejected, resubmit a corrected file through the same endpoint; the previous rejected document is replaced.

post/onboarding/v1/associates/{associateId}/identification-documents

Request

Path parameters

associateIdstring uuid required
Example:07b099fa-e1ee-4ad4-9cc4-6f2513a5a240

Associate ID returned by onboarding status response.

Request body multipart/form-data

metadatastring required

JSON array (string) of associate identification document metadata entries with type, name, and countryCode. You need to submit any document of the following as an ID: PASSPORT, ID_CARD, DRIVERS, RESIDENCE_PERMIT.

Supported associate document types:

TypeDescriptionWhen required
PASSPORTPassport.Identity document required
ID_CARDNational identity card.Alternative to passport
DRIVERSDriver's licence.Alternative to passport
RESIDENCE_PERMITResidence permit.Alternative to passport
UTILITY_BILLProof of residential address. Must be dated within the last three months.EU: Mandatory. US: Conditional
SELFIEBiometric selfie / liveness capture.EU: Mandatory. US: Optional
filesstring[] required

One file per metadata entry, in matching order.

Example request

{
  "metadata": "[{\"type\":\"PASSPORT\",\"name\":\"passport.png\",\"countryCode\":\"DE\"},{\"type\":\"UTILITY_BILL\",\"name\":\"poa.png\",\"countryCode\":\"DE\"},{\"type\":\"SELFIE\",\"name\":\"selfie.jpeg\",\"countryCode\":\"DE\"}]"
}

Response

Associate documents accepted for processing

associateIdstring uuid required
acceptedDocumentCountinteger required
messagestring required

Changes