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

# 列出文件

列出实体已申报的文件以及整体 documentationStatus。

* 已删除的文件不会列出。

错误使用带有稳定 `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/{entityId}/documents
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/{entityId}/documents:
    get:
      summary: 列出文件
      operationId: list-entity-documents
      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: entityId
          in: path
          description: 实体的 internalId。
          required: true
          schema:
            type: string
            examples:
              - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
            format: uuid
      responses:
        '200':
          description: OK。
          content:
            application/json:
              schema:
                type: object
                properties:
                  documentationStatus:
                    type: string
                    examples:
                      - NO_FILES
                    enum:
                      - NO_FILES
                      - PARTIAL
                      - COMPLETE
                    description: NO_FILES、PARTIAL、COMPLETE。
                  documents:
                    type: array
                    items:
                      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
                    description: 文档，形状与“获取文档”相同。
              examples:
                Example 1:
                  value:
                    documentationStatus: NO_FILES
                    documents:
                      - 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'
                      - documentId: e0ea9515-442e-4bc5-bc82-b8d278255c37
                        entityId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                        type: PROOF_OF_ADDRESS
                        id: POA-0001
                        issuingCountry: BRA
                        issueDate: null
                        expirationDate: null
                        isPrimary: false
                        status: PENDING
                        metadata: null
                        proofs: []
                        createdAt: '2024-01-15T17:03:11Z'
                        updatedAt: '2024-01-15T17:03:11Z'
        '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/5aced5da-40c1-4bec-85ff-c8cd1bcb4526/documents
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '404':
          description: 未找到。ENTITY_NOT_FOUND：该实体不存在或属于其他商家。
          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 - ENTITY_NOT_FOUND:
                  value:
                    type: about:blank
                    title: Not found
                    status: 404
                    detail: The entity does not exist or belongs to another merchant.
                    instance: >-
                      /api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526/documents
                    code: ENTITY_NOT_FOUND
                    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.