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": {}
}
'

import requests

url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data"

payload = {
    "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": {}
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-TIMESTAMP": "<api-key>",
    "X-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-TIMESTAMP': '<api-key>',
    'X-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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: {}
  })
};

fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-SIGNATURE: <api-key>",
    "X-TIMESTAMP: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data"

	payload := strings.NewReader("{\n  \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n  \"full_name\": \"John Doe\",\n  \"phone\": \"9911002211\",\n  \"full_address\": \"FULL_ADDRESS_OF_THE_CUSTOMER\",\n  \"dob\": \"DD-MM-YYYY\",\n  \"registered_date\": \"DD-MM-YYYY\",\n  \"tax_number\": \"ABCPG1234N\",\n  \"document_type\": \"<string>\",\n  \"document_front_image_url\": \"<string>\",\n  \"document_back_image_url\": \"<string>\",\n  \"document_details\": {\n    \"document_number\": \"123456123456\",\n    \"additional_data\": {}\n  },\n  \"selfie_url\": \"<string>\",\n  \"selfie_verification_status\": true,\n  \"additional_info\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-TIMESTAMP", "<api-key>")
	req.Header.Add("X-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n  \"full_name\": \"John Doe\",\n  \"phone\": \"9911002211\",\n  \"full_address\": \"FULL_ADDRESS_OF_THE_CUSTOMER\",\n  \"dob\": \"DD-MM-YYYY\",\n  \"registered_date\": \"DD-MM-YYYY\",\n  \"tax_number\": \"ABCPG1234N\",\n  \"document_type\": \"<string>\",\n  \"document_front_image_url\": \"<string>\",\n  \"document_back_image_url\": \"<string>\",\n  \"document_details\": {\n    \"document_number\": \"123456123456\",\n    \"additional_data\": {}\n  },\n  \"selfie_url\": \"<string>\",\n  \"selfie_verification_status\": true,\n  \"additional_info\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n  \"full_name\": \"John Doe\",\n  \"phone\": \"9911002211\",\n  \"full_address\": \"FULL_ADDRESS_OF_THE_CUSTOMER\",\n  \"dob\": \"DD-MM-YYYY\",\n  \"registered_date\": \"DD-MM-YYYY\",\n  \"tax_number\": \"ABCPG1234N\",\n  \"document_type\": \"<string>\",\n  \"document_front_image_url\": \"<string>\",\n  \"document_back_image_url\": \"<string>\",\n  \"document_details\": {\n    \"document_number\": \"123456123456\",\n    \"additional_data\": {}\n  },\n  \"selfie_url\": \"<string>\",\n  \"selfie_verification_status\": true,\n  \"additional_info\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "PROCESSING",
    "failure_reason": null
  }
}

{
  "success": false,
  "message": "Internal Server Error",
  "err_code": "SYS_INTERNAL_ERROR",
  "errors": "Unexpected error occurred. Please try again later.",
  "data": null
}

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": {}
}
'

import requests

url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data"

payload = {
    "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": {}
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-TIMESTAMP": "<api-key>",
    "X-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-TIMESTAMP': '<api-key>',
    'X-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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: {}
  })
};

fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-SIGNATURE: <api-key>",
    "X-TIMESTAMP: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data"

	payload := strings.NewReader("{\n  \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n  \"full_name\": \"John Doe\",\n  \"phone\": \"9911002211\",\n  \"full_address\": \"FULL_ADDRESS_OF_THE_CUSTOMER\",\n  \"dob\": \"DD-MM-YYYY\",\n  \"registered_date\": \"DD-MM-YYYY\",\n  \"tax_number\": \"ABCPG1234N\",\n  \"document_type\": \"<string>\",\n  \"document_front_image_url\": \"<string>\",\n  \"document_back_image_url\": \"<string>\",\n  \"document_details\": {\n    \"document_number\": \"123456123456\",\n    \"additional_data\": {}\n  },\n  \"selfie_url\": \"<string>\",\n  \"selfie_verification_status\": true,\n  \"additional_info\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-TIMESTAMP", "<api-key>")
	req.Header.Add("X-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n  \"full_name\": \"John Doe\",\n  \"phone\": \"9911002211\",\n  \"full_address\": \"FULL_ADDRESS_OF_THE_CUSTOMER\",\n  \"dob\": \"DD-MM-YYYY\",\n  \"registered_date\": \"DD-MM-YYYY\",\n  \"tax_number\": \"ABCPG1234N\",\n  \"document_type\": \"<string>\",\n  \"document_front_image_url\": \"<string>\",\n  \"document_back_image_url\": \"<string>\",\n  \"document_details\": {\n    \"document_number\": \"123456123456\",\n    \"additional_data\": {}\n  },\n  \"selfie_url\": \"<string>\",\n  \"selfie_verification_status\": true,\n  \"additional_info\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/add-kyc-data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n  \"full_name\": \"John Doe\",\n  \"phone\": \"9911002211\",\n  \"full_address\": \"FULL_ADDRESS_OF_THE_CUSTOMER\",\n  \"dob\": \"DD-MM-YYYY\",\n  \"registered_date\": \"DD-MM-YYYY\",\n  \"tax_number\": \"ABCPG1234N\",\n  \"document_type\": \"<string>\",\n  \"document_front_image_url\": \"<string>\",\n  \"document_back_image_url\": \"<string>\",\n  \"document_details\": {\n    \"document_number\": \"123456123456\",\n    \"additional_data\": {}\n  },\n  \"selfie_url\": \"<string>\",\n  \"selfie_verification_status\": true,\n  \"additional_info\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "PROCESSING",
    "failure_reason": null
  }
}

{
  "success": false,
  "message": "Internal Server Error",
  "err_code": "SYS_INTERNAL_ERROR",
  "errors": "Unexpected error occurred. Please try again later.",
  "data": null
}

Add KYC Data

Open in Cursor

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

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

Show child attributes

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

Show child attributes

Fetch KYC Configuration

Update Tax Information

Getting Started

Onramp (Payin)

Offramp (Payout)

Remittance Payout

Widget

Reference

Error Codes and Messages

Authorizations

Body

Response

​Error Codes and Messages

Authorizations

Body

Response

Error Codes and Messages