KYC

KYC Account Status

Changed on

Retrieves the KYC verification status of an individual user for each role they hold - sender (funding an order) and recipient (being paid) - so a user cleared in one role can be told apart from one that is not. A role's kyc is null when the user holds no KYC record for it. Use GET /v3/kyb/account-status for business users.

get/v3/kyc/account-status

Request

Query parameters

userIdstring required

The individual user to look up, as returned by POST /v3/users/individual, POST /v3/senders/individual or POST /v3/recipients/individual. Must start with UX-.

accountType'sender' | 'recipient' | 'both'

Which role to return. Pass sender or recipient for only that block, or both (the default) for both.

Headers

MIDstring required

Merchant or sub-merchant MID

Response

OK

statusstring required

success when the status lookup succeeded.

traceIdstring

Identifier of the request, useful when reporting an issue to TransFi support.

Changes