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

# Create Entity

> Create a sub-entity for your account



## OpenAPI

````yaml post /v3/entity
openapi: 3.1.0
info:
  title: sandbox
  version: '3'
servers:
  - url: https://service-sandbox.tazapay.com
security:
  - sec0: []
paths:
  /v3/entity:
    post:
      summary: Create Entity
      description: Create a sub-entity for your account
      operationId: create-entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - type
              properties:
                name:
                  type: string
                  description: Name of the entity
                type:
                  type: string
                  description: Type of the entity
                  enum:
                    - sole_proprietorship
                    - company
                    - non_profit
                    - government_entity
                    - individual
                email:
                  type: string
                  description: Email of the entity
                description:
                  type: string
                  description: A short description of the business
                registration_address:
                  $ref: '#/components/schemas/Address'
                operating_address:
                  $ref: '#/components/schemas/Address'
                phone:
                  $ref: '#/components/schemas/Phone'
                tax_id:
                  type: string
                  description: Tax ID of the entity
                vertical:
                  type: string
                  description: Industry Vertical
                website:
                  type: string
                  description: Entity website
                registration_number:
                  type: string
                  description: Business Registration Number
                registration_date:
                  type: string
                  description: Business Registration Date, Format DD-MM-YYYY
                submit:
                  type: boolean
                  description: true or false, default is false
                statement_descriptor:
                  type: string
                  description: Statement Descriptor for the entity
                representatives:
                  type: array
                  description: Representative Details
                  items:
                    properties:
                      first_name:
                        type: string
                        description: Representative first name
                      last_name:
                        type: string
                        description: Representative last name
                      date_of_birth:
                        type: string
                        description: >-
                          Date of birth of the representative, in format
                          "DD-MM-YYYY"
                      address:
                        $ref: '#/components/schemas/Address'
                      nationality:
                        type: string
                        description: Two-letter country code, in ISO format
                      phone:
                        $ref: '#/components/schemas/Phone'
                      ownership_percentage:
                        type: number
                        description: Ownership percent, two digits after decimal is allowed
                        format: double
                      roles:
                        type: array
                        description: >-
                          Representative's role. Can be one or more than one of
                          these: 'director', 'shareholder', 'beneficial_owner',
                          'authorised_signatory', 'authorised_representative',
                          or 'other'
                        default: []
                        items:
                          type: string
                      documents:
                        type: array
                        description: Documents for the representatives
                        items:
                          properties:
                            type:
                              type: string
                              description: Type of document
                              enum:
                                - proof_of_identity
                                - proof_of_address
                                - registration_documents
                                - article_of_incorporation
                                - shareholder_registry
                                - identity
                                - address
                                - other
                            sub_type:
                              type: string
                              description: Sub Type of the document
                              enum:
                                - drivers_license
                                - national_id
                                - passport
                                - other
                                - driving_license
                            tag:
                              type: string
                              description: Document type characteristics
                              enum:
                                - AddressProofDoc
                                - identityProofTypeFrontDoc
                                - identityProofTypeBackDoc
                                - additionalDocs
                            description:
                              type: string
                              description: A short description of the document submitted
                            file_name:
                              type: string
                              description: Name of the file uploaded
                            url:
                              type: string
                              description: Dynamically downloadable URL
                          required:
                            - type
                            - sub_type
                            - tag
                            - description
                            - file_name
                            - url
                          type: object
                    required:
                      - first_name
                      - date_of_birth
                      - nationality
                      - ownership_percentage
                      - roles
                    type: object
                individual:
                  type: object
                  description: Individual Details
                  properties:
                    national_identification_number:
                      type: object
                      description: National identification details
                      properties:
                        type:
                          type: string
                          description: Type of identification document
                          enum:
                            - 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
                        number:
                          type: string
                          description: Identification document number
                        issuer:
                          type: object
                          description: Issuing authority details
                          properties:
                            country:
                              type: string
                              description: >-
                                ISO 3166-1 alpha-2 country code of the issuing
                                country
                            state:
                              type: string
                              description: State of the issuing authority (if applicable)
                        expiration:
                          type: string
                          description: >-
                            Expiration date of the identification document
                            (YYYY-MM-DD)
                        country_of_citizenship:
                          type: string
                          description: >-
                            ISO 3166-1 alpha-2 country code of the individual's
                            citizenship
                    date_of_birth:
                      type: string
                      description: Date of Birth in ISO format (YYYY-MM-DD)
                    nationality:
                      type: string
                      description: Two-letter country code (ISO 3166-1 alpha-2)
                    profession:
                      type: object
                      description: Occupation details of the individual
                      properties:
                        occupation:
                          type: string
                          description: >-
                            Occupation title. Required if isco_code is not
                            provided. Max 100 characters.
                          maxLength: 100
                        isco_code:
                          type: string
                          description: >-
                            4-digit ISCO occupation code. Required if occupation
                            is not provided.
                          minLength: 4
                          maxLength: 4
                        industry:
                          type: string
                          description: Industry sector. Max 100 characters.
                          maxLength: 100
                        employment_status:
                          type: string
                          description: Employment status of the individual
                          enum:
                            - employed
                            - self_employed
                            - unemployed
                            - student
                            - retired
                            - homemaker
                            - other
                    source_of_funds:
                      type: object
                      description: Source of funds information
                      properties:
                        primary_source:
                          type: string
                          description: Primary source of funds
                          enum:
                            - salary
                            - business_income
                            - investment_income
                            - inheritance
                            - savings
                            - gift
                            - pension
                            - rental_income
                            - sale_of_assets
                            - loan
                            - scholarship
                            - commission
                            - royalty
                            - other
                        description:
                          type: string
                          description: >-
                            Description of source of funds. Required when
                            primary_source is "other". Max 500 characters.
                          maxLength: 500
                    employment_details:
                      type: object
                      description: Employment details of the individual
                      properties:
                        employer_name:
                          type: string
                          description: Name of the employer. Max 200 characters.
                          maxLength: 200
                        designation:
                          type: string
                          description: Job title or designation. Max 100 characters.
                          maxLength: 100
                      required:
                        - employer_name
                        - designation
                transaction_profile:
                  type: object
                  description: Expected transaction profile of the entity
                  properties:
                    monthly_expected_transactions_value:
                      type: integer
                      format: int64
                      description: >-
                        Expected total value of transactions per month (in
                        smallest currency unit)
                    monthly_expected_transaction_volume:
                      type: integer
                      format: int64
                      description: Expected number of transactions per month
                    expected_transaction_countries:
                      type: array
                      description: >-
                        List of ISO 3166-1 alpha-2 country codes for expected
                        transaction countries
                      items:
                        type: string
                    expected_transaction_currencies:
                      type: array
                      description: >-
                        List of ISO 4217 currency codes for expected transaction
                        currencies
                      items:
                        type: string
                    customer_risk:
                      type: string
                      description: Risk classification of the customer
                      enum:
                        - low
                        - medium
                        - high
                documents:
                  type: array
                  description: Documents for the entity
                  items:
                    properties:
                      type:
                        type: string
                        description: Type of the document
                        enum:
                          - proof_of_identity
                          - proof_of_address
                          - registration_documents
                          - article_of_incorporation
                          - shareholder_registry
                          - identity
                          - business
                          - other
                          - address
                          - source_of_wealth
                          - person
                      sub_type:
                        type: string
                        description: Subtype of the document
                        enum:
                          - drivers_license
                          - national_id
                          - passport
                          - other
                          - driving_license
                      tag:
                        type: string
                        description: Additonal description about the type
                        enum:
                          - registrationProofDoc
                          - AddressProofDoc
                          - beneficialOwnershipDoc
                          - bankStatementProofDoc
                          - previousCardStatementProofDoc
                          - sampleInvoicesDoc
                          - additionalDocs
                      file_name:
                        type: string
                        description: Name of the file
                      description:
                        type: string
                        description: A short description about the document uploaded
                      url:
                        type: string
                        description: Dynamically downloadable URL
                    required:
                      - type
                      - sub_type
                      - tag
                      - file_name
                      - description
                      - url
                    type: object
                reference_id:
                  type: string
                  description: Merchant's internal reference ID for the entity
                metadata:
                  type: string
                  description: Set of key-value pairs to attach to the entity
                  format: json
                relationship:
                  type: string
                  description: The entity's relationship with you
                  enum:
                    - customer
                    - vendor
                    - fourth_party
                    - other
                purpose_of_use:
                  type: array
                  description: >-
                    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"]`
                  items:
                    type: string
                onboarding_package_url:
                  type: string
                  description: Link to the complete onboarding package for the entity
                on_behalf_of:
                  type: string
                  description: ID of the entity this entity is created on behalf of
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    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: ''
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Indicates the result of the API call.
                  message:
                    type: string
                    description: >-
                      Optional message providing context or additional
                      information about the response. Can be empty.
                  data:
                    type: object
                    description: >-
                      Details of the entity or KYB record returned in the
                      response.
                    properties:
                      approval_status:
                        type: string
                        description: Current approval status of the entity record.
                      approval_status_description:
                        type: string
                        description: >-
                          Additional description or remarks regarding the
                          approval status.
                      approved_at:
                        type: string
                        description: >-
                          Timestamp when the entity was approved (ISO 8601
                          format). Can be null if not yet approved.
                      created_at:
                        type: string
                        description: >-
                          Timestamp when the entity record was created (ISO 8601
                          format).
                      description:
                        type: string
                        description: >-
                          Description or additional information about the
                          entity.
                      documents:
                        type: array
                        description: >-
                          List of documents associated with this entity, such as
                          proof of address or identity.
                        items:
                          type: object
                          properties:
                            description:
                              type: string
                            document_id:
                              type: string
                            file_name:
                              type: string
                            sub_type:
                              type: string
                            tag:
                              type: string
                            type:
                              type: string
                            updated_at:
                              type: string
                            url:
                              type: string
                      email:
                        type: string
                        description: >-
                          Email address associated with the entity. May be
                          empty.
                      id:
                        type: string
                        description: Unique identifier for the entity record.
                      metadata:
                        $ref: '#/components/schemas/Metadata'
                      name:
                        type: string
                        description: Name of the entity or individual.
                      object:
                        type: string
                      on_behalf_of:
                        type: string
                        description: >-
                          Identifier of another entity on whose behalf this
                          record is created, if applicable.
                      onboarding_package_url:
                        type: string
                        description: >-
                          Link to the onboarding package for this entity. May be
                          empty.
                      operating_address:
                        type: string
                        description: >-
                          Operating address details for the entity. May be null
                          or empty if not provided.
                      pending_documents:
                        type: array
                        description: List of documents pending submission or verification.
                        items:
                          type: object
                      phone:
                        $ref: '#/components/schemas/Phone'
                      purpose_of_use:
                        type: array
                        description: List of purposes for which the entity account is used.
                        items:
                          type: string
                        example:
                          - payout
                      reference_id:
                        type: string
                        description: External reference identifier linked to this entity.
                      registration_address:
                        $ref: '#/components/schemas/Address'
                      registration_date:
                        type: string
                        description: >-
                          Date of business registration or incorporation. May be
                          empty.
                      registration_number:
                        type: string
                        description: Official registration number of the entity.
                      rejected_at:
                        type: string
                        description: >-
                          Timestamp when the entity was rejected, if applicable.
                          May be null or empty.
                      relationship:
                        type: string
                        description: >-
                          Defines the relationship type of this entity (e.g.,
                          customer, partner).
                      representatives:
                        type: array
                        description: >-
                          List of authorized representatives associated with the
                          entity, such as directors, beneficial owners, or
                          shareholders.
                        items:
                          type: object
                          properties:
                            person_id:
                              type: string
                              description: Unique identifier for the representative.
                            first_name:
                              type: string
                              description: The first name of the representative.
                            last_name:
                              type: string
                              description: The last name of the representative.
                            date_of_birth:
                              type: string
                              description: Date of birth of the representative (ISO 8601).
                            address:
                              $ref: '#/components/schemas/Address'
                            nationality:
                              type: string
                              description: Two-letter ISO country code for nationality.
                            phone:
                              $ref: '#/components/schemas/Phone'
                            ownership_percentage:
                              type: number
                              description: >-
                                The ownership percentage held by this
                                representative in the entity.
                            roles:
                              type: array
                              description: >-
                                Roles or designations of the representative
                                within the entity.
                              items:
                                type: string
                            documents:
                              type: array
                              description: >-
                                List of documents submitted for this
                                representative.
                              items:
                                type: object
                                properties:
                                  description:
                                    type: string
                                  document_id:
                                    type: string
                                  file_name:
                                    type: string
                                  sub_type:
                                    type: string
                                  tag:
                                    type: string
                                  type:
                                    type: string
                                  updated_at:
                                    type: string
                                  url:
                                    type: string
                      source_of_wealth:
                        type: string
                        description: >-
                          Details of the entity’s source of wealth, if
                          applicable. May be empty.
                      statement_descriptor:
                        type: string
                        description: >-
                          Custom statement descriptor for this entity’s
                          transactions.
                      submit:
                        type: boolean
                        description: >-
                          Indicates whether the KYB submission has been
                          completed.
                      submitted_at:
                        type: string
                        description: Timestamp when the entity submission was made.
                      tax_id:
                        type: string
                        description: Tax identification number of the entity.
                      type:
                        type: string
                        description: Type of entity (e.g., individual, business).
                      vertical:
                        type: string
                        description: Industry vertical of the entity, if specified.
                      website:
                        type: string
                        description: Website URL of the entity.
        '400':
          description: Bad Request
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
components:
  schemas:
    Address:
      type: object
      description: Address details
      properties:
        line1:
          type: string
          description: Address Line 1
        line2:
          type: string
          description: Address Line 2
        city:
          type: string
          description: Address city
        state:
          type: string
          description: Address state
        country:
          type: string
          description: Address country (ISO 3166-1 alpha-2 country code)
        postal_code:
          type: string
          description: Postal Code
    Phone:
      type: object
      description: Phone contact details
      properties:
        calling_code:
          type: string
          description: >-
            Calling country code (for example, '1' for United States, '91' for
            India)
        number:
          type: string
          description: Phone Number
    Metadata:
      type: object
      description: Custom metadata key-value pairs attached to the object
      additionalProperties:
        type: string
      nullable: true
    ErrorResponse:
      type: object
      description: Standard error response structure
      properties:
        status:
          type: string
          enum:
            - error
          description: Always 'error' for error responses
        message:
          type: string
          description: High-level error message
        errors:
          type: array
          description: Array of detailed error objects
          items:
            type: object
            properties:
              code:
                type: integer
                description: Specific error code
              message:
                type: string
                description: Detailed error message
              remarks:
                type: string
                description: Additional context or suggestions for resolution
  securitySchemes:
    sec0:
      type: http
      scheme: basic

````