cURL
curl --request PATCH \
--url https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"client_reference_id": "beneficiary-001",
"alpha_3_country_code": "IND",
"document_type": "ONLY_PAN",
"document_front_image_url": "https://example.com/front.jpg",
"document_back_image_url": "https://example.com/back.jpg",
"full_address": "12 MG Road, Bengaluru",
"tax_number": "ABCDE1234F"
}
'import requests
url = "https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details"
payload = {
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"client_reference_id": "beneficiary-001",
"alpha_3_country_code": "IND",
"document_type": "ONLY_PAN",
"document_front_image_url": "https://example.com/front.jpg",
"document_back_image_url": "https://example.com/back.jpg",
"full_address": "12 MG Road, Bengaluru",
"tax_number": "ABCDE1234F"
}
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: '84737c7d-7b62-4204-80d6-80f6ecb3ceb4',
client_reference_id: 'beneficiary-001',
alpha_3_country_code: 'IND',
document_type: 'ONLY_PAN',
document_front_image_url: 'https://example.com/front.jpg',
document_back_image_url: 'https://example.com/back.jpg',
full_address: '12 MG Road, Bengaluru',
tax_number: 'ABCDE1234F'
})
};
fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details', 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.zapyd.com/cms/api/v1/kyc/payout/update-additional-details",
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' => '84737c7d-7b62-4204-80d6-80f6ecb3ceb4',
'client_reference_id' => 'beneficiary-001',
'alpha_3_country_code' => 'IND',
'document_type' => 'ONLY_PAN',
'document_front_image_url' => 'https://example.com/front.jpg',
'document_back_image_url' => 'https://example.com/back.jpg',
'full_address' => '12 MG Road, Bengaluru',
'tax_number' => 'ABCDE1234F'
]),
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.zapyd.com/cms/api/v1/kyc/payout/update-additional-details"
payload := strings.NewReader("{\n \"customer_id\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"client_reference_id\": \"beneficiary-001\",\n \"alpha_3_country_code\": \"IND\",\n \"document_type\": \"ONLY_PAN\",\n \"document_front_image_url\": \"https://example.com/front.jpg\",\n \"document_back_image_url\": \"https://example.com/back.jpg\",\n \"full_address\": \"12 MG Road, Bengaluru\",\n \"tax_number\": \"ABCDE1234F\"\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.zapyd.com/cms/api/v1/kyc/payout/update-additional-details")
.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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"client_reference_id\": \"beneficiary-001\",\n \"alpha_3_country_code\": \"IND\",\n \"document_type\": \"ONLY_PAN\",\n \"document_front_image_url\": \"https://example.com/front.jpg\",\n \"document_back_image_url\": \"https://example.com/back.jpg\",\n \"full_address\": \"12 MG Road, Bengaluru\",\n \"tax_number\": \"ABCDE1234F\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details")
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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"client_reference_id\": \"beneficiary-001\",\n \"alpha_3_country_code\": \"IND\",\n \"document_type\": \"ONLY_PAN\",\n \"document_front_image_url\": \"https://example.com/front.jpg\",\n \"document_back_image_url\": \"https://example.com/back.jpg\",\n \"full_address\": \"12 MG Road, Bengaluru\",\n \"tax_number\": \"ABCDE1234F\"\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
}
}{
"status": false,
"message": "Bad Request",
"data": null,
"errors": {
"tax_number": [
"This field is required for India (IND)."
]
},
"err_code": "UNKNOWN_ERROR"
}{
"status": false,
"message": "Internal Server Error",
"data": null,
"errors": {},
"err_code": "SYS_INTERNAL_ERROR"
}Payout-only onboarding
Update Payout KYC Details
Updates documents, address or tax number on a payout-only KYC profile.
PATCH
/
kyc
/
payout
/
update-additional-details
cURL
curl --request PATCH \
--url https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"client_reference_id": "beneficiary-001",
"alpha_3_country_code": "IND",
"document_type": "ONLY_PAN",
"document_front_image_url": "https://example.com/front.jpg",
"document_back_image_url": "https://example.com/back.jpg",
"full_address": "12 MG Road, Bengaluru",
"tax_number": "ABCDE1234F"
}
'import requests
url = "https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details"
payload = {
"customer_id": "84737c7d-7b62-4204-80d6-80f6ecb3ceb4",
"client_reference_id": "beneficiary-001",
"alpha_3_country_code": "IND",
"document_type": "ONLY_PAN",
"document_front_image_url": "https://example.com/front.jpg",
"document_back_image_url": "https://example.com/back.jpg",
"full_address": "12 MG Road, Bengaluru",
"tax_number": "ABCDE1234F"
}
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: '84737c7d-7b62-4204-80d6-80f6ecb3ceb4',
client_reference_id: 'beneficiary-001',
alpha_3_country_code: 'IND',
document_type: 'ONLY_PAN',
document_front_image_url: 'https://example.com/front.jpg',
document_back_image_url: 'https://example.com/back.jpg',
full_address: '12 MG Road, Bengaluru',
tax_number: 'ABCDE1234F'
})
};
fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details', 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.zapyd.com/cms/api/v1/kyc/payout/update-additional-details",
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' => '84737c7d-7b62-4204-80d6-80f6ecb3ceb4',
'client_reference_id' => 'beneficiary-001',
'alpha_3_country_code' => 'IND',
'document_type' => 'ONLY_PAN',
'document_front_image_url' => 'https://example.com/front.jpg',
'document_back_image_url' => 'https://example.com/back.jpg',
'full_address' => '12 MG Road, Bengaluru',
'tax_number' => 'ABCDE1234F'
]),
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.zapyd.com/cms/api/v1/kyc/payout/update-additional-details"
payload := strings.NewReader("{\n \"customer_id\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"client_reference_id\": \"beneficiary-001\",\n \"alpha_3_country_code\": \"IND\",\n \"document_type\": \"ONLY_PAN\",\n \"document_front_image_url\": \"https://example.com/front.jpg\",\n \"document_back_image_url\": \"https://example.com/back.jpg\",\n \"full_address\": \"12 MG Road, Bengaluru\",\n \"tax_number\": \"ABCDE1234F\"\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.zapyd.com/cms/api/v1/kyc/payout/update-additional-details")
.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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"client_reference_id\": \"beneficiary-001\",\n \"alpha_3_country_code\": \"IND\",\n \"document_type\": \"ONLY_PAN\",\n \"document_front_image_url\": \"https://example.com/front.jpg\",\n \"document_back_image_url\": \"https://example.com/back.jpg\",\n \"full_address\": \"12 MG Road, Bengaluru\",\n \"tax_number\": \"ABCDE1234F\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/payout/update-additional-details")
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\": \"84737c7d-7b62-4204-80d6-80f6ecb3ceb4\",\n \"client_reference_id\": \"beneficiary-001\",\n \"alpha_3_country_code\": \"IND\",\n \"document_type\": \"ONLY_PAN\",\n \"document_front_image_url\": \"https://example.com/front.jpg\",\n \"document_back_image_url\": \"https://example.com/back.jpg\",\n \"full_address\": \"12 MG Road, Bengaluru\",\n \"tax_number\": \"ABCDE1234F\"\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
}
}{
"status": false,
"message": "Bad Request",
"data": null,
"errors": {
"tax_number": [
"This field is required for India (IND)."
]
},
"err_code": "UNKNOWN_ERROR"
}{
"status": false,
"message": "Internal Server Error",
"data": null,
"errors": {},
"err_code": "SYS_INTERNAL_ERROR"
}Update Payout KYC Details
Part of the payout-only onboarding flow. See the payout-only onboarding guide for the order of calls and the fields each country requires.
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
Customer ID
Example:
"84737c7d-7b62-4204-80d6-80f6ecb3ceb4"
Alternative to customer_id
Example:
"beneficiary-001"
Must match the customer's country if sent
Example:
"IND"
Identity document type
Available options:
ONLY_PAN, GOVT_ID, PASSPORT Example:
"ONLY_PAN"
Optional. Front image URL of the document.
Example:
"https://example.com/front.jpg"
Optional. Back image URL of the document.
Example:
"https://example.com/back.jpg"
Full address
Example:
"12 MG Road, Bengaluru"
Tax number. Required for IND.
Example:
"ABCDE1234F"
⌘I