Skip to navigation
TRANSAK WHITELABEL APIOn RampKYC

Update Purpose Of Usage

View as Markdown

The Purpose Of Usage is an authenticated API call that is a mandatory step in the KYC process for both Simple KYC and Standard KYC.

As part of regulatory compliance, users must declare the purpose of their cryptocurrency transactions. This API allows you to submit the user’s intended use case by passing an array of supported purposes.

How It Works

  • The purposeList parameter must be an array of one or more supported options.

  • You can submit one or multiple purposes at a time.

  • This is a required step before proceeding with order placement and further transactions.

Supported Purposes:

  • “Buying/selling crypto for investments”

  • “Buying NFTs”

  • “Buying crypto to use a web3 protocol”

Headers

x-user-ipstringRequired

End user's originating IP. More details here

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

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

Note: This is not applicable for Auth Reliance Flows

x-user-identifierstringOptional

Your authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

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

Request

This endpoint expects an object.
purposeListlist of stringsRequired

Response

200 - Success

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error