curl --request PATCH \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/update-document-info \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"full_address": "FULL_ADDRESS_OF_THE_CUSTOMER",
"document_type": "<string>",
"document_front_image_url": "<string>",
"document_back_image_url": "<string>",
"document_details": {
"document_number": "123456123456",
"additional_data": {}
}
}
'{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "UNVERIFIED"
}
}Update customer’s document information
curl --request PATCH \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/update-document-info \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"full_address": "FULL_ADDRESS_OF_THE_CUSTOMER",
"document_type": "<string>",
"document_front_image_url": "<string>",
"document_back_image_url": "<string>",
"document_details": {
"document_number": "123456123456",
"additional_data": {}
}
}
'{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "UNVERIFIED"
}
}| API Status Code | Response | Reason |
|---|---|---|
| 400 | Customer not found or access denied | Customer not found |
| 400 | Customer not found or access denied | Customer does not belong to the organization |
| 400 | KYC already in use | KYC is being used by another customer |
| 500 | Internal Server Error | Internal Server Error |
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
"4e6f1b20-a73c-11ec-b909-0242ac120002"
"FULL_ADDRESS_OF_THE_CUSTOMER"
Document type as returned by /kyc/configuration/{customer_id} (e.g. PASSPORT, etc.)
Accepts JPG, JPEG, PNG and PDF links
Accepts JPG, JPEG, PNG and PDF links
Show child attributes