Integration Guides
Customer
Payout (off-ramp)
Payin (on-ramp)
Webhook
Widget
cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data \
--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_name": "John Doe",
"phone": "9911002211",
"full_address": "FULL_ADDRESS_OF_THE_CUSTOMER",
"dob": "DD-MM-YYYY",
"registered_date": "DD-MM-YYYY",
"tax_number": "ABCPG1234N",
"document_type": "<string>",
"document_front_image_url": "<string>",
"document_back_image_url": "<string>",
"document_details": {
"document_number": "123456123456",
"additional_data": {}
},
"selfie_url": "<string>",
"selfie_verification_status": true,
"additional_info": {}
}
'{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING",
"failure_reason": null
}
}KYC
Add KYC Data
Add KYC information for a customer
POST
/
kyc
/
add-kyc-data
cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data \
--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_name": "John Doe",
"phone": "9911002211",
"full_address": "FULL_ADDRESS_OF_THE_CUSTOMER",
"dob": "DD-MM-YYYY",
"registered_date": "DD-MM-YYYY",
"tax_number": "ABCPG1234N",
"document_type": "<string>",
"document_front_image_url": "<string>",
"document_back_image_url": "<string>",
"document_details": {
"document_number": "123456123456",
"additional_data": {}
},
"selfie_url": "<string>",
"selfie_verification_status": true,
"additional_info": {}
}
'{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING",
"failure_reason": null
}
}Currently, Payins (on-ramp) is only supported for Aadhaar verified customers.
Error Codes and Messages
| 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 exists | KYC already exists for the customer |
| 400 | KYC already in use | KYC is being used by another customer |
| 500 | Internal Server Error | Internal Server Error |
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
Example:
"4e6f1b20-a73c-11ec-b909-0242ac120002"
Example:
"John Doe"
Example:
"9911002211"
Example:
"FULL_ADDRESS_OF_THE_CUSTOMER"
Example:
"DD-MM-YYYY"
Example:
"DD-MM-YYYY"
Example:
"ABCPG1234N"
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
Show child attributes
Accepts JPG, JPEG and PNG links
Example:
true
Additional fields required based on /kyc/configuration/{customer_id} (e.g. ssn_number, visa)
⌘I