Skip to main content

Webhook KYC Status

Path

  • URL: Customer defined path
  • Method: POST
  • Description: This API is used to receive notifications about the status of the KYC process.

Request

Request Baokim Table

ParamsData Type + LengthRequiredDescription
request_idstring(50)YesA unique ID for each request from the customer to Baokim
request_timestring(19)YesTime of the request submission.Format: YYYY-MM-DD HH:MM:SS
merchant_codestring(20)YesMerchant code provided by Baokim
sub_merchant_codestring(20)YesSub-merchant code. If seller belongs to merchant directly, fill in merchant_code
seller_idstring(50)YesSeller ID in merchant system
statusstring(1)Yes2: KYC passed
3: KYC failed
4: additional documents required
reasonstring(255)NoThe reason will be available when status = 3 or 4

Request Example

{
"request_id": "BK009373788182HUYLLAPU",
"request_time": "2024-11-01 14:00:00",
"merchant_code": "MERCHANT001",
"sub_merchant_code": "MERCHANT001",
"seller_id": "SELLER123456",
"status": "2",
"reason": ""
}

Response

Response Table

ParamsData type + lengthRequiredDescription
response_codeint(4)YesError code from Baokim as per Error Codes Table
response_messagestring(100)YesDescription of the error code from Baokim as per Error Codes Table

Response Example

{
"response_code": 200,
"response_message": "Success"
}

Error Code

Response CodeResponse Message
200Success
11Failed
101System Error