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

# Listar entidades

Retorna uma lista paginada das suas entidades. Entidades encerradas são excluídas, a menos que includeClosed=true.

* Valores de enum inválidos nos filtros retornam 400 VALIDATION\_ERROR.
* A filtragem por nome não está disponível.

Erros usam `application/problem+json` com um `code` estável. Catálogo completo: [Status de Entidades e Códigos de Erro](https://docs.localpayment.com/pt-br/reference/entity-statuses-and-error-codes.md).


## OpenAPI

````yaml openapi/pt-br/localpayment.json GET /api/entity/v1/entities
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/entity/v1/entities:
    get:
      summary: Listar entidades
      operationId: list-entities
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token). Sua conta
            de comerciante e o usuário que realiza a ação são identificados a
            partir dele.
          required: true
          schema:
            type: string
            examples:
              - Bearer <your_access_token>
        - name: X-Correlation-ID
          in: header
          description: >-
            Identificador de rastreamento (UUID). Exibido na resposta; gerado
            pelo Localpayment se ausente.
          required: false
          schema:
            type: string
            examples:
              - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
        - name: type
          in: query
          description: PESSOA FÍSICA ou EMPRESA.
          required: false
          schema:
            type: string
            enum:
              - INDIVIDUAL
              - COMPANY
        - name: status
          in: query
          description: Status da entidade.
          required: false
          schema:
            type: string
            enum:
              - PENDING_KYC
              - IN_REVIEW
              - ACTIVE
              - REJECTED
              - BLOCKED
              - CLOSED
        - name: externalId
          in: query
          description: Correspondência exata com seu identificador.
          required: false
          schema:
            type: string
        - name: documentId
          in: query
          description: Número do documento declarado (correspondência exata).
          required: false
          schema:
            type: string
        - name: documentationStatus
          in: query
          description: NO_FILES, PARTIAL, COMPLETE.
          required: false
          schema:
            type: string
            enum:
              - NO_FILES
              - PARTIAL
              - COMPLETE
        - name: createdFrom
          in: query
          description: ISO 8601, inclusivo.
          required: false
          schema:
            type: string
            format: date-time
        - name: createdTo
          in: query
          description: ISO 8601, inclusivo.
          required: false
          schema:
            type: string
            format: date-time
        - name: includeClosed
          in: query
          description: 'Incluir entidades FECHADAS. Padrão: falso.'
          required: false
          schema:
            type: boolean
        - name: pageIndex
          in: query
          description: 'Página com base zero. Valor padrão: 0.'
          required: false
          schema:
            type: integer
        - name: pageSize
          in: query
          description: Valor padrão 20, máximo 200 (valores maiores são limitados).
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                type: object
                properties:
                  pageIndex:
                    type: integer
                    examples:
                      - 0
                    description: Dados de paginação.
                  pageSize:
                    type: integer
                    examples:
                      - 20
                    description: Dados de paginação.
                  totalElements:
                    type: integer
                    examples:
                      - 1
                    description: Dados de paginação.
                  totalPages:
                    type: integer
                    examples:
                      - 1
                    description: Dados de paginação.
                  content:
                    type: array
                    items:
                      type: object
                      properties:
                        internalId:
                          type: string
                          examples:
                            - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                          format: uuid
                        externalId:
                          type: string
                          examples:
                            - 550e8400-e29b-41d4-a716-446655440000
                        type:
                          type: string
                          examples:
                            - INDIVIDUAL
                          enum:
                            - INDIVIDUAL
                            - COMPANY
                        status:
                          type: string
                          examples:
                            - PENDING_KYC
                          enum:
                            - PENDING_KYC
                            - IN_REVIEW
                            - ACTIVE
                            - REJECTED
                            - BLOCKED
                            - CLOSED
                          description: >-
                            Status da entidade. Consulte Status da entidade e
                            Códigos de erro.
                        name:
                          type: string
                          examples:
                            - Jane
                        lastname:
                          type: string
                          examples:
                            - Doe
                        birthdate:
                          type: string
                          examples:
                            - '1990-01-15'
                          format: date
                        gender:
                          type:
                            - string
                            - 'null'
                        nationality:
                          type: string
                          examples:
                            - BRA
                        birthCountry:
                          type: string
                          examples:
                            - BRA
                        residenceCountry:
                          type: string
                          examples:
                            - BRA
                        occupation:
                          type:
                            - string
                            - 'null'
                        isPep:
                          type: boolean
                          examples:
                            - false
                        incorporationDate:
                          type:
                            - string
                            - 'null'
                          format: date
                        incorporationCountry:
                          type:
                            - string
                            - 'null'
                        website:
                          type:
                            - string
                            - 'null'
                        legalRepresentativeName:
                          type:
                            - string
                            - 'null'
                        email:
                          type: string
                          examples:
                            - jane.doe@example.com
                        phone:
                          type: object
                          properties:
                            countryCode:
                              type: string
                              examples:
                                - '55'
                            areaCode:
                              type: string
                              examples:
                                - '11'
                            number:
                              type: string
                              examples:
                                - '999990001'
                        address:
                          type: object
                          properties:
                            street:
                              type: string
                              examples:
                                - Rua Exemplo
                            city:
                              type: string
                              examples:
                                - São Paulo
                            state:
                              type: string
                              examples:
                                - SP
                            zipCode:
                              type: string
                              examples:
                                - 01310-100
                            number:
                              type: string
                              examples:
                                - '123'
                            comment:
                              type:
                                - string
                                - 'null'
                            country:
                              type: string
                              examples:
                                - BRA
                            line2:
                              type:
                                - string
                                - 'null'
                            line3:
                              type:
                                - string
                                - 'null'
                        attributes:
                          type:
                            - object
                            - 'null'
                        documentationStatus:
                          type: string
                          examples:
                            - NO_FILES
                          enum:
                            - NO_FILES
                            - PARTIAL
                            - COMPLETE
                        document:
                          type: object
                          properties:
                            documentId:
                              type: string
                              examples:
                                - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                              format: uuid
                            entityId:
                              type: string
                              examples:
                                - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                              format: uuid
                            type:
                              type: string
                              examples:
                                - CPF
                              enum:
                                - DNI
                                - NATIONAL_ID
                                - DRIVER_LICENSE
                                - PASSPORT
                                - CE
                                - CC
                                - CUIT
                                - CUIL
                                - RFC
                                - CURP
                                - CPF
                                - CNPJ
                                - RUC
                                - NIT
                                - TAX_ID
                                - ARTICLES_OF_INCORPORATION
                                - POWER_OF_ATTORNEY
                                - TAX_CERTIFICATE
                                - PAYSLIP
                                - ARCA_REGISTRATION
                                - PROOF_OF_ADDRESS
                                - PROOF_OF_FUNDS
                                - OTHER
                            id:
                              type: string
                              examples:
                                - '00000000000'
                            issuingCountry:
                              type: string
                              examples:
                                - BRA
                            issueDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            expirationDate:
                              type:
                                - string
                                - 'null'
                              format: date
                            isPrimary:
                              type: boolean
                              examples:
                                - true
                            status:
                              type: string
                              examples:
                                - PENDING
                              enum:
                                - PENDING
                                - VERIFIED
                                - REJECTED
                                - EXPIRED
                              description: >-
                                Status derivado do documento: EXPIRED se a
                                expirationDate tiver passado, REJECTED se alguma
                                prova ativa for rejeitada, VERIFIED se todas as
                                provas ativas forem aprovadas, caso contrário
                                PENDING.
                            metadata:
                              type:
                                - object
                                - 'null'
                            proofs:
                              type: array
                              items:
                                type: object
                            createdAt:
                              type: string
                              examples:
                                - '2024-01-15T17:03:10Z'
                              format: date-time
                            updatedAt:
                              type: string
                              examples:
                                - '2024-01-15T17:03:10Z'
                              format: date-time
                        documents:
                          type: array
                          items:
                            type: object
                        version:
                          type: integer
                          examples:
                            - 0
                        createdAt:
                          type: string
                          examples:
                            - '2024-01-15T17:03:10Z'
                          format: date-time
                        updatedAt:
                          type: string
                          examples:
                            - '2024-01-15T17:03:10Z'
                          format: date-time
                        customFieldSchemaVersion:
                          type:
                            - integer
                            - 'null'
                    description: >-
                      Entidades, com o mesmo formato de Obter uma Entidade.
                      uboCount e uboRequirementMet são nulos nas listagens.
              examples:
                Example 1:
                  value:
                    pageIndex: 0
                    pageSize: 20
                    totalElements: 1
                    totalPages: 1
                    content:
                      - internalId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                        externalId: 550e8400-e29b-41d4-a716-446655440000
                        type: INDIVIDUAL
                        status: PENDING_KYC
                        name: Jane
                        lastname: Doe
                        birthdate: '1990-01-15'
                        gender: null
                        nationality: BRA
                        birthCountry: BRA
                        residenceCountry: BRA
                        occupation: null
                        isPep: false
                        incorporationDate: null
                        incorporationCountry: null
                        website: null
                        legalRepresentativeName: null
                        email: jane.doe@example.com
                        phone:
                          countryCode: '55'
                          areaCode: '11'
                          number: '999990001'
                        address:
                          street: Rua Exemplo
                          city: São Paulo
                          state: SP
                          zipCode: 01310-100
                          number: '123'
                          comment: null
                          country: BRA
                          line2: null
                          line3: null
                        attributes: null
                        documentationStatus: NO_FILES
                        document:
                          documentId: 2e16d844-4fa9-4295-9a21-83ec32ef241a
                          entityId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                          type: CPF
                          id: '00000000000'
                          issuingCountry: BRA
                          issueDate: null
                          expirationDate: null
                          isPrimary: true
                          status: PENDING
                          metadata: null
                          proofs: []
                          createdAt: '2024-01-15T17:03:10Z'
                          updatedAt: '2024-01-15T17:03:10Z'
                        documents: []
                        version: 0
                        createdAt: '2024-01-15T17:03:10Z'
                        updatedAt: '2024-01-15T17:03:10Z'
                        customFieldSchemaVersion: null
        '400':
          description: >-
            Solicitação inválida. VALIDATION_ERROR: Um campo, cabeçalho, caminho
            ou parâmetro de consulta está ausente, é desconhecido ou inválido.
            details[] lista o campo e o problema.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - VALIDATION_ERROR:
                  value:
                    type: about:blank
                    title: Validation error
                    status: 400
                    detail: >-
                      A field, header, path or query parameter is missing,
                      unknown or invalid. details[] lists field and issue.
                    instance: /api/entity/v1/entities
                    code: VALIDATION_ERROR
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details:
                      - field: externalId
                        issue: REQUIRED
        '401':
          description: 'Não autorizado. UNAUTHORIZED: Token de acesso ausente ou inválido.'
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNAUTHORIZED:
                  value:
                    type: about:blank
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid access token.
                    instance: /api/entity/v1/entities
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
      security:
        - token: []
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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