Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt

Use this file to discover all available pages before exploring further.

Release Type: Enhancement

​
Summary

The Entity API has been enhanced with additional fields for individual entities. These changes cover profession details, source of funds, employment information, an expanded national identification number structure, and a transaction profile — providing a richer data model to support compliance and onboarding workflows.

​
What Changed

​
New fields inside individual object

The following fields have been added to the individual object (applicable when type: "individual"):
  • profession (optional)
    • occupation (string) — Required if isco_code is not provided. Max 100 characters.
    • isco_code (string) — 4-digit ISCO occupation code. Required if occupation is not provided.
    • industry (string, optional) — Industry sector. Max 100 characters.
    • employment_status (enum, optional) — Values: employed, self_employed, unemployed, student, retired, homemaker, other
  • source_of_funds (optional)
    • primary_source (enum, mandatory when object is provided) — Values: salary, business_income, investment_income, inheritance, savings, gift, pension, rental_income, sale_of_assets, loan, scholarship, commission, royalty, other
    • description (string) — Required when primary_source is other. Max 500 characters.
  • employment_details (optional)
    • employer_name (string, mandatory) — Max 200 characters.
    • designation (string, mandatory) — Max 100 characters.
  • national_identification_number — expanded Previously supported only type and number. Now includes:
    • issuer (object, optional)
      • country (string) — ISO 3166-1 alpha-2 country code of the issuing country.
      • state (string) — State of the issuing authority.
    • expiration (string, optional) — Expiration date in YYYY-MM-DD format.
    • country_of_citizenship (string, optional) — ISO 3166-1 alpha-2 country code.
    • type enum has been expanded to include: 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

​
New transaction_profile object (parent level)

A new transaction_profile object has been added at the root entity level (not inside individual):
  • monthly_expected_transactions_value (integer, mandatory when object is provided) — Expected total value of transactions per month.
  • monthly_expected_transaction_volume (integer, mandatory when object is provided) — Expected number of transactions per month.
  • expected_transaction_countries (array of strings, mandatory when object is provided) — ISO 3166-1 alpha-2 country codes.
  • expected_transaction_currencies (array of strings, mandatory when object is provided) — ISO 4217 currency codes.
  • customer_risk (enum, mandatory when object is provided) — Values: low, medium, high

​
Validation Rules

  • individual.profession.occupation and individual.profession.isco_code are mutually conditional — at least one must be provided when the profession object is present.
  • individual.source_of_funds.description is required when primary_source is other.
  • individual.source_of_funds.primary_source is salary the employment_details object is required.
  • individual.employment_details.employer_name and individual.employment_details.designation are both required when the employment_details object is present.
  • transaction_profile object is provided — all its fields must be present.

​
Compatibility

  • No breaking changes. All new fields are optional or conditionally required only when their parent object is provided.
  • Existing integrations that do not send these fields will continue to work without modification.

​
Affected endpoints

  • POST /v3/entity — request and response updated
  • GET /v3/entity/{id} — response updated
  • PUT /v3/entity/{id} — request and response updated
  • POST /v3/entity/{id}/submit — request and response updated
  1. Entity API Documentation