Skip to navigation

Get FCA Requirements

View as Markdown

The Get FCA Requirements is an authenticated API call that returns the FCA compliance requirements for a UK user based on their current FCA status. Use the status query parameter to fetch the relevant form data for categorization, investor agreement, risk assessment, cooling period, or blocked retry.

Authentication: use either Transak Auth, which sends the user’s authorization token, or Partner Auth (Auth Reliance), which sends x-access-token and x-user-identifier. Do not send both. See the headers below.

Headers

x-user-ipstringRequired

End user’s originating IP. More details here

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

Transak Auth. The user’s accessToken from Transak’s OTP login, returned by the Verify User OTP API (/api/v2/auth/verify). Send the token on its own, with no Bearer prefix. It is valid for 30 days. Call the Refresh User Access Token API before it expires. Do not send x-access-token or x-user-identifier with it.

x-access-tokenstringOptional

Partner Auth (Auth Reliance). Your Partner Access Token, valid for 7 days. Send it with x-user-identifier, and do not send authorization. See Auth Reliance Flows and how to create a Partner Access Token.

x-user-identifierstringOptional

Partner Auth (Auth Reliance). The email address of the user you authenticated. Send it with x-access-token.

Query parameters

statusenumRequired

The current FCA status of the user. Call Get FCA Status first to determine which step the user is on, then pass that value here to fetch the corresponding requirements.

StatusWhen to use
CATEGORIZATION_PENDINGReturns the investor categorization questionnaire
AGREEMENT_PENDINGReturns the investor agreement content to display and accept
RISK_ASSESSMENT_PENDINGReturns the risk assessment questionnaire
COOLING_PERIODReturns the cooling-off period expiry timestamp
BLOCKED_RETRYReturns retry timing details after failed attempts

Response

200 - Success

datamap from strings to any

Errors

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