> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trio.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# List entities

> List entities by org ID



## OpenAPI

````yaml v2/api-reference/openapi.json GET /v2/entities
openapi: 3.0.0
info:
  title: Trio API v2
  version: 2026-10-19.v2
servers:
  - url: https://api.sandbox.trio.com.br
    variables: {}
  - url: https://api.qa.trio.com.br
    variables: {}
  - url: https://api.trio.com.br
    variables: {}
security: []
tags: []
paths:
  /v2/entities:
    parameters:
      - description: >-
          Version of the v2 contract the client is written against. Each
          breaking change publishes a new version.
        example: 2026-10-19.v2
        in: header
        name: Trio-Version
        required: true
        schema:
          enum:
            - 2026-10-19.v2
          type: string
          x-struct: null
          x-validate: null
      - description: >-
          ID of another org to act on instead of the API key's own org. The
          key's org must have been granted access to it, and the request is
          refused with 403 FORBIDDEN otherwise. When that access or the API key
          is read-only, only GET and HEAD requests may carry it. When the target
          org requires mTLS, so does the request. Leave it out to act on the
          key's own org.
        in: header
        name: Trio-Target-Org-Id
        required: false
        schema:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
    get:
      tags:
        - Entities
      summary: List entities
      description: List entities by org ID
      operationId: TrioFoundationWeb.V2.EntityController.index
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_entity_list_response'
          description: Entities
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Malformed request: a body that is not valid JSON
            (MALFORMED_REQUEST), or a Trio-Version header that is missing or not
            the current one (INVALID_TRIO_VERSION).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: Missing or invalid API key credentials (INVALID_CREDENTIALS).
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            The API key may not do this (FORBIDDEN): for instance
            Trio-Target-Org-Id names an org it has no access to, or writes
            through a read-only access.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of
            the rule the request breaks). A request outside the operation's
            schema lists the offending fields in `errors`.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            A service needed to answer is unavailable
            (TRIO_SERVICE_UNAVAILABLE).
      callbacks: {}
      security:
        - authorization: []
components:
  schemas:
    V2_entity_list_response:
      description: A list of entities from TrioCore's compliance
      example:
        data:
          - addresses:
              - address_additional_details: Apto 42
                address_line: Rua das Flores
                address_number: '123'
                city_name: Curitiba
                district: Centro
                zip_code: '80000000'
            business_infos:
              annual_revenue:
                amount: 500000
                currency: BRL
              average_ticket:
                amount: 10000000
                currency: BRL
              company_activity: '6201501'
              company_secondary_activity:
                - '6202300'
            contact:
              email: entity@gmail.com
              phone_number: '41999999999'
            id: 01a163ec-8dd5-8386-b33a-70a4713ecdb2
            inserted_at: '2026-10-22T14:03:29.651178Z'
            legal_name: Entity Test LLC
            status: approved
            tax_number: DN0O5N510HG833
            updated_at: '2026-10-22T14:03:29.651187Z'
      properties:
        data:
          items:
            $ref: '#/components/schemas/V2_entity'
          type: array
          x-struct: null
          x-validate: null
      title: V2 entity list response
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.ListResponse
      x-validate: null
    V2_error:
      example:
        error:
          error_code: INVALID_PARAMETER
          error_message: 'Invalid parameters: /amount: Invalid integer. Got: string'
          errors:
            - field: /amount
              message: 'Invalid integer. Got: string'
      properties:
        error:
          properties:
            error_code:
              description: >-
                Stable UPPER_SNAKE identifier of the error, for programs and
                logs. Branch on this, not on the message.
              type: string
              x-struct: null
              x-validate: null
            error_message:
              description: Human readable explanation of the error.
              type: string
              x-struct: null
              x-validate: null
            errors:
              description: >-
                Only on INVALID_PARAMETER for a request outside the operation's
                schema: one entry per offending field.
              items:
                properties:
                  field:
                    description: JSON pointer to the field, e.g. /amount.
                    type: string
                    x-struct: null
                    x-validate: null
                  message:
                    description: What is wrong with it.
                    type: string
                    x-struct: null
                    x-validate: null
                required:
                  - field
                  - message
                type: object
                x-struct: null
                x-validate: null
              type: array
              x-struct: null
              x-validate: null
          required:
            - error_code
            - error_message
          type: object
          x-struct: null
          x-validate: null
      required:
        - error
      title: V2 error
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error
      x-validate: null
    V2_entity:
      description: An entity for compliance
      example:
        addresses:
          - address_additional_details: Apto 42
            address_line: Rua das Flores
            address_number: '123'
            city_name: Curitiba
            district: Centro
            zip_code: '80000000'
        business_infos:
          annual_revenue:
            amount: 500000
            currency: BRL
          average_ticket:
            amount: 10000000
            currency: BRL
          company_activity: '6201501'
          company_secondary_activity:
            - '6202300'
        contact:
          email: entity@gmail.com
          phone_number: '41999999999'
        id: 01a163ec-8dd5-8386-b33a-70a4713ecdb2
        inserted_at: '2026-10-22T14:03:29.651178Z'
        legal_name: Entity Test LLC
        status: approved
        tax_number: DN0O5N510HG833
        updated_at: '2026-10-22T14:03:29.651187Z'
      properties:
        addresses:
          items:
            $ref: '#/components/schemas/V2_entity_address'
          type: array
          x-struct: null
          x-validate: null
        business_infos:
          $ref: '#/components/schemas/V2_entity_business_information'
        contact:
          $ref: '#/components/schemas/V2_entity_contact'
        id:
          $ref: '#/components/schemas/UUID'
        inserted_at:
          description: Entity inserted at
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        legal_name:
          description: Entity legal name
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        status:
          description: Entity status
          enum:
            - created
            - in_validation
            - in_review
            - approved
            - rejected
            - onhold
            - canceled
          type: string
          x-struct: null
          x-validate: null
        tax_number:
          description: Entity tax number
          type: string
          x-struct: null
          x-validate: null
        updated_at:
          description: Entity updated at
          format: date-time
          type: string
          x-struct: null
          x-validate: null
      title: V2 entity
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityData
      x-validate: null
    V2_entity_address:
      description: Entity address
      example:
        address_additional_details: Apto 42
        address_line: Rua das Flores
        address_number: '123'
        city_name: Curitiba
        district: Centro
        zip_code: '80000000'
      properties:
        address_additional_details:
          description: Additional address details, such as the apartment
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        address_line:
          description: Street
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        address_number:
          description: Street number
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        city_name:
          description: City name
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        district:
          description: District
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        zip_code:
          description: Zip code
          nullable: true
          type: string
          x-struct: null
          x-validate: null
      title: V2 entity address
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityAddressData
      x-validate: null
    V2_entity_business_information:
      description: Entity business information
      example:
        annual_revenue:
          amount: 500000
          currency: BRL
        average_ticket:
          amount: 10000000
          currency: BRL
        company_activity: '6201501'
        company_secondary_activity:
          - '6202300'
      properties:
        annual_revenue:
          $ref: '#/components/schemas/Money'
        average_ticket:
          $ref: '#/components/schemas/Money'
        company_activity:
          description: Entity main activity (CNAE)
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        company_secondary_activity:
          description: Entity secondary activities (CNAE)
          items:
            type: string
            x-struct: null
            x-validate: null
          nullable: true
          type: array
          x-struct: null
          x-validate: null
      title: V2 entity business information
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityBusinessInfosData
      x-validate: null
    V2_entity_contact:
      description: Entity contact information
      example:
        email: entity@gmail.com
        phone_number: '41999999999'
      properties:
        email:
          description: Entity email
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        phone_number:
          description: Entity phone number
          nullable: true
          type: string
          x-struct: null
          x-validate: null
      title: V2 entity contact
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Entity.EntityContactData
      x-validate: null
    UUID:
      description: Unique identifier
      format: uuid
      title: UUID
      type: string
      x-struct: null
      x-validate: null
    Money:
      description: Money
      nullable: true
      properties:
        amount:
          description: Amount of the money
          minimum: 1
          type: integer
          x-struct: null
          x-validate: null
        currency:
          $ref: '#/components/schemas/Currency'
      required:
        - amount
        - currency
      title: Money
      type: object
      x-struct: null
      x-validate: null
    Currency:
      description: Currency
      items:
        enum:
          - BRL
        type: string
        x-struct: null
        x-validate: null
      title: Currency
      type: string
      x-struct: null
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.