Check KYC Status¶
Tip
- All requests are
Postrequests, and the data format isjson
Brief Description¶
Use this API to query the user's KYC authentication status.
If authentication is approved, call the deposit API to obtain the VA payment information. If authentication is rejected, the merchant should submit a new KYC application and ask the user to complete authentication again.
Request URL¶
/v1/vexora/kycStatusQuery
Request Method¶
- Method: POST
- Content-Type: application/json
Header¶
| header | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | String | Merchant number assigned by Vexora. This value must be submitted in the request header. |
Request Body Parameters¶
| Name | Required | Type | Description |
|---|---|---|---|
| sign | Yes | String | Request signature. Sort all non-empty request body parameters except sign by parameter name in ascending alphabetical order, concatenate them as key1=value1key2=value2, append the app secret, and generate a lowercase MD5 hash. |
| timestamp | Yes | String | Request timestamp in milliseconds, for example 1715941383720. |
| userId | Yes | String | Merchant-side user identifier submitted in the KYC application. Each user should correspond to a unique ID. |
Request Example¶
{
"sign": "363b4674a1c1772e8a50295dc19d6727",
"timestamp": "1732988442913",
"userId": "jp_user_100008"
}
Response Result¶
| Parameter | Required | Type | Description |
|---|---|---|---|
| msg | Yes | String | Request message. A value such as success only indicates that the query request was accepted. |
| code | Yes | String | API request status code. 0000 means the query request was processed successfully by the API layer. |
| timestamp | Yes | String | Response timestamp in milliseconds. |
| success | Yes | Boolean | API request result. This field indicates whether the query request succeeded. |
| data | Yes | Object | KYC status response object. |
| data.authenticationStatus | Yes | String | KYC review status. 0: Pending certification, 1: Under review, 2: Approved, 3: Rejected. If the status is 2, the user can proceed with VA deposit. If the status is 3, submit a new KYC application after resolving the rejection reason. |
| data.failReason | No | String | Rejection reason. Returned when data.authenticationStatus is 3. |