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

# 获取文档

返回一份已声明的文件及其派生状态和有效证明。

* 第一个示例显示一份 VERIFIED 文件（其唯一的有效证明为 APPROVED）；第二个示例显示一份 REJECTED 文件，原因附在证明上。

错误使用带有固定 `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/{docId}
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/{docId}:
    get:
      summary: 获取文档
      operationId: get-entity-document
      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
        - name: docId
          in: path
          description: 文档的 documentId。
          required: true
          schema:
            type: string
            format: uuid
            examples:
              - e0ea9515-442e-4bc5-bc82-b8d278255c37
      responses:
        '200':
          description: OK。
          content:
            application/json:
              schema:
                type: object
                properties:
                  documentId:
                    type: string
                    examples:
                      - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                    format: uuid
                    description: 文件标识符（docId）。用于上传和列出证明文件。
                  entityId:
                    type: string
                    examples:
                      - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    format: uuid
                    description: 所有权实体。
                  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
                    description: 文件类型。
                  id:
                    type: string
                    examples:
                      - '00000000000'
                    description: 文件编号与申报一致。
                  issuingCountry:
                    type: string
                    examples:
                      - BRA
                    description: 按声明提供的发卡方数据。
                  issueDate:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: 按声明提供的发卡方数据。
                  expirationDate:
                    type:
                      - string
                      - 'null'
                    format: date
                    description: 按声明提供的发卡方数据。
                  isPrimary:
                    type: boolean
                    examples:
                      - true
                    description: 实体识别文件。
                  status:
                    type: string
                    examples:
                      - VERIFIED
                    enum:
                      - PENDING
                      - VERIFIED
                      - REJECTED
                      - EXPIRED
                    description: >-
                      派生的文档状态：如果 expirationDate 已过，则为 EXPIRED；如果任何有效证明文件被拒绝，则为
                      REJECTED；如果所有有效证明文件均已批准，则为 VERIFIED；否则为 PENDING。
                  metadata:
                    type:
                      - object
                      - 'null'
                    description: 自由格式元数据。
                  proofs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          examples:
                            - 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                          description: 文件编号与申报一致。
                        documentId:
                          type: string
                          examples:
                            - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                          format: uuid
                          description: 文件标识符（docId）。用于上传和列出证明文件。
                        proofType:
                          type: string
                          examples:
                            - FRONT
                          enum:
                            - FRONT
                            - BACK
                            - SELFIE
                            - DOCUMENT
                            - OTHER
                        fileName:
                          type: string
                          examples:
                            - id_front.jpg
                        mimeType:
                          type: string
                          examples:
                            - image/jpeg
                        sizeBytes:
                          type: integer
                          examples:
                            - 102400
                        verificationStatus:
                          type: string
                          examples:
                            - APPROVED
                          enum:
                            - PENDING
                            - IN_REVIEW
                            - APPROVED
                            - REJECTED
                        verifiedBy:
                          type: string
                          examples:
                            - '67890'
                        verifiedAt:
                          type: string
                          examples:
                            - '2024-01-15T17:03:20Z'
                          format: date-time
                        verificationReason:
                          type:
                            - string
                            - 'null'
                        uploadedBy:
                          type: string
                          examples:
                            - '12345'
                        uploadedAt:
                          type: string
                          examples:
                            - '2024-01-15T17:03:13Z'
                          format: date-time
                        status:
                          type: string
                          examples:
                            - CURRENT
                          enum:
                            - CURRENT
                            - SUPERSEDED
                            - DELETED
                          description: >-
                            证明生命周期：CURRENT（有效）、SUPERSEDED（已被相同 proofType
                            的新上传证明替换）或 DELETED。与 verificationStatus 无关。
                        supersededAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        supersededBy:
                          type:
                            - string
                            - 'null'
                        replacedByProofId:
                          type:
                            - string
                            - 'null'
                          format: uuid
                        deletedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        deletedBy:
                          type:
                            - string
                            - 'null'
                        inVerification:
                          type: boolean
                          examples:
                            - false
                    description: 该文件的有效证明（已替换的文件不列出）。
                  createdAt:
                    type: string
                    examples:
                      - '2024-01-15T17:03:10Z'
                    format: date-time
                  updatedAt:
                    type: string
                    examples:
                      - '2024-01-15T17:03:15Z'
                    format: date-time
              examples:
                Example 1:
                  value:
                    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: VERIFIED
                    metadata: null
                    proofs:
                      - id: 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                        documentId: 2e16d844-4fa9-4295-9a21-83ec32ef241a
                        proofType: FRONT
                        fileName: id_front.jpg
                        mimeType: image/jpeg
                        sizeBytes: 102400
                        verificationStatus: APPROVED
                        verifiedBy: '67890'
                        verifiedAt: '2024-01-15T17:03:20Z'
                        verificationReason: null
                        uploadedBy: '12345'
                        uploadedAt: '2024-01-15T17:03:13Z'
                        status: CURRENT
                        supersededAt: null
                        supersededBy: null
                        replacedByProofId: null
                        deletedAt: null
                        deletedBy: null
                        inVerification: false
                    createdAt: '2024-01-15T17:03:10Z'
                    updatedAt: '2024-01-15T17:03:15Z'
                Example 2 - A document whose file was rejected:
                  value:
                    documentId: 0266257c-a2aa-49ac-99fe-b3882a51d750
                    entityId: 8f5b2c9a-1caf-4b2c-b085-82bbaead6ddd
                    type: NATIONAL_ID
                    id: 00.000.000-0
                    issuingCountry: BRA
                    issueDate: null
                    expirationDate: null
                    isPrimary: false
                    status: REJECTED
                    metadata: null
                    proofs:
                      - id: 931398af-9c77-4958-abf8-4c749147c508
                        documentId: 0266257c-a2aa-49ac-99fe-b3882a51d750
                        proofType: BACK
                        fileName: id_back.jpg
                        mimeType: image/jpeg
                        sizeBytes: 98304
                        verificationStatus: REJECTED
                        verifiedBy: '67890'
                        verifiedAt: '2024-01-15T17:20:34Z'
                        verificationReason: Illegible image
                        uploadedBy: '12345'
                        uploadedAt: '2024-01-15T17:19:49Z'
                        status: CURRENT
                        supersededAt: null
                        supersededBy: null
                        replacedByProofId: null
                        deletedAt: null
                        deletedBy: null
                        inVerification: false
                    createdAt: '2024-01-15T17:19:46Z'
                    updatedAt: '2024-01-15T17:19:46Z'
        '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/e0ea9515-442e-4bc5-bc82-b8d278255c37
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '404':
          description: >-
            未找到。ENTITY_NOT_FOUND：该实体不存在或属于其他商家。DOCUMENT_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/e0ea9515-442e-4bc5-bc82-b8d278255c37
                    code: ENTITY_NOT_FOUND
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
                Example 2 - DOCUMENT_NOT_FOUND:
                  value:
                    type: about:blank
                    title: Not found
                    status: 404
                    detail: >-
                      The document does not exist, was deleted, or belongs to
                      another merchant.
                    instance: >-
                      /api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526/documents/e0ea9515-442e-4bc5-bc82-b8d278255c37
                    code: DOCUMENT_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.