Skip to main content
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>",
  "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>",
      "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>",
      "employment_status": "employed"
    },
    "source_of_funds": {
      "primary_source": "salary",
      "description": "<string>"
    },
    "employment_details": {
      "employer_name": "<string>",
      "designation": "<string>"
    }
  },
  "transaction_profile": {
    "monthly_expected_transactions_value": 123,
    "monthly_expected_transaction_volume": 123,
    "expected_transaction_countries": [
      "<string>"
    ],
    "expected_transaction_currencies": [
      "<string>"
    ],
    "customer_risk": "low"
  },
  "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>"
}
'
{
  "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

​
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

Address details

​
operating_address
object

Address details

​
phone
object

Phone contact details

​
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

​
individual
object

Individual Details

​
transaction_profile
object

Expected transaction profile of the entity

​
documents
object[]

Documents for the entity

​
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

​
status
string

Indicates the result of the API call.

​
message
string

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

​
data
object

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