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

# 获取 KYC 状态

返回审核状态的精简树：实体状态、文件覆盖情况、每份文件和每个有效证明的状态，以及上次状态更改的原因。使用它来跟进 Localpayment 执行的审核。

* 主示例截取自案例处于 IN\_REVIEW 状态且两个文件均已获批准时；第二个示例截取自上传后不久，此时文件仍为 PENDING。
* documentationStatus: COMPLETE 表示每份文件都有对应的文件；这并不意味着文件已获批准。批准情况体现在 documents\[].status = VERIFIED 和 proofs\[].verificationStatus = APPROVED 中。

错误使用带有固定 `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}/kyc-status
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}/kyc-status:
    get:
      summary: 获取 KYC 状态
      operationId: get-kyc-status
      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:
                  entityId:
                    type: string
                    examples:
                      - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    format: uuid
                    description: 实体。
                  status:
                    type: string
                    examples:
                      - IN_REVIEW
                    enum:
                      - PENDING_KYC
                      - IN_REVIEW
                      - ACTIVE
                      - REJECTED
                      - BLOCKED
                      - CLOSED
                    description: 实体状态。请参阅实体状态和错误代码。
                  documentationStatus:
                    type: string
                    examples:
                      - COMPLETE
                    enum:
                      - NO_FILES
                      - PARTIAL
                      - COMPLETE
                    description: NO_FILES、PARTIAL、COMPLETE。
                  statusReason:
                    type: string
                    examples:
                      - Review started
                    description: >-
                      上次状态更改的原因，或为空。当 Localpayment 将实体返回到 PENDING_KYC
                      状态时，它会说明需要更正的内容。
                  documents:
                    type: array
                    items:
                      type: object
                      properties:
                        documentId:
                          type: string
                          examples:
                            - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                          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: 文件及其衍生状态。
                        status:
                          type: string
                          examples:
                            - VERIFIED
                          enum:
                            - PENDING
                            - VERIFIED
                            - REJECTED
                            - EXPIRED
                          description: >-
                            派生的文档状态：如果 expirationDate 已过，则为
                            EXPIRED；如果任何有效证明文件被拒绝，则为 REJECTED；如果所有有效证明文件均已批准，则为
                            VERIFIED；否则为 PENDING。
                        proofs:
                          type: array
                          items:
                            type: object
                            properties:
                              proofId:
                                type: string
                                examples:
                                  - 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                                format: uuid
                                description: 有效证明及其验证状态。
                              verificationStatus:
                                type: string
                                examples:
                                  - APPROVED
                                enum:
                                  - PENDING
                                  - IN_REVIEW
                                  - APPROVED
                                  - REJECTED
                                description: 有效证明及其验证状态。
              examples:
                Example 1:
                  value:
                    entityId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    status: IN_REVIEW
                    documentationStatus: COMPLETE
                    statusReason: Review started
                    documents:
                      - documentId: 2e16d844-4fa9-4295-9a21-83ec32ef241a
                        type: CPF
                        status: VERIFIED
                        proofs:
                          - proofId: 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                            verificationStatus: APPROVED
                      - documentId: e0ea9515-442e-4bc5-bc82-b8d278255c37
                        type: PROOF_OF_ADDRESS
                        status: VERIFIED
                        proofs:
                          - proofId: acb78b3f-fe18-4094-b6a9-2107f502d709
                            verificationStatus: APPROVED
                Example 2 - Right after upload, before the review starts:
                  value:
                    entityId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    status: PENDING_KYC
                    documentationStatus: COMPLETE
                    statusReason: null
                    documents:
                      - documentId: 2e16d844-4fa9-4295-9a21-83ec32ef241a
                        type: CPF
                        status: PENDING
                        proofs:
                          - proofId: 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                            verificationStatus: PENDING
                      - documentId: e0ea9515-442e-4bc5-bc82-b8d278255c37
                        type: PROOF_OF_ADDRESS
                        status: PENDING
                        proofs:
                          - proofId: acb78b3f-fe18-4094-b6a9-2107f502d709
                            verificationStatus: PENDING
        '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/kyc-status
                    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/kyc-status
                    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.