cURL
curl --request PATCH \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status \
--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",
"kyc_status": "VERIFIED"
}
'import requests
url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status"
payload = {
"customer_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"kyc_status": "VERIFIED"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
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', kyc_status: 'VERIFIED'})
};
fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status', 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/mock-kyc-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => '4e6f1b20-a73c-11ec-b909-0242ac120002',
'kyc_status' => 'VERIFIED'
]),
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/mock-kyc-status"
payload := strings.NewReader("{\n \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"kyc_status\": \"VERIFIED\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status")
.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 \"kyc_status\": \"VERIFIED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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 \"kyc_status\": \"VERIFIED\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "VERIFIED"
}
}{
"success": false,
"message": "Internal Server Error",
"err_code": "SYS_INTERNAL_ERROR",
"errors": "Unexpected error occurred. Please try again later.",
"data": null
}KYC
Mock KYC Status [Sandbox Only]
Simulates KYC status transitions in the sandbox environment for testing your KYC flow.
PATCH
/
kyc
/
mock-kyc-status
cURL
curl --request PATCH \
--url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status \
--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",
"kyc_status": "VERIFIED"
}
'import requests
url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status"
payload = {
"customer_id": "4e6f1b20-a73c-11ec-b909-0242ac120002",
"kyc_status": "VERIFIED"
}
headers = {
"X-API-KEY": "<api-key>",
"X-TIMESTAMP": "<api-key>",
"X-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
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', kyc_status: 'VERIFIED'})
};
fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status', 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/mock-kyc-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => '4e6f1b20-a73c-11ec-b909-0242ac120002',
'kyc_status' => 'VERIFIED'
]),
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/mock-kyc-status"
payload := strings.NewReader("{\n \"customer_id\": \"4e6f1b20-a73c-11ec-b909-0242ac120002\",\n \"kyc_status\": \"VERIFIED\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status")
.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 \"kyc_status\": \"VERIFIED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/mock-kyc-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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 \"kyc_status\": \"VERIFIED\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "VERIFIED"
}
}{
"success": false,
"message": "Internal Server Error",
"err_code": "SYS_INTERNAL_ERROR",
"errors": "Unexpected error occurred. Please try again later.",
"data": null
}Mock KYC Status [Sandbox Only]
This endpoint is available only in the Sandbox environment and allows you to simulate KYC status changes for testing purposes.This endpoint follows specific state transition rules:
- If current status is UNVERIFIED: No status changes are allowed
- If current status is FAILED or VERIFIED: Can only be changed to UNVERIFIED
- If current status is PROCESSING: Can be changed to TAX_VERIFICATION_FAILED, DOCUMENT_VERIFICATION_FAILED, VERIFIED, or UNVERIFIED
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
⌘I

