Skip to navigation
TRANSAK WHITELABEL APIOn RampUser

Onboard User (Auth Reliance)

View as Markdown

The Onboard User API is used to create or fetch a user. This API is applicable only for Auth Reliance Flows.

Pass the authenticated user’s identifier in x-user-identifier and the partner access token in x-access-token.

ScenarioBehavior
New userCreates the user and returns the KYC status.
Existing userReturns the existing user details and KYC status.

Headers

x-user-ipstringRequired

End user's originating IP. More details here

x-api-keystringRequired
Partner API Key present in Transak Dashboard.
x-user-identifierstringRequired

Your authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

x-access-tokenstringRequired

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

Note: This is applicable only for Auth Reliance Flows

Response

200 - Success

dataobject

Errors

401
Unauthorized Error
500
Internal Server Error