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

# Fetch Entity



## OpenAPI

````yaml get /v3/entity/{id}
openapi: 3.1.0
info:
  title: sandbox
  version: '3'
servers:
  - url: https://service-sandbox.tazapay.com
security:
  - sec0: []
paths:
  /v3/entity/{id}:
    get:
      summary: Fetch Entity
      operationId: fetch-entity
      parameters:
        - name: id
          in: path
          description: Tazapay unique ID for the entity
          schema:
            type: string
          required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    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: []
                      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
                      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:
    Metadata:
      type: object
      description: Custom metadata key-value pairs attached to the object
      additionalProperties:
        type: string
      nullable: true
    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
    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
    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

````