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

Path Parameters

​
id
string
required

Tazapay unique ID of the entity

Body

application/json
​
type
enum<string>
required

Type of the entity

Available options:
sole_proprietorship,
company,
non_profit,
government_entity,
individual
​
registration_address
object
required

Entity Registration Address

​
operating_address
object
required

Entity operating address

​
registration_number
string
required

Business Registration Number

​
representatives
object[]
required

Representative Details

​
documents
object[]
required

Documents for the entity

​
relationship
enum<string>
required

The entity's relationship with you

Available options:
customer,
vendor,
fourth_party,
other
​
purpose_of_use
string[]
required

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

​
individual
object

Individual Details -> Required for Entity Type: individual

​
reference_id
string

Merchant's internal reference ID for the entity

​
metadata
string<json>

Set of key-value pairs to attach to the entity

​
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.