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.

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

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
500
Internal Server Error