Skip to main content
PATCH
cURL

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

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>

Customer ID

Example:

"84737c7d-7b62-4204-80d6-80f6ecb3ceb4"

client_reference_id
string

Alternative to customer_id

Example:

"beneficiary-001"

alpha_3_country_code
string

Must match the customer's country if sent

Example:

"IND"

document_type
enum<string>

Identity document type

Available options:
ONLY_PAN,
GOVT_ID,
PASSPORT
Example:

"ONLY_PAN"

document_front_image_url
string<uri>

Optional. Front image URL of the document.

Example:

"https://example.com/front.jpg"

document_back_image_url
string<uri>

Optional. Back image URL of the document.

Example:

"https://example.com/back.jpg"

full_address
string

Full address

Example:

"12 MG Road, Bengaluru"

tax_number
string

Tax number. Required for IND.

Example:

"ABCDE1234F"

Response

Success

status
boolean
Example:

true

message
string
Example:

"Success"

data
object