Create Entity (Individual)

Create a sub-entity for your account

POST /v3/entity

Create Entity

cURL

curl --request POST \
  --url https://service-sandbox.tazapay.com/v3/entity \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "sole_proprietorship",
  "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": [
        {
          "type": "identity",
          "sub_type": "drivers_license",
          "tag": "AddressProofDoc",
          "description": "<string>",
          "file_name": "<string>",
          "url": "<string>"
        }
      ]
    }
  ],
  "individual": {
    "national_identification_number": {
      "type": "passport",
      "number": "<string>"
    },
    "date_of_birth": "<string>",
    "nationality": "<string>"
  },
  "documents": [
    {
      "type": "business",
      "sub_type": "other",
      "tag": "registrationProofDoc",
      "file_name": "<string>",
      "description": "<string>",
      "url": "<string>"
    }
  ],
  "reference_id": "<string>",
  "metadata": "<string>",
  "relationship": "customer",
  "purpose_of_use": [
    "<string>"
  ],
  "onboarding_package_url": "<string>",
  "on_behalf_of": "<string>"
}
'

200

"   \"status\": \"success\",\n    \"message\": \"\",\n    \"data\": {\n        \"approval_status\": \"submitted\",\n        \"approval_status_description\": \"\",\n        \"approved_at\": \"2025-10-09T02:55:52.284767Z\",\n        \"created_at\": \"2025-10-08T05:18:11.700575Z\",\n        \"description\": \"\",\n        \"documents\": [\n            {\n                \"description\": \"Recent utility bill\",\n                \"document_id\": \"doc_d3iv85v58tg9dlpipu2g\",\n                \"file_name\": \"kyb_doc82697_2October2025_202590_894374483.pdf\",\n                \"sub_type\": \"other\",\n                \"tag\": \"\",\n                \"type\": \"address\",\n              \t\"updated_at\": \"2025-09-08T05:18:15.228195Z\",\n\t\t\t\t\t\t\t\t\"url\": \"https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc\"\n            },\n            {\n                \"description\": \"Passport front\",\n                \"document_id\": \"doc_d3iv85v58tg9dlpipu1g\",\n                \"file_name\": \"kyb_doc10723_8October2025_docapture_manual-6.jpg\",\n                \"sub_type\": \"passport\",\n                \"tag\": \"identityProofTypeFrontDoc\",\n                \"type\": \"identity\",\n                \"updated_at\": \"2025-10-08T05:18:15.228195Z\",\n\t\t\t\t\t\t\t\t\"url\": \"https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc\"\n\n            },\n            {\n                \"description\": \"Passport back\",\n                \"document_id\": \"doc_d3iv85v58tg9dlpipu20\",\n                \"file_name\": \"kyb_doc38625_8October2025_docapture_manual-6.jpg\",\n                \"sub_type\": \"passport\",\n                \"tag\": \"identityProofTypeBackDoc\",\n                \"type\": \"identity\",\n                \"updated_at\": \"2025-10-08T05:18:15.228195Z\",\n\t\t\t\t\t\t\t\t\"url\": \"https://s3.ap-southeast-1.amazonaws.com/tazapay-test-doc\"\n\n            }\n        ],\n        \"email\": \"\",\n        \"id\": \"ent_d3iv84vs8ud68hm8dba40\",\n        \"metadata\": {},\n        \"name\": \"James Brwon\",\n        \"object\": \"entity\",\n        \"on_behalf_of\": \"\",\n        \"onboarding_package_url\": \"\",\n        \"operating_address\": null,\n        \"pending_documents\": [],\n        \"phone\": {\n            \"calling_code\": \"\",\n            \"number\": \"\"\n        },\n        \"purpose_of_use\": [\n            \"payout\"\n        ],\n        \"reference_id\": \"\",\n        \"registration_address\": {\n            \"city\": \"Bangkok\",\n            \"country\": \"TH\",\n            \"line1\": \"151/1 Richmond Boulevard, Lumpini\",\n            \"line2\": \"\",\n            \"postal_code\": \"10330\",\n            \"state\": \"Pathumwan\"\n        },\n        \"registration_date\": \"\",\n        \"registration_number\": \"\",\n        \"rejected_at\": null,\n        \"relationship\": \"customer\",\n        \"representatives\": [],\n        \"source_of_wealth\": null,\n        \"statement_descriptor\": \"\",\n        \"submit\": true,\n        \"submitted_at\": \"2025-10-01T05:18:15.228732Z\",\n        \"tax_id\": \"\",\n        \"type\": \"individual\",\n        \"vertical\": \"\",\n        \"website\": \"\"\n    }\n}"

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

name · string · required

Name of the entity

type · enum<string> · required

Type of the entity

Available options: sole_proprietorship, company, non_profit, government_entity, individual

email · string

Email of the entity

description · string

A short description of the business

registration_address · object

Registration Address

Show child attributes

operating_address · object

Operating Address

Show child attributes

phone · object

Entity Phone

Show child attributes

tax_id · string

Tax ID of the entity

vertical · string

Industry Vertical

website · string

Entity website

registration_number · string

Business Registration Number

registration_date · string

Business Registration Date, Format DD-MM-YYYY

submit · boolean

true or false, default is false

statement_descriptor · string

Statement Descriptor for the entity

representatives · object[]

Representative Details

Show child attributes

individual · object

Individual Details

Show child attributes

documents · object[]

Documents for the entity

Show child attributes

reference_id · string

Merchant's internal reference ID for the entity

metadata · string<json>

Set of key-value pairs to attach to the entity

relationship · enum<string>

The entity's relationship with you

Available options: customer, vendor, fourth_party, other

purpose_of_use · string[]

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"]

onboarding_package_url · string

Link to the complete onboarding package for the entity

on_behalf_of · string

ID of the entity this entity is created on behalf of

Response

200

application/json

200

status · string

Indicates the result of the API call.

Example:

"success"

message · string

Optional message providing context or additional information about the response. Can be empty.

Example:

""

data · object

Details of the entity or KYB record returned in the response.

Show child attributes