Validate KYC Information

This endpoint checks if the user's provided information matches the information used during their Know-Your-Customer (KYC) verification. It returns an object with a `valid` property that is `true` if the information matches and `false` otherwise. A 404 error is returned if the KYC information for the user cannot be found. This does not indicate a validation failure. Check the response body to determine if the KYC information is valid.

This endpoint checks if the user’s provided information matches the information used during their Know-Your-Customer (KYC) verification. It returns an object with a valid property that is true if the information matches and false otherwise. A 404 error is returned if the KYC information for the user cannot be found. This does not indicate a validation failure. Check the response body to determine if the KYC information is valid.

Authentication

x-coinflow-auth-user-idstring

The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.

firstNamestringRequired>=1 character

First name of the user

lastNamestringRequired>=1 character

Last name of the user

dobstringOptionalformat: "^\d\d\d\d-\d\d-\d\d$"

Date of birth of the user

countrystringOptionalformat: "^[A-Z,a-z]{2}$"=2 characters

Country of the user (ISO 3166-1 alpha-2)

matchThresholdintegerOptional

Matching Threshold The name comparison does not match exact strings, but instead is a fuzzy match so that nicknames or small misspellings don't lead to false positives. Therefore, you are able to pass a threshold, 100 being most strict and 0 being least strict. If not passed the system will default to 90.

Response

invalidFieldslist of strings

validboolean

This endpoint expects an object.

First name of the user

Last name of the user

Date of birth of the user

Country of the user (ISO 3166-1 alpha-2)

$	curl -X POST https://api-sandbox.coinflow.cash/api/withdraw/kyc/validate \
>	-H "x-coinflow-auth-user-id: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"firstName": "Emily",
>	"lastName": "Johnson"
>	}'

$	curl -X POST https://api-sandbox.coinflow.cash/api/withdraw/kyc/validate \
>	-H "x-coinflow-auth-user-id: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"firstName": "Emily",
>	"lastName": "Johnson"
>	}'