Skip to navigation
TRANSAK WHITELABEL APIOn RampKYC RelianceUsing API

Biometrics Details

View as Markdown

Submit the user’s biometric media for the KYC Reliance biometric step. At least one of selfie or liveness must be provided — both are accepted but neither is individually required.

Complete the Identity Details and Document Details steps before calling this endpoint.

FieldRequiredAccepted formatsMax size
selfieAt least one of selfie or livenessJPEG, PNG, WEBPApproximately 5 MB after decoding
livenessAt least one of selfie or livenessMP4Approximately 20 MB after decoding

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.
selfiestringOptional

Selfie image as a base64-encoded data URI.
Supported formats: JPEG, PNG, WEBP.
Maximum size approximately 5 MB after decoding.

livenessstringOptional

Liveness video as a base64-encoded data URI.
Supported format: MP4 only.
Maximum size approximately 20 MB after decoding.

Response

Success — biometrics processed

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error