Skip to main content
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
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.dollarpe.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Currently, Payins (on-ramp) is only supported for Aadhaar verified customers.

​
Error Codes and Messages

API Status CodeResponseReason
400Customer not found or access deniedCustomer not found
400Customer not found or access deniedCustomer does not belong to the organization
400KYC already existsKYC already exists for the customer
400KYC already in useKYC is being used by another customer
500Internal Server ErrorInternal 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

Body

application/json
​
customer_id
string<uuid>
required
Example:

"4e6f1b20-a73c-11ec-b909-0242ac120002"

​
full_name
string
required
Example:

"John Doe"

​
phone
string
required
Example:

"9911002211"

​
full_address
string
required
Example:

"FULL_ADDRESS_OF_THE_CUSTOMER"

​
dob
string<date>
required
Example:

"DD-MM-YYYY"

​
registered_date
string<date>
required
Example:

"DD-MM-YYYY"

​
tax_number
string
required
Example:

"ABCPG1234N"

​
document_type
string
required

Document type as returned by /kyc/configuration/{customer_id} (e.g. PASSPORT, etc.)

​
document_front_image_url
string<uri>
required

Accepts JPG, JPEG, PNG and PDF links

​
document_back_image_url
string<uri>
required

Accepts JPG, JPEG, PNG and PDF links

​
document_details
object
required
​
selfie_url
string<uri>
required

Accepts JPG, JPEG and PNG links

​
selfie_verification_status
boolean
required
Example:

true

​
additional_info
object
required

Additional fields required based on /kyc/configuration/{customer_id} (e.g. ssn_number, visa)

Response

KYC data added successfully

​
status
boolean
Example:

true

​
message
string
Example:

"Success"

​
data
object