Skip to main content

Payment Payer Verification

This API is used for Merchant/Partner to verify payer's kyc information before create order.

*This API is only available for whitelisted merchants. If you need any help, you can contact us: merchant@binance.com

EndPoint#

POST /binancepay/openapi/order/payer/verification

Request Parameters#

AttributesTypeRequiredLimitationDescription
binanceIdstringYpayer's binance id
payerTypestringYEnum valuepayer type

INDIVIDUAL: individual payer.
CORPORATE: corporate payer.
informationListNelements structure in list: Infoinformation to be verified

Info#

AttributesTypeRequiredLimitationDescription
categorystringYEnum valueFor Individual:
FIRST_NAME
LAST_NAME
DATE_OF_BIRTH
NATIONALITY (2-letter country code)-optional
DOCUMENT_TYPE-optional
DOCUMENT_NUMBER-optional

For corporate:
COMPANY_NAME
REGISTRATION_NUMBER
REGISTRATION_COUNTRY (2-letter country code)
valuestringYmax length 1024value of information
For DOCUMENT_TYPE, available values are: ID_CARD/PASSPORT/DRIVING_LICENSE/VISA/CPF/OTHER/BVN_NUMBER/NIN_NUMBER/PAN/BVN_NIN_NUMBER/SMILEID_NATIONAL_ID/ABN/ACN/UA_DIA
For DATE_OF_BIRTH format: YYYY-MM-DD
For NATIONALITY and REGISTRATION_COUNTRY value is based on 2-letter country code

Sample Request Body#

{    "binanceId":"354205155",    "payerType":"INDIVIDUAL",    "information":[      {        "category":"FIRST_NAME",        "value":"binance",      },      {        "category":"LAST_NAME",        "value":"pay",      },      {        "category":"DATE_OF_BIRTH",        "value":"1980-01-01",      }    ]}

Response Parameters#

AttributesTypeRequiredLimitationDescription
statusstringY"SUCCESS" or "FAIL"status of the API request
codestringY-request result code, refer to
dataBooleanN-true means matched, false means not matched
errorMessagestringNmaximum length 256

Sample Response#

verify success#

{    "status": "SUCCESS",    "code": "000000",    "data": true}

account of userId not existed#

{    "status": "FAIL",    "code": "400601",    "errorMessage": "account not found"}

kyc is not completed in binance side#

{    "status": "FAIL",    "code": "400722",    "errorMessage": "kyc not completed"}

kyc info mismatch, for example FIRST_NAME#

{    "status": "FAIL",    "code": "400102",    "errorMessage": "Parameter information.FIRST_NAME not valid, the value is out of range."}

too many failed request#

{    "status": "FAIL",    "code": "406108",    "errorMessage": "Fail rate is high, please try again later"}

Result Code#

NameCodeReasonSolution
UNKNOWN_ERROR400000An unknown error occurred while processing the request.Try again later
INVALID_REQUEST400001Parameter format is wrong or parameter transferring doesn't follow the rules.Please check whether the parameters are correct.
INVALID_SIGNATURE400002Incorrect signature resultCheck whether the signature parameter and method comply with signature algorithm requirements.
INVALID_TIMESTAMP400003Timestamp for this request is outside of the time window.Sync server clock
INVALID_API_KEY_OR_IP400004API identity key not found or invalid.Check API identity key
BAD_API_KEY_FMT400005API identity key format invalid.Check API identity key.
BAD_HTTP_METHOD400006Request method not supported.Check Request method.
MEDIA_TYPE_NOT_SUPPORTED400007Media type not supported.Check Request Media type.
INVALID_REQUEST_BODY400008Request body is not a valid json object.Check Request body
MANDATORY_PARAM_EMPTY_OR_MALFORMED400100A parameter was missing/empty/null, or malformed.
INVALID_PARAM_WRONG_LENGTH400101A parameter was not valid, was empty/null, or too long/short, or wrong format.
INVALID_PARAM_WRONG_VALUE400102A parameter was not valid, the value is out of range.
INVALID_PARAM_ILLEGAL_CHAR400103A parameter was not valid, contains illegal characters
MERCHANT_TRANSFER_MERCHANT_TYPE_INVALID406107Merchant type not valid not support individual merchant
MERCHANT_TRANSFER_MERCHANT_TOO_FREQUENT406108Fail rate is high, please try again later