KYC Application¶
Tip
- All requests use
POST - Content type is
application/json
Brief Description¶
Use this API to submit a merchant-side user ID and obtain the URL where the user completes KYC verification.
To increase a user's transaction limit, first submit the user information through this API and direct the user to the returned authentication URL. After KYC is approved, the system increases the user's limit automatically. If KYC is rejected, submit a new KYC application and ask the user to upload the verification documents again.
Request URL¶
/v1/vexora/kycApplyFor
Request Method¶
- Method: POST
- Content-Type: application/json
Header¶
| Header | Required | Type | Description |
|---|---|---|---|
| merchantNo | Yes | String | Merchant number assigned by Vexora. |
Request Body Parameters¶
| Parameter | 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. This value must uniquely identify the user within the merchant system. |
| mobile | Yes | String | User's actual mobile phone number. For Cambodia mobile numbers, use 8 to 9 digits without the country code. |
| callBackUrl | Yes | String | Callback URL used to receive the final KYC result. |
Request Example¶
{
"sign": "363b4674a1c1772e8a50295dc19d6727",
"timestamp": "1732988442913",
"userId": "kevin",
"mobile": "112345678",
"callBackUrl": "https://merchant.example.com/webhooks/vexora/kyc"
}
Response Parameters¶
| Parameter | Required | Type | Description |
|---|---|---|---|
| msg | Yes | String | Request message. A value such as success only indicates that the API request was accepted, not the final KYC result. |
| code | Yes | String | API request status code. 0000 means the request was processed successfully by the API layer. Refer to the Response Code section for other values. |
| timestamp | Yes | Integer | Response timestamp in milliseconds. |
| success | Yes | Boolean | Whether the API request was processed successfully. This field does not represent the final KYC result. |
| data | Yes | Object | KYC application response object. |
| data.mobile | Yes | String | User's actual mobile phone number. |
| data.authenticationStatus | Yes | String | KYC status. 0: Pending authentication; 1: Under review; 2: Approved; 3: Rejected. |
| data.message | Yes | String | Status description returned by the platform. |
| data.authenticationUrl | Yes | String | URL where the user completes KYC for the current application. If KYC is rejected, submit a new KYC application to obtain a new authentication URL. |
Successful Response Example¶
{
"msg": "success",
"code": "0000",
"timestamp": 1728609277476,
"success": true,
"data": {
"mobile": "112345678",
"authenticationStatus": "0",
"message": "apply for kyc successful, Please authentication",
"authenticationUrl": "https://sandbox-casher-al.vexora.com/kycAuthentication/79x7p10nh4xd121m"
}
}