Skip to main content

​
Object Parameters

{
  "status": "success",
  "message": "",
  "data": {
      "approval_status": "approved",
      "approval_status_description": "Approved for payouts only",
      "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": [
      {
        "person_id": "psn_d3iv85v58tg9dlpipu3g",
        "first_name": "Msk",
        "last_name": "Msk",
        "date_of_birth": "2119-11-09",
        "address": {
          "line1": "123 Main Street",
          "line2": "Apt 5B",
          "city": "New Delhi",
          "state": "Delhi",
          "postal_code": "110018",
          "country": "IN"
        },
        "nationality": "IN",
        "phone": {
          "calling_code": "91",
          "number": "9876543210"
        },
        "ownership_percentage": 20,
        "roles": ["beneficial_owner"],
        "documents": [
          {
            "description": "Passport front",
            "document_id": "doc_csbm1ta5grahc4olhpe0",
            "file_name": "kyb_doc91055_22October2024_PassportFront.png",
            "sub_type": "passport",
            "tag": "identityProofTypeFrontDoc",
            "type": "identity",
            "updated_at": "2024-10-22T08:23:21.528098Z",
            "url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-onboarding-service-qa/kyb_doc91055_22October2024_PassportFront.png"
          }
			],
      "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": ""
    }
}

​
Object Parameters

FieldTypeDescription
idstringThe unique Tazapay identifier for the entity. Example: ent_d3iv84vs8ud68hm8dba40.
objectstringThe type of object, always "entity".
namestringThe full name of the entity or individual. Example: James Brown.
typeenumThe type of entity. [Values: individual, business].
relationshipstringThe relationship type of the entity with Tazapay. Example: customer.
approval_statusenumThe approval status of the entity. [Values: approved, rejected, pending, resubmitted].
approval_status_descriptionstringDescription of the approval status. Example: Approved for payouts only.
approved_atstringTimestamp when the entity was approved (ISO 8601). Example: 2025-10-09T02:55:52.284767Z.
created_atstringTimestamp when the entity record was created (ISO 8601). Example: 2025-10-08T05:18:11.700575Z.
submitted_atstringTimestamp when the KYB/KYC submission was made (ISO 8601).
submitbooleanIndicates whether the KYB submission has been completed.
descriptionstringAdditional notes or description for the entity.
emailstringThe email address associated with the entity.
phoneobjectPhone details of the entity. See Phone Object.
registration_numberstringThe official business registration number for the entity.
registration_datestringDate of business registration or incorporation (ISO 8601).
registration_addressobjectRegistered address of the entity. See Address Object.
operating_addressobjectOperating address of the entity. May be empty if same as registration address. See Address Object.
tax_idstringThe tax identification number of the entity.
purpose_of_usearrayList of purposes for which the entity is using Tazapay. Example: ["payout"].
source_of_wealthstringInformation on the source of funds or wealth for the entity.
statement_descriptorstringCustom descriptor that appears on the end customer’s statement.
reference_idstringThe merchant’s own reference identifier for the entity.
verticalstringThe industry vertical or business category of the entity.
websitestringThe entity’s website URL. Example: https://example.com.
individualobjectIndividual-specific details. Applicable when type is individual. See Individual Object below.
transaction_profileobjectExpected transaction profile of the entity. See Transaction Profile Object below.
documentsarrayList of submitted documents for verification. See Document Object.
pending_documentsarrayList of pending documents required for completion.
representativesarrayList of authorised representatives of the entity. Check the Representative table below.
metadataobjectCustom key-value metadata attached to the entity.
on_behalf_ofstringAccount ID if the entity was created on behalf of another account.
onboarding_package_urlstringURL to download or view the onboarding package for the entity.
approval_status_descriptionstringAdditional notes about the approval result.
rejected_atstringTimestamp when the entity was rejected, if applicable.
relationshipstringDescribes the relationship of the entity to Tazapay (e.g., customer, partner, vendor).

​
Individual

Applicable when type is individual.
FieldTypeDescription
date_of_birthstringDate of birth in ISO 8601 format (YYYY-MM-DD).
nationalitystringTwo-letter ISO 3166-1 alpha-2 country code for the individual’s nationality.
genderstringGender of the individual. Mandatory when entity country is China (CN). Allowed values: Male, Female.
national_identification_numberobjectNational identification document details. See sub-table below.
professionobjectOccupation details of the individual. See sub-table below.
source_of_fundsobjectSource of funds information. See sub-table below.
employment_detailsobjectEmployment details. See sub-table below.

​
national_identification_number

FieldTypeDescription
typeenumType of identification document. [Values: passport, driving_license, national_id, tax_id, residence_permit, other, asylum_registration_card, consular_id, immigration_status_document, indigenous_card, insurance_card, international_driving_license, municipal_identity_card, national_health_id, postal_identity_card, private_operators_card, professional_qualification_card, proof_of_citizenship, residence_status_document, service_id_card, social_security_card, visa, voter_id, work_permit].
numberstringIdentification document number.
issuerobjectIssuing authority details. Contains country (ISO 3166-1 alpha-2) and state (optional).
issue_datestringIssue date of the identification document in YYYY-MM-DD format (e.g., 2010-01-21). Mandatory when entity country is China (CN).
expirationstringExpiration date of the document in YYYY-MM-DD format.
country_of_citizenshipstringISO 3166-1 alpha-2 country code of the individual’s citizenship.

​
profession

FieldTypeDescription
occupationstringOccupation title. Required if isco_code is not provided. Max 100 characters.
isco_codestring4-digit ISCO occupation code. Required if occupation is not provided.
industrystringIndustry sector. Max 100 characters.
employment_statusenumEmployment status. [Values: employed, self_employed, unemployed, student, retired, homemaker, other].

​
source_of_funds

FieldTypeDescription
primary_sourceenumPrimary source of funds. [Values: salary, business_income, investment_income, inheritance, savings, gift, pension, rental_income, sale_of_assets, loan, scholarship, commission, royalty, other].
descriptionstringDescription of source of funds. Required when primary_source is other. Max 500 characters.

​
employment_details

FieldTypeDescription
employer_namestringName of the employer. Max 200 characters.
designationstringJob title or designation. Max 100 characters.

​
Transaction Profile

FieldTypeDescription
monthly_expected_transactions_valueintegerExpected total value of transactions per month (in smallest currency unit).
monthly_expected_transaction_volumeintegerExpected number of transactions per month.
expected_transaction_countriesarrayList of ISO 3166-1 alpha-2 country codes for expected transaction countries.
expected_transaction_currenciesarrayList of ISO 4217 currency codes for expected transaction currencies.
customer_riskenumRisk classification of the customer. [Values: low, medium, high].

​
Representative

FieldTypeDescription
person_idstringUnique identifier for the representative. Example: psn_d3iv85v58tg9dlpipu3g.
first_namestringThe first name of the representative.
last_namestringThe last name of the representative.
date_of_birthstringDate of birth of the representative in ISO 8601 format.
addressobjectThe address of the representative. See Address Object.
nationalitystringTwo-letter ISO country code indicating the representative’s nationality.
phoneobjectThe phone details of the representative. See Phone Object.
ownership_percentagenumberThe ownership percentage the representative holds in the entity.
rolesarrayList of roles or capacities the representative serves in. Example: ["director", "beneficial_owner"].
documentsarrayList of documents submitted for this representative. See Document Object.