Create Remitter

cURL

curl --request POST \
  --url https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-SIGNATURE: <api-key>' \
  --header 'X-TIMESTAMP: <api-key>' \
  --data '
{
  "first_name": "Siva",
  "last_name": "Raj",
  "nationality": "IND",
  "city": "Sydney",
  "source_of_funds": "gifts",
  "id_type": "PASSPORT",
  "id_number": "P1234567",
  "dob": "1990-01-15",
  "phone": "+61412345678",
  "address_line": "1 George Street",
  "residence_country": "ARE",
  "client_reference_id": "remitter-ref-001",
  "email": "siva.raj@example.com"
}
'

import requests

url = "https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create"

payload = {
    "first_name": "Siva",
    "last_name": "Raj",
    "nationality": "IND",
    "city": "Sydney",
    "source_of_funds": "gifts",
    "id_type": "PASSPORT",
    "id_number": "P1234567",
    "dob": "1990-01-15",
    "phone": "+61412345678",
    "address_line": "1 George Street",
    "residence_country": "ARE",
    "client_reference_id": "remitter-ref-001",
    "email": "siva.raj@example.com"
}
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({
    first_name: 'Siva',
    last_name: 'Raj',
    nationality: 'IND',
    city: 'Sydney',
    source_of_funds: 'gifts',
    id_type: 'PASSPORT',
    id_number: 'P1234567',
    dob: '1990-01-15',
    phone: '+61412345678',
    address_line: '1 George Street',
    residence_country: 'ARE',
    client_reference_id: 'remitter-ref-001',
    email: 'siva.raj@example.com'
  })
};

fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create', 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/remitter/create",
  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([
    'first_name' => 'Siva',
    'last_name' => 'Raj',
    'nationality' => 'IND',
    'city' => 'Sydney',
    'source_of_funds' => 'gifts',
    'id_type' => 'PASSPORT',
    'id_number' => 'P1234567',
    'dob' => '1990-01-15',
    'phone' => '+61412345678',
    'address_line' => '1 George Street',
    'residence_country' => 'ARE',
    'client_reference_id' => 'remitter-ref-001',
    'email' => 'siva.raj@example.com'
  ]),
  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/remitter/create"

	payload := strings.NewReader("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PASSPORT\",\n  \"id_number\": \"P1234567\",\n  \"dob\": \"1990-01-15\",\n  \"phone\": \"+61412345678\",\n  \"address_line\": \"1 George Street\",\n  \"residence_country\": \"ARE\",\n  \"client_reference_id\": \"remitter-ref-001\",\n  \"email\": \"siva.raj@example.com\"\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.zapyd.com/cms/api/v1/kyc/remitter/create")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PASSPORT\",\n  \"id_number\": \"P1234567\",\n  \"dob\": \"1990-01-15\",\n  \"phone\": \"+61412345678\",\n  \"address_line\": \"1 George Street\",\n  \"residence_country\": \"ARE\",\n  \"client_reference_id\": \"remitter-ref-001\",\n  \"email\": \"siva.raj@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create")

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  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PASSPORT\",\n  \"id_number\": \"P1234567\",\n  \"dob\": \"1990-01-15\",\n  \"phone\": \"+61412345678\",\n  \"address_line\": \"1 George Street\",\n  \"residence_country\": \"ARE\",\n  \"client_reference_id\": \"remitter-ref-001\",\n  \"email\": \"siva.raj@example.com\"\n}"

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

{
  "status": true,
  "message": "Remitter created",
  "data": {
    "id": "e14fa86f-2a5e-437a-a031-949c68ade933",
    "client_reference_id": "remitter-ref-001",
    "first_name": "Siva",
    "last_name": "Raj",
    "full_name": "Siva Raj",
    "email": null,
    "phone": "+61412345678",
    "dob": "1990-01-15",
    "nationality": "IND",
    "residence_country": "ARE",
    "city": "Sydney",
    "address_line": "1 George Street",
    "source_of_funds": "salary",
    "document_type": "PASSPORT",
    "status": "VERIFIED",
    "created_at": "2026-09-30T10:00:00+00:00"
  }
}

{
  "status": false,
  "message": "Bad Request",
  "err_code": "REQ_FIELD_MISSING",
  "errors": {
    "id_number": [
      "This field is required."
    ]
  },
  "data": null
}

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

POST

kyc

remitter

create

cURL

curl --request POST \
  --url https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-SIGNATURE: <api-key>' \
  --header 'X-TIMESTAMP: <api-key>' \
  --data '
{
  "first_name": "Siva",
  "last_name": "Raj",
  "nationality": "IND",
  "city": "Sydney",
  "source_of_funds": "gifts",
  "id_type": "PASSPORT",
  "id_number": "P1234567",
  "dob": "1990-01-15",
  "phone": "+61412345678",
  "address_line": "1 George Street",
  "residence_country": "ARE",
  "client_reference_id": "remitter-ref-001",
  "email": "siva.raj@example.com"
}
'

import requests

url = "https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create"

payload = {
    "first_name": "Siva",
    "last_name": "Raj",
    "nationality": "IND",
    "city": "Sydney",
    "source_of_funds": "gifts",
    "id_type": "PASSPORT",
    "id_number": "P1234567",
    "dob": "1990-01-15",
    "phone": "+61412345678",
    "address_line": "1 George Street",
    "residence_country": "ARE",
    "client_reference_id": "remitter-ref-001",
    "email": "siva.raj@example.com"
}
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({
    first_name: 'Siva',
    last_name: 'Raj',
    nationality: 'IND',
    city: 'Sydney',
    source_of_funds: 'gifts',
    id_type: 'PASSPORT',
    id_number: 'P1234567',
    dob: '1990-01-15',
    phone: '+61412345678',
    address_line: '1 George Street',
    residence_country: 'ARE',
    client_reference_id: 'remitter-ref-001',
    email: 'siva.raj@example.com'
  })
};

fetch('https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create', 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/remitter/create",
  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([
    'first_name' => 'Siva',
    'last_name' => 'Raj',
    'nationality' => 'IND',
    'city' => 'Sydney',
    'source_of_funds' => 'gifts',
    'id_type' => 'PASSPORT',
    'id_number' => 'P1234567',
    'dob' => '1990-01-15',
    'phone' => '+61412345678',
    'address_line' => '1 George Street',
    'residence_country' => 'ARE',
    'client_reference_id' => 'remitter-ref-001',
    'email' => 'siva.raj@example.com'
  ]),
  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/remitter/create"

	payload := strings.NewReader("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PASSPORT\",\n  \"id_number\": \"P1234567\",\n  \"dob\": \"1990-01-15\",\n  \"phone\": \"+61412345678\",\n  \"address_line\": \"1 George Street\",\n  \"residence_country\": \"ARE\",\n  \"client_reference_id\": \"remitter-ref-001\",\n  \"email\": \"siva.raj@example.com\"\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.zapyd.com/cms/api/v1/kyc/remitter/create")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PASSPORT\",\n  \"id_number\": \"P1234567\",\n  \"dob\": \"1990-01-15\",\n  \"phone\": \"+61412345678\",\n  \"address_line\": \"1 George Street\",\n  \"residence_country\": \"ARE\",\n  \"client_reference_id\": \"remitter-ref-001\",\n  \"email\": \"siva.raj@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.zapyd.com/cms/api/v1/kyc/remitter/create")

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  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PASSPORT\",\n  \"id_number\": \"P1234567\",\n  \"dob\": \"1990-01-15\",\n  \"phone\": \"+61412345678\",\n  \"address_line\": \"1 George Street\",\n  \"residence_country\": \"ARE\",\n  \"client_reference_id\": \"remitter-ref-001\",\n  \"email\": \"siva.raj@example.com\"\n}"

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

{
  "status": true,
  "message": "Remitter created",
  "data": {
    "id": "e14fa86f-2a5e-437a-a031-949c68ade933",
    "client_reference_id": "remitter-ref-001",
    "first_name": "Siva",
    "last_name": "Raj",
    "full_name": "Siva Raj",
    "email": null,
    "phone": "+61412345678",
    "dob": "1990-01-15",
    "nationality": "IND",
    "residence_country": "ARE",
    "city": "Sydney",
    "address_line": "1 George Street",
    "source_of_funds": "salary",
    "document_type": "PASSPORT",
    "status": "VERIFIED",
    "created_at": "2026-09-30T10:00:00+00:00"
  }
}

{
  "status": false,
  "message": "Bad Request",
  "err_code": "REQ_FIELD_MISSING",
  "errors": {
    "id_number": [
      "This field is required."
    ]
  },
  "data": null
}

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

Create Remitter

Open in Cursor

Creating a remitter is idempotent: submitting the same id_type + id_number for your organization again returns the stored remitter unchanged, even if other fields (name, date of birth, phone, email, address) differ.

customer_id is not part of this request. A remitter is a standalone record, not a Customer: customer endpoints reject a remitter ID.

Field notes

source_of_funds: one of salary, savings, gifts, gift_from_family_and_friends, business_income, investment_proceeds, funds_from_dividend_payouts, pension_retirement, inheritance, sale_of_assets_real_estate, loan_from_bank, final_settlement, funds_from_schemes_and_raffles, gambling_proceeds, other_sources. Other codes (for example esops, credit_card, crypto_currencies) are rejected.
The response includes status, which is VERIFIED on create: the remitter’s identity is checked when the payout is fulfilled.
id_type: use PASSPORT or DRIVING_LICENCE. BENEFICIARY_ID, PAN_CARD, AADHAAR_CARD, AIRLINE_STAFF_CARD, BUSINESS_REGISTRATION_NO_BR, CENTRAL_BANK_LICENCE and ACRA are accepted but stored as a generic government ID. Other values are rejected.
id_number: 6–20 characters, letters, digits and -.
nationality and residence_country must be valid ISO 3166-1 alpha-3 codes. residence_country cannot be IND: a remitter must live outside India.
dob must be in the past. phone must be E.164 (+ and country code) with a known dial code.
The remitter is recorded as the sender of each payout, which is why full identity is required.

Error Codes and Messages

API Status Code	Response	Reason
400	Bad Request	A required field is missing
400	Bad Request	`source_of_funds` is not one of the accepted values
400	Bad Request	`id_type` is not one of the accepted values
400	Bad Request	`first_name`, `last_name`, or `city` contains unsupported characters
400	Bad Request	`nationality` or `residence_country` is not a valid alpha-3 code
400	A remitter must reside outside India.	`residence_country` is `IND`
400	dob must be in the past.	`dob` is today or in the future
400	Unsupported country dial code.	`phone` dial code is not recognised
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

first_name

string

required

Letters, spaces, apostrophes, and hyphens only. 1-100 characters.

Example:

"Siva"

last_name

string

required

Letters, spaces, apostrophes, and hyphens only. 1-100 characters.

Example:

"Raj"

nationality

string

required

ISO 3166-1 alpha-3 country code (validated, uppercased).

Example:

"IND"

city

string

required

Letters, spaces, apostrophes, and hyphens only. 2-50 characters.

Example:

"Sydney"

source_of_funds

enum<string>

required

Source of funds. One of the listed codes; others are rejected.

Available options:

business_income,

final_settlement,

funds_from_dividend_payouts,

funds_from_schemes_and_raffles,

gambling_proceeds,

gift_from_family_and_friends,

gifts,

inheritance,

investment_proceeds,

loan_from_bank,

other_sources,

pension_retirement,

salary,

sale_of_assets_real_estate,

savings

Example:

"gifts"

id_type

enum<string>

required

Identity document type. Use PASSPORT or DRIVING_LICENCE; the other values are accepted but stored as a generic government ID.

Available options:

PASSPORT,

DRIVING_LICENCE,

BENEFICIARY_ID,

PAN_CARD,

AADHAAR_CARD,

AIRLINE_STAFF_CARD,

BUSINESS_REGISTRATION_NO_BR,

CENTRAL_BANK_LICENCE,

ACRA

Example:

"PASSPORT"

id_number

string

required

6–20 characters: letters, digits and hyphens.

Example:

"P1234567"

dob

string<date>

required

Date of birth (YYYY-MM-DD). Must be in the past.

Example:

"1990-01-15"

phone

string

required

Phone in E.164 format with the leading +. The dial code must be a known country.

Example:

"+61412345678"

address_line

string

required

Residential address, max 500 characters

Example:

"1 George Street"

residence_country

string

required

Country of residence, ISO 3166-1 alpha-3. Must not be IND: a remitter must live outside India.

Example:

"ARE"

client_reference_id

string

Optional client-supplied reference for tracking. Max 255 characters.

Example:

"remitter-ref-001"

string<email>

Email address. Optional.

Example:

"siva.raj@example.com"

Response

Remitter created (or existing matching remitter returned)

status

boolean

Example:

true

message

string

Example:

"Remitter created"

data

object

Hide child attributes

data.id

string<uuid>

Remitter ID. Pass as remitter_id on remittance payout requests.

Example:

"e14fa86f-2a5e-437a-a031-949c68ade933"

data.client_reference_id

string | null

Example:

"remitter-ref-001"

data.first_name

string

Example:

"Siva"

data.last_name

string

Example:

"Raj"

data.full_name

string

Example:

"Siva Raj"

data.email

string | null

Example:

null

data.phone

string

Example:

"+61412345678"

data.dob

string<date>

Example:

"1990-01-15"

data.nationality

string

Example:

"IND"

data.residence_country

string

Example:

"ARE"

data.city

string

Example:

"Sydney"

data.address_line

string

Example:

"1 George Street"

data.source_of_funds

string

Example:

"salary"

data.document_type

string

Stored document type

Example:

"PASSPORT"

data.status

enum<string>

Remitter status. VERIFIED on create; the remitter's identity is checked when the payout is fulfilled.

Available options:

UNVERIFIED,

PROCESSING,

VERIFIED,

FAILED,

MANUAL_REVIEW

Example:

"VERIFIED"

data.created_at

string<date-time>

Example:

"2026-09-30T10:00:00+00:00"

Using the API

Onboarding

Money movement

Platform

Sandbox

Create Remitter

Field notes

Error Codes and Messages

Authorizations

Body

Response

​Field notes

​Error Codes and Messages

Authorizations

Body

Response

Field notes

Error Codes and Messages