Create Entity
curl --request POST \
--url https://service-sandbox.tazapay.com/v3/entity \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"email": "<string>",
"description": "<string>",
"registration_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"operating_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"tax_id": "<string>",
"vertical": "<string>",
"website": "<string>",
"registration_number": "<string>",
"registration_date": "<string>",
"submit": true,
"statement_descriptor": "<string>",
"representatives": [
{
"first_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"ownership_percentage": 123,
"roles": [],
"last_name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"documents": [
{
"description": "<string>",
"file_name": "<string>",
"url": "<string>"
}
]
}
],
"individual": {
"national_identification_number": {
"number": "<string>",
"issuer": {
"country": "<string>",
"state": "<string>"
},
"expiration": "<string>",
"country_of_citizenship": "<string>"
},
"date_of_birth": "<string>",
"nationality": "<string>",
"profession": {
"occupation": "<string>",
"isco_code": "<string>",
"industry": "<string>"
},
"source_of_funds": {
"description": "<string>"
}
},
"transaction_profile": {
"monthly_expected_transactions_value": 123,
"monthly_expected_transaction_volume": 123,
"expected_transaction_countries": [
"<string>"
],
"expected_transaction_currencies": [
"<string>"
]
},
"documents": [
{
"file_name": "<string>",
"description": "<string>",
"url": "<string>"
}
],
"reference_id": "<string>",
"metadata": "<string>",
"purpose_of_use": [
"<string>"
],
"onboarding_package_url": "<string>",
"on_behalf_of": "<string>"
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/entity"
payload = {
"name": "<string>",
"email": "<string>",
"description": "<string>",
"registration_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"operating_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"tax_id": "<string>",
"vertical": "<string>",
"website": "<string>",
"registration_number": "<string>",
"registration_date": "<string>",
"submit": True,
"statement_descriptor": "<string>",
"representatives": [
{
"first_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"ownership_percentage": 123,
"roles": [],
"last_name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"documents": [
{
"description": "<string>",
"file_name": "<string>",
"url": "<string>"
}
]
}
],
"individual": {
"national_identification_number": {
"number": "<string>",
"issuer": {
"country": "<string>",
"state": "<string>"
},
"expiration": "<string>",
"country_of_citizenship": "<string>"
},
"date_of_birth": "<string>",
"nationality": "<string>",
"profession": {
"occupation": "<string>",
"isco_code": "<string>",
"industry": "<string>"
},
"source_of_funds": { "description": "<string>" }
},
"transaction_profile": {
"monthly_expected_transactions_value": 123,
"monthly_expected_transaction_volume": 123,
"expected_transaction_countries": ["<string>"],
"expected_transaction_currencies": ["<string>"]
},
"documents": [
{
"file_name": "<string>",
"description": "<string>",
"url": "<string>"
}
],
"reference_id": "<string>",
"metadata": "<string>",
"purpose_of_use": ["<string>"],
"onboarding_package_url": "<string>",
"on_behalf_of": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
email: '<string>',
description: '<string>',
registration_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
operating_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
phone: {calling_code: '<string>', number: '<string>'},
tax_id: '<string>',
vertical: '<string>',
website: '<string>',
registration_number: '<string>',
registration_date: '<string>',
submit: true,
statement_descriptor: '<string>',
representatives: [
{
first_name: '<string>',
date_of_birth: '<string>',
nationality: '<string>',
ownership_percentage: 123,
roles: [],
last_name: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
phone: {calling_code: '<string>', number: '<string>'},
documents: [{description: '<string>', file_name: '<string>', url: '<string>'}]
}
],
individual: {
national_identification_number: {
number: '<string>',
issuer: {country: '<string>', state: '<string>'},
expiration: '<string>',
country_of_citizenship: '<string>'
},
date_of_birth: '<string>',
nationality: '<string>',
profession: {occupation: '<string>', isco_code: '<string>', industry: '<string>'},
source_of_funds: {description: '<string>'}
},
transaction_profile: {
monthly_expected_transactions_value: 123,
monthly_expected_transaction_volume: 123,
expected_transaction_countries: ['<string>'],
expected_transaction_currencies: ['<string>']
},
documents: [{file_name: '<string>', description: '<string>', url: '<string>'}],
reference_id: '<string>',
metadata: '<string>',
purpose_of_use: ['<string>'],
onboarding_package_url: '<string>',
on_behalf_of: '<string>'
})
};
fetch('https://service-sandbox.tazapay.com/v3/entity', 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://service-sandbox.tazapay.com/v3/entity",
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([
'name' => '<string>',
'email' => '<string>',
'description' => '<string>',
'registration_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'operating_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'phone' => [
'calling_code' => '<string>',
'number' => '<string>'
],
'tax_id' => '<string>',
'vertical' => '<string>',
'website' => '<string>',
'registration_number' => '<string>',
'registration_date' => '<string>',
'submit' => true,
'statement_descriptor' => '<string>',
'representatives' => [
[
'first_name' => '<string>',
'date_of_birth' => '<string>',
'nationality' => '<string>',
'ownership_percentage' => 123,
'roles' => [
],
'last_name' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'phone' => [
'calling_code' => '<string>',
'number' => '<string>'
],
'documents' => [
[
'description' => '<string>',
'file_name' => '<string>',
'url' => '<string>'
]
]
]
],
'individual' => [
'national_identification_number' => [
'number' => '<string>',
'issuer' => [
'country' => '<string>',
'state' => '<string>'
],
'expiration' => '<string>',
'country_of_citizenship' => '<string>'
],
'date_of_birth' => '<string>',
'nationality' => '<string>',
'profession' => [
'occupation' => '<string>',
'isco_code' => '<string>',
'industry' => '<string>'
],
'source_of_funds' => [
'description' => '<string>'
]
],
'transaction_profile' => [
'monthly_expected_transactions_value' => 123,
'monthly_expected_transaction_volume' => 123,
'expected_transaction_countries' => [
'<string>'
],
'expected_transaction_currencies' => [
'<string>'
]
],
'documents' => [
[
'file_name' => '<string>',
'description' => '<string>',
'url' => '<string>'
]
],
'reference_id' => '<string>',
'metadata' => '<string>',
'purpose_of_use' => [
'<string>'
],
'onboarding_package_url' => '<string>',
'on_behalf_of' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://service-sandbox.tazapay.com/v3/entity"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"description\": \"<string>\",\n \"registration_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"operating_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"tax_id\": \"<string>\",\n \"vertical\": \"<string>\",\n \"website\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"registration_date\": \"<string>\",\n \"submit\": true,\n \"statement_descriptor\": \"<string>\",\n \"representatives\": [\n {\n \"first_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"ownership_percentage\": 123,\n \"roles\": [],\n \"last_name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"documents\": [\n {\n \"description\": \"<string>\",\n \"file_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"individual\": {\n \"national_identification_number\": {\n \"number\": \"<string>\",\n \"issuer\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"expiration\": \"<string>\",\n \"country_of_citizenship\": \"<string>\"\n },\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"profession\": {\n \"occupation\": \"<string>\",\n \"isco_code\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"source_of_funds\": {\n \"description\": \"<string>\"\n }\n },\n \"transaction_profile\": {\n \"monthly_expected_transactions_value\": 123,\n \"monthly_expected_transaction_volume\": 123,\n \"expected_transaction_countries\": [\n \"<string>\"\n ],\n \"expected_transaction_currencies\": [\n \"<string>\"\n ]\n },\n \"documents\": [\n {\n \"file_name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"reference_id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"purpose_of_use\": [\n \"<string>\"\n ],\n \"onboarding_package_url\": \"<string>\",\n \"on_behalf_of\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://service-sandbox.tazapay.com/v3/entity")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"description\": \"<string>\",\n \"registration_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"operating_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"tax_id\": \"<string>\",\n \"vertical\": \"<string>\",\n \"website\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"registration_date\": \"<string>\",\n \"submit\": true,\n \"statement_descriptor\": \"<string>\",\n \"representatives\": [\n {\n \"first_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"ownership_percentage\": 123,\n \"roles\": [],\n \"last_name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"documents\": [\n {\n \"description\": \"<string>\",\n \"file_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"individual\": {\n \"national_identification_number\": {\n \"number\": \"<string>\",\n \"issuer\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"expiration\": \"<string>\",\n \"country_of_citizenship\": \"<string>\"\n },\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"profession\": {\n \"occupation\": \"<string>\",\n \"isco_code\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"source_of_funds\": {\n \"description\": \"<string>\"\n }\n },\n \"transaction_profile\": {\n \"monthly_expected_transactions_value\": 123,\n \"monthly_expected_transaction_volume\": 123,\n \"expected_transaction_countries\": [\n \"<string>\"\n ],\n \"expected_transaction_currencies\": [\n \"<string>\"\n ]\n },\n \"documents\": [\n {\n \"file_name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"reference_id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"purpose_of_use\": [\n \"<string>\"\n ],\n \"onboarding_package_url\": \"<string>\",\n \"on_behalf_of\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/entity")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"description\": \"<string>\",\n \"registration_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"operating_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"tax_id\": \"<string>\",\n \"vertical\": \"<string>\",\n \"website\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"registration_date\": \"<string>\",\n \"submit\": true,\n \"statement_descriptor\": \"<string>\",\n \"representatives\": [\n {\n \"first_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"ownership_percentage\": 123,\n \"roles\": [],\n \"last_name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"documents\": [\n {\n \"description\": \"<string>\",\n \"file_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"individual\": {\n \"national_identification_number\": {\n \"number\": \"<string>\",\n \"issuer\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"expiration\": \"<string>\",\n \"country_of_citizenship\": \"<string>\"\n },\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"profession\": {\n \"occupation\": \"<string>\",\n \"isco_code\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"source_of_funds\": {\n \"description\": \"<string>\"\n }\n },\n \"transaction_profile\": {\n \"monthly_expected_transactions_value\": 123,\n \"monthly_expected_transaction_volume\": 123,\n \"expected_transaction_countries\": [\n \"<string>\"\n ],\n \"expected_transaction_currencies\": [\n \"<string>\"\n ]\n },\n \"documents\": [\n {\n \"file_name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"reference_id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"purpose_of_use\": [\n \"<string>\"\n ],\n \"onboarding_package_url\": \"<string>\",\n \"on_behalf_of\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "",
"data": {
"approval_status": "submitted",
"approval_status_description": "",
"approved_at": "2025-10-09T02:55:52.284767Z",
"created_at": "2025-10-08T05:18:11.700575Z",
"description": "",
"documents": [
{
"description": "Recent utility bill",
"document_id": "doc_d3iv85v58tg9dlpipu2g",
"file_name": "kyb_doc82697_2October2025_202590_894374483.pdf",
"sub_type": "other",
"tag": "",
"type": "address",
"updated_at": "2025-09-08T05:18:15.228195Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc"
},
{
"description": "Passport front",
"document_id": "doc_d3iv85v58tg9dlpipu1g",
"file_name": "kyb_doc10723_8October2025_docapture_manual-6.jpg",
"sub_type": "passport",
"tag": "identityProofTypeFrontDoc",
"type": "identity",
"updated_at": "2025-10-08T05:18:15.228195Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc"
},
{
"description": "Passport back",
"document_id": "doc_d3iv85v58tg9dlpipu20",
"file_name": "kyb_doc38625_8October2025_docapture_manual-6.jpg",
"sub_type": "passport",
"tag": "identityProofTypeBackDoc",
"type": "identity",
"updated_at": "2025-10-08T05:18:15.228195Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc"
}
],
"email": "",
"id": "ent_d3iv84vs8ud68hm8dba40",
"metadata": {},
"name": "James Brwon",
"object": "entity",
"on_behalf_of": "",
"onboarding_package_url": "",
"operating_address": null,
"pending_documents": [],
"phone": {
"calling_code": "",
"number": ""
},
"purpose_of_use": [
"payout"
],
"reference_id": "",
"registration_address": {
"city": "Bangkok",
"country": "TH",
"line1": "151/1 Richmond Boulevard, Lumpini",
"line2": "",
"postal_code": "10330",
"state": "Pathumwan"
},
"registration_date": "",
"registration_number": "",
"rejected_at": null,
"relationship": "customer",
"representatives": [],
"individual": {
"date_of_birth": "1990-05-15",
"national_identification_number": {
"type": "passport",
"number": "P1234567",
"issuer": {
"country": "SG",
"state": ""
},
"expiration": "2030-05-14",
"country_of_citizenship": "SG"
},
"nationality": "SG",
"profession": {
"occupation": "Software Engineer",
"isco_code": "2512",
"industry": "Technology",
"employment_status": "employed"
},
"source_of_funds": {
"primary_source": "salary",
"description": ""
},
"employment_details": {
"employer_name": "Acme Corp",
"designation": "Senior Engineer"
}
},
"transaction_profile": {
"monthly_expected_transactions_value": 10000,
"monthly_expected_transaction_volume": 5,
"expected_transaction_countries": [
"SG",
"US"
],
"expected_transaction_currencies": [
"USD",
"SGD"
],
"customer_risk": "low"
},
"source_of_wealth": null,
"statement_descriptor": "",
"submit": true,
"submitted_at": "2025-10-01T05:18:15.228732Z",
"tax_id": "",
"type": "individual",
"vertical": "",
"website": ""
}
}"{}"Entity
Create Entity
Create a sub-entity for your account
POST
/
v3
/
entity
Create Entity
curl --request POST \
--url https://service-sandbox.tazapay.com/v3/entity \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"email": "<string>",
"description": "<string>",
"registration_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"operating_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"tax_id": "<string>",
"vertical": "<string>",
"website": "<string>",
"registration_number": "<string>",
"registration_date": "<string>",
"submit": true,
"statement_descriptor": "<string>",
"representatives": [
{
"first_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"ownership_percentage": 123,
"roles": [],
"last_name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"documents": [
{
"description": "<string>",
"file_name": "<string>",
"url": "<string>"
}
]
}
],
"individual": {
"national_identification_number": {
"number": "<string>",
"issuer": {
"country": "<string>",
"state": "<string>"
},
"expiration": "<string>",
"country_of_citizenship": "<string>"
},
"date_of_birth": "<string>",
"nationality": "<string>",
"profession": {
"occupation": "<string>",
"isco_code": "<string>",
"industry": "<string>"
},
"source_of_funds": {
"description": "<string>"
}
},
"transaction_profile": {
"monthly_expected_transactions_value": 123,
"monthly_expected_transaction_volume": 123,
"expected_transaction_countries": [
"<string>"
],
"expected_transaction_currencies": [
"<string>"
]
},
"documents": [
{
"file_name": "<string>",
"description": "<string>",
"url": "<string>"
}
],
"reference_id": "<string>",
"metadata": "<string>",
"purpose_of_use": [
"<string>"
],
"onboarding_package_url": "<string>",
"on_behalf_of": "<string>"
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/entity"
payload = {
"name": "<string>",
"email": "<string>",
"description": "<string>",
"registration_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"operating_address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"tax_id": "<string>",
"vertical": "<string>",
"website": "<string>",
"registration_number": "<string>",
"registration_date": "<string>",
"submit": True,
"statement_descriptor": "<string>",
"representatives": [
{
"first_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"ownership_percentage": 123,
"roles": [],
"last_name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postal_code": "<string>"
},
"phone": {
"calling_code": "<string>",
"number": "<string>"
},
"documents": [
{
"description": "<string>",
"file_name": "<string>",
"url": "<string>"
}
]
}
],
"individual": {
"national_identification_number": {
"number": "<string>",
"issuer": {
"country": "<string>",
"state": "<string>"
},
"expiration": "<string>",
"country_of_citizenship": "<string>"
},
"date_of_birth": "<string>",
"nationality": "<string>",
"profession": {
"occupation": "<string>",
"isco_code": "<string>",
"industry": "<string>"
},
"source_of_funds": { "description": "<string>" }
},
"transaction_profile": {
"monthly_expected_transactions_value": 123,
"monthly_expected_transaction_volume": 123,
"expected_transaction_countries": ["<string>"],
"expected_transaction_currencies": ["<string>"]
},
"documents": [
{
"file_name": "<string>",
"description": "<string>",
"url": "<string>"
}
],
"reference_id": "<string>",
"metadata": "<string>",
"purpose_of_use": ["<string>"],
"onboarding_package_url": "<string>",
"on_behalf_of": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
email: '<string>',
description: '<string>',
registration_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
operating_address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
phone: {calling_code: '<string>', number: '<string>'},
tax_id: '<string>',
vertical: '<string>',
website: '<string>',
registration_number: '<string>',
registration_date: '<string>',
submit: true,
statement_descriptor: '<string>',
representatives: [
{
first_name: '<string>',
date_of_birth: '<string>',
nationality: '<string>',
ownership_percentage: 123,
roles: [],
last_name: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
country: '<string>',
postal_code: '<string>'
},
phone: {calling_code: '<string>', number: '<string>'},
documents: [{description: '<string>', file_name: '<string>', url: '<string>'}]
}
],
individual: {
national_identification_number: {
number: '<string>',
issuer: {country: '<string>', state: '<string>'},
expiration: '<string>',
country_of_citizenship: '<string>'
},
date_of_birth: '<string>',
nationality: '<string>',
profession: {occupation: '<string>', isco_code: '<string>', industry: '<string>'},
source_of_funds: {description: '<string>'}
},
transaction_profile: {
monthly_expected_transactions_value: 123,
monthly_expected_transaction_volume: 123,
expected_transaction_countries: ['<string>'],
expected_transaction_currencies: ['<string>']
},
documents: [{file_name: '<string>', description: '<string>', url: '<string>'}],
reference_id: '<string>',
metadata: '<string>',
purpose_of_use: ['<string>'],
onboarding_package_url: '<string>',
on_behalf_of: '<string>'
})
};
fetch('https://service-sandbox.tazapay.com/v3/entity', 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://service-sandbox.tazapay.com/v3/entity",
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([
'name' => '<string>',
'email' => '<string>',
'description' => '<string>',
'registration_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'operating_address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'phone' => [
'calling_code' => '<string>',
'number' => '<string>'
],
'tax_id' => '<string>',
'vertical' => '<string>',
'website' => '<string>',
'registration_number' => '<string>',
'registration_date' => '<string>',
'submit' => true,
'statement_descriptor' => '<string>',
'representatives' => [
[
'first_name' => '<string>',
'date_of_birth' => '<string>',
'nationality' => '<string>',
'ownership_percentage' => 123,
'roles' => [
],
'last_name' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'country' => '<string>',
'postal_code' => '<string>'
],
'phone' => [
'calling_code' => '<string>',
'number' => '<string>'
],
'documents' => [
[
'description' => '<string>',
'file_name' => '<string>',
'url' => '<string>'
]
]
]
],
'individual' => [
'national_identification_number' => [
'number' => '<string>',
'issuer' => [
'country' => '<string>',
'state' => '<string>'
],
'expiration' => '<string>',
'country_of_citizenship' => '<string>'
],
'date_of_birth' => '<string>',
'nationality' => '<string>',
'profession' => [
'occupation' => '<string>',
'isco_code' => '<string>',
'industry' => '<string>'
],
'source_of_funds' => [
'description' => '<string>'
]
],
'transaction_profile' => [
'monthly_expected_transactions_value' => 123,
'monthly_expected_transaction_volume' => 123,
'expected_transaction_countries' => [
'<string>'
],
'expected_transaction_currencies' => [
'<string>'
]
],
'documents' => [
[
'file_name' => '<string>',
'description' => '<string>',
'url' => '<string>'
]
],
'reference_id' => '<string>',
'metadata' => '<string>',
'purpose_of_use' => [
'<string>'
],
'onboarding_package_url' => '<string>',
'on_behalf_of' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://service-sandbox.tazapay.com/v3/entity"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"description\": \"<string>\",\n \"registration_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"operating_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"tax_id\": \"<string>\",\n \"vertical\": \"<string>\",\n \"website\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"registration_date\": \"<string>\",\n \"submit\": true,\n \"statement_descriptor\": \"<string>\",\n \"representatives\": [\n {\n \"first_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"ownership_percentage\": 123,\n \"roles\": [],\n \"last_name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"documents\": [\n {\n \"description\": \"<string>\",\n \"file_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"individual\": {\n \"national_identification_number\": {\n \"number\": \"<string>\",\n \"issuer\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"expiration\": \"<string>\",\n \"country_of_citizenship\": \"<string>\"\n },\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"profession\": {\n \"occupation\": \"<string>\",\n \"isco_code\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"source_of_funds\": {\n \"description\": \"<string>\"\n }\n },\n \"transaction_profile\": {\n \"monthly_expected_transactions_value\": 123,\n \"monthly_expected_transaction_volume\": 123,\n \"expected_transaction_countries\": [\n \"<string>\"\n ],\n \"expected_transaction_currencies\": [\n \"<string>\"\n ]\n },\n \"documents\": [\n {\n \"file_name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"reference_id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"purpose_of_use\": [\n \"<string>\"\n ],\n \"onboarding_package_url\": \"<string>\",\n \"on_behalf_of\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://service-sandbox.tazapay.com/v3/entity")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"description\": \"<string>\",\n \"registration_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"operating_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"tax_id\": \"<string>\",\n \"vertical\": \"<string>\",\n \"website\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"registration_date\": \"<string>\",\n \"submit\": true,\n \"statement_descriptor\": \"<string>\",\n \"representatives\": [\n {\n \"first_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"ownership_percentage\": 123,\n \"roles\": [],\n \"last_name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"documents\": [\n {\n \"description\": \"<string>\",\n \"file_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"individual\": {\n \"national_identification_number\": {\n \"number\": \"<string>\",\n \"issuer\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"expiration\": \"<string>\",\n \"country_of_citizenship\": \"<string>\"\n },\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"profession\": {\n \"occupation\": \"<string>\",\n \"isco_code\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"source_of_funds\": {\n \"description\": \"<string>\"\n }\n },\n \"transaction_profile\": {\n \"monthly_expected_transactions_value\": 123,\n \"monthly_expected_transaction_volume\": 123,\n \"expected_transaction_countries\": [\n \"<string>\"\n ],\n \"expected_transaction_currencies\": [\n \"<string>\"\n ]\n },\n \"documents\": [\n {\n \"file_name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"reference_id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"purpose_of_use\": [\n \"<string>\"\n ],\n \"onboarding_package_url\": \"<string>\",\n \"on_behalf_of\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/entity")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"description\": \"<string>\",\n \"registration_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"operating_address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"tax_id\": \"<string>\",\n \"vertical\": \"<string>\",\n \"website\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"registration_date\": \"<string>\",\n \"submit\": true,\n \"statement_descriptor\": \"<string>\",\n \"representatives\": [\n {\n \"first_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"ownership_percentage\": 123,\n \"roles\": [],\n \"last_name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"phone\": {\n \"calling_code\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"documents\": [\n {\n \"description\": \"<string>\",\n \"file_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ],\n \"individual\": {\n \"national_identification_number\": {\n \"number\": \"<string>\",\n \"issuer\": {\n \"country\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"expiration\": \"<string>\",\n \"country_of_citizenship\": \"<string>\"\n },\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"profession\": {\n \"occupation\": \"<string>\",\n \"isco_code\": \"<string>\",\n \"industry\": \"<string>\"\n },\n \"source_of_funds\": {\n \"description\": \"<string>\"\n }\n },\n \"transaction_profile\": {\n \"monthly_expected_transactions_value\": 123,\n \"monthly_expected_transaction_volume\": 123,\n \"expected_transaction_countries\": [\n \"<string>\"\n ],\n \"expected_transaction_currencies\": [\n \"<string>\"\n ]\n },\n \"documents\": [\n {\n \"file_name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"reference_id\": \"<string>\",\n \"metadata\": \"<string>\",\n \"purpose_of_use\": [\n \"<string>\"\n ],\n \"onboarding_package_url\": \"<string>\",\n \"on_behalf_of\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "",
"data": {
"approval_status": "submitted",
"approval_status_description": "",
"approved_at": "2025-10-09T02:55:52.284767Z",
"created_at": "2025-10-08T05:18:11.700575Z",
"description": "",
"documents": [
{
"description": "Recent utility bill",
"document_id": "doc_d3iv85v58tg9dlpipu2g",
"file_name": "kyb_doc82697_2October2025_202590_894374483.pdf",
"sub_type": "other",
"tag": "",
"type": "address",
"updated_at": "2025-09-08T05:18:15.228195Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc"
},
{
"description": "Passport front",
"document_id": "doc_d3iv85v58tg9dlpipu1g",
"file_name": "kyb_doc10723_8October2025_docapture_manual-6.jpg",
"sub_type": "passport",
"tag": "identityProofTypeFrontDoc",
"type": "identity",
"updated_at": "2025-10-08T05:18:15.228195Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc"
},
{
"description": "Passport back",
"document_id": "doc_d3iv85v58tg9dlpipu20",
"file_name": "kyb_doc38625_8October2025_docapture_manual-6.jpg",
"sub_type": "passport",
"tag": "identityProofTypeBackDoc",
"type": "identity",
"updated_at": "2025-10-08T05:18:15.228195Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc"
}
],
"email": "",
"id": "ent_d3iv84vs8ud68hm8dba40",
"metadata": {},
"name": "James Brwon",
"object": "entity",
"on_behalf_of": "",
"onboarding_package_url": "",
"operating_address": null,
"pending_documents": [],
"phone": {
"calling_code": "",
"number": ""
},
"purpose_of_use": [
"payout"
],
"reference_id": "",
"registration_address": {
"city": "Bangkok",
"country": "TH",
"line1": "151/1 Richmond Boulevard, Lumpini",
"line2": "",
"postal_code": "10330",
"state": "Pathumwan"
},
"registration_date": "",
"registration_number": "",
"rejected_at": null,
"relationship": "customer",
"representatives": [],
"individual": {
"date_of_birth": "1990-05-15",
"national_identification_number": {
"type": "passport",
"number": "P1234567",
"issuer": {
"country": "SG",
"state": ""
},
"expiration": "2030-05-14",
"country_of_citizenship": "SG"
},
"nationality": "SG",
"profession": {
"occupation": "Software Engineer",
"isco_code": "2512",
"industry": "Technology",
"employment_status": "employed"
},
"source_of_funds": {
"primary_source": "salary",
"description": ""
},
"employment_details": {
"employer_name": "Acme Corp",
"designation": "Senior Engineer"
}
},
"transaction_profile": {
"monthly_expected_transactions_value": 10000,
"monthly_expected_transaction_volume": 5,
"expected_transaction_countries": [
"SG",
"US"
],
"expected_transaction_currencies": [
"USD",
"SGD"
],
"customer_risk": "low"
},
"source_of_wealth": null,
"statement_descriptor": "",
"submit": true,
"submitted_at": "2025-10-01T05:18:15.228732Z",
"tax_id": "",
"type": "individual",
"vertical": "",
"website": ""
}
}"{}"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Name of the entity
Type of the entity
Available options:
sole_proprietorship, company, non_profit, government_entity, individual Email of the entity
A short description of the business
Address details
Show child attributes
Show child attributes
Address details
Show child attributes
Show child attributes
Phone contact details
Show child attributes
Show child attributes
Tax ID of the entity
Industry Vertical
Entity website
Business Registration Number
Business Registration Date, Format DD-MM-YYYY
true or false, default is false
Statement Descriptor for the entity
Representative Details
Show child attributes
Show child attributes
Individual Details
Show child attributes
Show child attributes
Expected transaction profile of the entity
Show child attributes
Show child attributes
Documents for the entity
Show child attributes
Show child attributes
Merchant's internal reference ID for the entity
Set of key-value pairs to attach to the entity
The entity's relationship with you
Available options:
customer, vendor, fourth_party, other The capabilities the entity intends to use. Possible values - collect, payout. In case you only want to add global collection account on behalf of the entity, pass collect. If you want to only make payouts on behalf of the entity, use payout. In case you want to do both, pass ["collect","payout"]
Link to the complete onboarding package for the entity
ID of the entity this entity is created on behalf of
Was this page helpful?
⌘I