Skip to main content
GET
/
kyc
/
configuration
/
{customer_id}
cURL
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 CodeResponseReason
400Customer not found or access deniedCustomer not found
400Customer not found or access deniedCustomer does not belong to the organization
500Internal Server Error.Internal Server Error

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Response

Successful response

status
boolean
Example:

true

message
string
Example:

"Success"

data
object