curl --request GET \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/configuration/{customer_id} \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>'{
"status": true,
"message": "Success",
"data": {
"supported_document_types": [
"AADHAAR",
"PASSPORT",
"VOTER_ID",
"DRIVING_LICENSE"
],
"additional_info_required": {
"options": [
"income_range",
"profession"
],
"rules": {
"type": "allOf",
"min_required": 2
},
"income_range": {
"type": "string",
"required": true
},
"profession": {
"type": "string",
"required": true
}
}
}
}Returns basic configuration for KYC - supported document types, additional information fields required
curl --request GET \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/configuration/{customer_id} \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>'{
"status": true,
"message": "Success",
"data": {
"supported_document_types": [
"AADHAAR",
"PASSPORT",
"VOTER_ID",
"DRIVING_LICENSE"
],
"additional_info_required": {
"options": [
"income_range",
"profession"
],
"rules": {
"type": "allOf",
"min_required": 2
},
"income_range": {
"type": "string",
"required": true
},
"profession": {
"type": "string",
"required": true
}
}
}
}| 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 |
| 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