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

# 列出实体

返回您的实体的分页列表。除非 includeClosed=true，否则不包括已关闭的实体。

* 筛选条件中的无效枚举值将返回 400 VALIDATION\_ERROR。
* 不支持按名称筛选。

错误使用带有固定 `code` 的 `application/problem+json`。完整目录：[实体状态和错误代码](https://docs.localpayment.com/zh/reference/entity-statuses-and-error-codes.md)。


## OpenAPI

````yaml openapi/zh/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: 列出实体
      operationId: list-entities
      parameters:
        - name: Authorization
          in: header
          description: >-
            用于身份验证的 Bearer
            访问令牌。该令牌可从[获取访问令牌](/zh/reference/get-token)或[刷新访问令牌](/zh/reference/refresh-token)endpoint
            获取。系统将据此识别您的商户账户和执行操作的用户。
          required: true
          schema:
            type: string
            examples:
              - Bearer <your_access_token>
        - name: X-Correlation-ID
          in: header
          description: 跟踪标识符（UUID）。会在响应中原样返回；如未提供，则由 Localpayment 生成。
          required: false
          schema:
            type: string
            examples:
              - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
        - name: type
          in: query
          description: INDIVIDUAL 或 COMPANY。
          required: false
          schema:
            type: string
            enum:
              - INDIVIDUAL
              - COMPANY
        - name: status
          in: query
          description: 实体状态。
          required: false
          schema:
            type: string
            enum:
              - PENDING_KYC
              - IN_REVIEW
              - ACTIVE
              - REJECTED
              - BLOCKED
              - CLOSED
        - name: externalId
          in: query
          description: 与您的标识符完全匹配。
          required: false
          schema:
            type: string
        - name: documentId
          in: query
          description: 任何已申报文件的单据编号（完全匹配）。
          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，包含边界值。
          required: false
          schema:
            type: string
            format: date-time
        - name: createdTo
          in: query
          description: ISO 8601，包含边界值。
          required: false
          schema:
            type: string
            format: date-time
        - name: includeClosed
          in: query
          description: 包含已关闭的实体。默认值为 false。
          required: false
          schema:
            type: boolean
        - name: pageIndex
          in: query
          description: 从零开始的页面。默认值为 0。
          required: false
          schema:
            type: integer
        - name: pageSize
          in: query
          description: 默认值为 20，最大值为 200（大于此值将被限制）。
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: OK。
          content:
            application/json:
              schema:
                type: object
                properties:
                  pageIndex:
                    type: integer
                    examples:
                      - 0
                    description: 分页数据。
                  pageSize:
                    type: integer
                    examples:
                      - 20
                    description: 分页数据。
                  totalElements:
                    type: integer
                    examples:
                      - 1
                    description: 分页数据。
                  totalPages:
                    type: integer
                    examples:
                      - 1
                    description: 分页数据。
                  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: 实体状态。请参阅实体状态和错误代码。
                        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: >-
                                派生的文档状态：如果 expirationDate 已过，则为
                                EXPIRED；如果任何有效证明文件被拒绝，则为
                                REJECTED；如果所有有效证明文件均已批准，则为 VERIFIED；否则为 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: 实体，结构与“获取实体”相同。列表中 uboCount 和 uboRequirementMet 为空。
              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: 错误请求。验证错误：缺少字段、标头、路径或查询参数，或者参数未知或无效。details[] 列出了字段和问题。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    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: 未授权。UNAUTHORIZED：缺少或无效的访问令牌。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    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.