Skip to navigation
TRANSAK WHITELABEL APIOn RampKYC RelianceUsing API

Document Details

View as Markdown

Submit ID proof document images and metadata as part of the KYC Reliance flow.

Call the Identity Details API first to initialize the KYC request, then use this endpoint to upload the user’s document images.

Supported idType values

idTypeAccepted values
PASSPORTpassport
DRIVING_LICENCEdriving_licence, DriversLicense
ID_CARDnational_identity_card, AadharCard
PROOF_OF_RESIDENCEbank_statement, resident_permit, utility_bill, payslip
VISAvisa
UNKNOWNAny other value not listed above

idNumber field is Optional only for PROOF_OF_RESIDENCE document type. For all other document types, idNumber is required.

Image formats

FieldRequiredAccepted formats
frontImageYesJPEG, PNG, WEBP
backImageOnly for two-sided documentsJPEG, PNG, WEBP

All images must be sent as base64-encoded data URIs.

Headers

x-user-ipstringRequired

End user's originating IP. More details here

x-api-keystringRequired
Partner API Key present in Transak Dashboard.
x-access-tokenstringOptional

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

Note: This is applicable only for Auth Reliance Flows

x-user-identifierstringOptional

our authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

authorizationstringOptional

Authorization token is the accessToken received from the API - api/v2/auth/verify

Note: This is not applicable for Auth Reliance Flows

Request

This endpoint expects an object.
documentProofobjectRequired

Response

Success — document step initialized

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error