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/reference/authentication

Authorizationstring

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

Request

This endpoint expects an object.

firstNamestringRequired>=1 character

First name of the user

lastNamestringRequired>=1 character

Last name of the user

dobstringRequiredformat: "^\d\d\d\d-\d\d-\d\d$"

Date of birth of the user

countrystringRequiredformat: "^[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

1	import requests
2
3	url = "https://api-sandbox.coinflow.cash/api/withdraw/kyc/validate"
4
5	payload = {
6	"firstName": "string",
7	"lastName": "string",
8	"dob": "string",
9	"country": "string"
10	}
11	headers = {
12	"x-coinflow-auth-user-id": "<apiKey>",
13	"Content-Type": "application/json"
14	}
15
16	response = requests.post(url, json=payload, headers=headers)
17
18	print(response.json())

1	{
2	"invalidFields": [
3	"string"
4	],
5	"valid": true
6	}