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

Tazapay is introducing five new document type values for entity creation and update — proof_of_identity, proof_of_address, registration_documents, article_of_incorporation, and shareholder_registry. These purpose-specific types extend the broader legacy types (e.g. identity, address, business) in the full-KYC entity flow and are recommended for full-verification business and individual entities going forward. The legacy types are preserved for backward compatibility.

What Changed

New Extended Document Types

Five new values have been added to the type field accepted on entity and representative documents. These are the recommended types going forward for full-KYC entity flows:
TypePurpose
proof_of_identityGovernment-issued identity documents (passport, national ID, etc.)
proof_of_addressResidential or operating address proof (utility bill, bank statement, etc.)
registration_documentsBusiness registration certificates and incorporation proofs
article_of_incorporationArticles of incorporation for corporate entities
shareholder_registryShareholder/beneficial ownership structure documentation
Full-verification entity submissions should include documents of the following types to ensure comprehensive verification coverage.

Business Entities (Full KYC)

Entity-level documents (attached to the business entity itself):
  • registration_documents — Business registration proof
  • proof_of_address — Operating address proof
  • shareholder_registry — Business shareholding structure
Representative documents (attached to each representative/UBO):
  • proof_of_identity — Any government-issued identity proof (passport, national ID, driver’s license, etc.)
  • proof_of_address — Address proof

Individual Entities (Full KYC)

Entity-level documents (attached to the individual):
  • proof_of_identity — Any government-issued identity proof (passport, national ID, driver’s license, etc.)
  • proof_of_address — Recent utility bill or equivalent

Affected Endpoints

  • POST /v3/entity — document type and sub_type enum extended
  • PUT /v3/entity/{id} — document type and sub_type enum extended

Impact by Submission Method

Dashboard Submissions

Entities submitted via the Tazapay dashboard are not affected. The dashboard UI will continue to work with existing legacy entities and validation logic remains unchanged.

New Entity Submissions

API merchants submitting full-KYC entities should consider updating their integrations to include the new extended document types. When creating or updating entities via the API with full-KYC verification flow:
  • Business entities should include: registration_documents, proof_of_address, shareholder_registry
  • Individual entities should include: proof_of_identity, proof_of_address
Requests with legacy document types will continue to be accepted, but using the extended types is recommended for improved clarity and future compatibility.

Legacy Entity Updates

API merchants with existing full-KYC entities in the system may consider updating them to align with the new extended document type recommendations. Legacy entities lacking the new document types can be updated via the PUT /v3/entity/{id} endpoint to add:
  • Business entities — Entity-level documents: registration_documents, proof_of_address, shareholder_registry
    • Representatives — Representative-level documents: proof_of_identity, proof_of_address (for each representative/UBO)
  • Individual entities — Entity-level documents: proof_of_identity, proof_of_address
This ensures API-submitted entities follow current best practices going forward. Existing entities will not be automatically updated — merchants may update both entity-level documents and all associated representative documents for business entities at their discretion.

Compatibility

These extended document types are recommended for new entity creation via API. Going forward, the newly introduced document types are recommended based on the entity type. The legacy types (identity, business, address, etc.) continue to be accepted, and entities can contain either legacy types or the extended types. Existing (legacy) entities already in the system are not affected by this change — the extended types serve as optional guidance for future submissions and entity updates.
  1. Entity API Reference