Skip to main content
POST
cURL

Add Payout Sender KYC

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
client_reference_id
string

The beneficiary's client_reference_id

Example:

"beneficiary-001"

country_code
string

Beneficiary country, alpha-3. Must match the customer's country if sent.

Example:

"BRA"

tax_number
string

Tax number

Example:

"12345678909"

document_type
enum<string>

Identity document type

Available options:
ONLY_PAN,
GOVT_ID,
PASSPORT
Example:

"PASSPORT"

document_front_image_url
string<uri>

Document front image URL

Example:

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

document_back_image_url
string<uri>

Document back image URL

Example:

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

street
string

Street address

Example:

"Av. Paulista 1000"

city
string

City

Example:

"São Paulo"

state_province
string

State or province

Example:

"SP"

postal_code
string

Postal code

Example:

"01310-100"

beneficiary_identifiers
object

Country-specific beneficiary fields

Example:

Response

Success

status
boolean
Example:

true

message
string
Example:

"Success"

data
object