withdraw

Validate KYC Information

Changed on

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.

post/withdraw/kyc/validate

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/withdraw/kyc/validate
  • Auth
    API key in header x-coinflow-auth-user-id

Request body

firstNamestring required

First name of the user

lastNamestring required

Last name of the user

dobstring

Date of birth of the user

countrystring

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

matchThresholdinteger

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

Ok

invalidFieldsstring[] required
validboolean required

Changes

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter x-coinflow-auth-user-id

    • info

      the endpoint scheme security userId was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id validate-kyc removed and replaced with withdraw_ValidateKyc