KYC Status Query

Introduction

This API is used to query user KYC status.

API Description

Request Method: POST

Request Path: /open/api/user/core/getKycStatusInfo

Parameter Explanation

Parameter NameRequiredTypeDescriptionLengthExample
emailYesstringEmail64test@email.com
kycTypeYesstringKYC type20See KYC type explanation
kycPlatformYesstringKYC platform24sumsub

Request Example

{ "email": "test@email.com", "kycPlatform": "onfido", "kycType": "1" }

Response Example

{ "code": "0", "msg": "Success", "model": { "userNo": "93f4f76233324991b7dcb0820ca34062", "email": "test@email.com", "kycLevel": 1, "kycType": "1", "kycStatus": 1, "kycFailJson": null, "takeKycLevel": null, "applicantId": "61766464-bc97-4f97-a9cc-7f13de4a359b", "riskStatus": 0, "userNum": "101016938278698200524", "firstName": "JUDITH", "gender": 2, "lastName": "HOHMANN", "country": "DEU", "idDocType": "2", "dob": "1985-05-08", "validUntil": "2029-07-29", "number": "CFHRLW6JF", "additionalNumber": null, "callbackUrl": null, "redirectUrl": null }, "traceId": "64f6c7e29bc5d609a5899e68321c1df6", "success": true, "error": false }

Exception Example (User not registered):

{ "code": "2003", "msg": "User not registered", "model": null, "traceId": "64e462f03cb28e341b6973070be1e22b", "success": false, "error": true }

Did this page help you?