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

# Obtenha o status KYC

Retorna uma árvore compacta do estado da revisão: status da entidade, cobertura da documentação, o status de cada documento e prova ativa, e o motivo da última mudança de status. Use-a para acompanhar a revisão realizada pela Localpayment.

* O exemplo principal foi capturado com o caso em IN\_REVIEW e com os dois arquivos já aprovados; o segundo, logo após o upload, com os arquivos ainda em PENDING.
* documentationStatus: COMPLETE significa que todos os documentos têm um arquivo; não significa que os arquivos foram aprovados. A aprovação se reflete em documents\[].status = VERIFIED e proofs\[].verificationStatus = APPROVED.

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/{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: Obtenha o status KYC
      operationId: get-kyc-status
      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: entityId
          in: path
          description: ID interno da entidade.
          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: Entidade.
                  status:
                    type: string
                    examples:
                      - IN_REVIEW
                    enum:
                      - PENDING_KYC
                      - IN_REVIEW
                      - ACTIVE
                      - REJECTED
                      - BLOCKED
                      - CLOSED
                    description: >-
                      Status da entidade. Consulte Status da entidade e Códigos
                      de erro.
                  documentationStatus:
                    type: string
                    examples:
                      - COMPLETE
                    enum:
                      - NO_FILES
                      - PARTIAL
                      - COMPLETE
                    description: NO_FILES, PARTIAL, COMPLETE.
                  statusReason:
                    type: string
                    examples:
                      - Review started
                    description: >-
                      Motivo da última alteração de status ou nulo. Quando o
                      Localpayment retorna a entidade para PENDING_KYC, ele
                      indica o que deve ser corrigido.
                  documents:
                    type: array
                    items:
                      type: object
                      properties:
                        documentId:
                          type: string
                          examples:
                            - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                          format: uuid
                          description: Documento e seu respectivo status.
                        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: Documento e seu respectivo status.
                        status:
                          type: string
                          examples:
                            - VERIFIED
                          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.
                        proofs:
                          type: array
                          items:
                            type: object
                            properties:
                              proofId:
                                type: string
                                examples:
                                  - 2c4c2f74-7179-4113-83fb-f11dbce9e07d
                                format: uuid
                                description: >-
                                  Comprovantes ativos e seu status de
                                  verificação.
                              verificationStatus:
                                type: string
                                examples:
                                  - APPROVED
                                enum:
                                  - PENDING
                                  - IN_REVIEW
                                  - APPROVED
                                  - REJECTED
                                description: >-
                                  Comprovantes ativos e seu status de
                                  verificação.
              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: '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/5aced5da-40c1-4bec-85ff-c8cd1bcb4526/kyc-status
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '404':
          description: >-
            Não encontrado. ENTITY_NOT_FOUND: A entidade não existe ou pertence
            a outro comerciante.
          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 - 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.