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

# Acompanhe a revisão e corrija as rejeições.

> Solicite a revisão KYC/KYB de uma entidade, leia o resultado e corrija o que a Localpayment pedir.

Quando a entidade tiver seus dados e arquivos, você solicita a revisão com [Request Verification](https://docs.localpayment.com/pt-br/reference/request-entity-verification.md); você nunca a aprova. A área de Compliance da Localpayment decide sobre cada arquivo e sobre a entidade. Você não precisa aguardar o resultado nem consultar a entidade periodicamente. Quando algo precisa mudar, a Compliance informa o que e por quê, você corrige e solicita a verificação novamente. Se quiser acompanhar o resultado, use [Get KYC Status](https://docs.localpayment.com/pt-br/reference/get-kyc-status.md) e [Get Status History](https://docs.localpayment.com/pt-br/reference/get-entity-status-history.md).

## Pré-requisitos

* Uma entidade com seus documentos e arquivos carregados. Consulte [Carregar Documentos e Comprovantes](https://docs.localpayment.com/pt-br/docs/upload-documents-and-proofs.md).
* Para uma empresa, cada proprietário vinculado e com seus próprios documentos e arquivos. Consulte [Gerenciar Beneficiários Finais](https://docs.localpayment.com/pt-br/docs/manage-ubos.md).

## Quem faz o quê?

```mermaid theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
%%{init: {'theme': 'base', 'themeVariables': {'background': '#ffffff', 'primaryColor': '#31467c', 'primaryTextColor': '#ffffff', 'primaryBorderColor': '#0c1a29', 'secondaryColor': '#31467c', 'tertiaryColor': '#ffffff', 'lineColor': '#0c1a29', 'textColor': '#0c1a29', 'edgeLabelBackground': '#ffffff', 'fontFamily': 'Manrope'}, 'fontFamily': 'Manrope', 'htmlLabels': false, 'flowchart': {'htmlLabels': false, 'wrappingWidth': 400, 'padding': 20}}}%%
flowchart TD
    A["Seu backend<br/>GET /api/entity/v1/entities/{entityId}/kyc-status"] --> B["Entities API<br/>documentationStatus COMPLETE"]:::lp
    B --> V["Seu backend<br/>Solicita a análise<br/>POST /api/entity/v1/entities/{entityId}/verify"]
    V --> C["Entities API<br/>202 Accepted: entidade IN_REVIEW"]:::lp
    C --> D["Compliance da Localpayment<br/>Analisa cada prova: APPROVED ou REJECTED, com motivo"]:::lp
    D --> E["Compliance da Localpayment<br/>Decide sobre a entidade: ACTIVE, REJECTED ou volta para PENDING_KYC para correção"]:::lp
    E --> F["Seu backend, opcional<br/>GET /api/entity/v1/entities/{entityId}/kyc-status<br/>para acompanhar o resultado"]
    F --> G["Seu backend<br/>GET /api/entity/v1/entities/{entityId}/status-history<br/>todas as alterações, com quem as fez e por quê"]
    classDef default fill:#31467c,stroke:#0c1a29,stroke-width:1px,color:#ffffff,font-family:Manrope
    classDef lp fill:#0c1a29,stroke:#0c1a29,color:#ffffff
    classDef terminal fill:#0c1a29,stroke:#0c1a29,color:#ffffff
    classDef lbl fill:#0c1a29,stroke:#0c1a29,color:#ffffff,font-size:13px
```

> [!NOTE]
>
> Você não precisa consultar a entidade periodicamente. Webhooks de mudança de status não estão disponíveis para Entities; se quiser acompanhar a revisão, chame Get KYC Status em um intervalo razoável, por exemplo, a cada poucos minutos enquanto a entidade estiver `IN_REVIEW`.

## Antes da revisão

* Todo documento tem seus arquivos: `documentationStatus` é `COMPLETE` em Get KYC Status.
* Em uma empresa, cada proprietário está vinculado e possui seus próprios documentos e arquivos.
* Pelo menos um arquivo foi carregado; caso contrário, `verify` retorna 422 `NO_PROOFS_UPLOADED`.

Enquanto a entidade está `IN_REVIEW`, ela fica bloqueada: você não pode editar seus dados, adicionar ou editar documentos, carregar ou excluir arquivos, nem vincular, alterar ou encerrar UBOs (409 `ENTITY_IN_REVIEW`).

## Leia o status KYC

Enquanto a entidade está `IN_REVIEW`, depois que a Compliance aprovou ambos os arquivos:

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "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"
        }
      ]
    }
  ]
}
```

| Campo | Como lê-lo |
| - | - |
| status | O status do ciclo de vida da entidade. ACTIVE é o objetivo. |
| statusReason | Motivo da última alteração de status. Quando a entidade retorna ao status PENDING\_KYC, o sistema indica o que precisa ser corrigido. |
| documentationStatus | Apenas a cobertura de arquivos. COMPLETE com comprovantes ainda PENDING é normal antes da análise. |
| documents\[].status | VERIFIED quando todos os seus comprovantes ativos estão APPROVED, REJECTED se algum for rejeitado, EXPIRED se a data de validade declarada tiver passado. |
| documents\[].proofs\[].verificationStatus | PENDING, depois IN\_REVIEW, depois APPROVED ou REJECTED, definido pela Localpayment. |

Se quiser acompanhar a revisão, um loop de polling em Python:

```python theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
import os
import time
import requests

BASE_URL = "https://api.stage.localpayment.com/api/entity"
access_token = os.environ["LOCALPAYMENT_ACCESS_TOKEN"]
entity_id = "5aced5da-40c1-4bec-85ff-c8cd1bcb4526"
headers = {"Authorization": f"Bearer {access_token}"}
last_reason = None

while True:
    response = requests.get(f"{BASE_URL}/v1/entities/{entity_id}/kyc-status", headers=headers, timeout=30)
    if response.status_code != 200:
        problem = response.json()
        raise RuntimeError(f"{problem.get('code')} correlationId={problem.get('correlationId')}")

    kyc = response.json()
    if kyc["status"] in ("ACTIVE", "REJECTED"):
        break

    if kyc["status"] == "PENDING_KYC" and kyc.get("statusReason") and kyc["statusReason"] != last_reason:
        # Correction requested: read statusReason and the verificationReason of each
        # rejected proof (GET /v1/proofs/{proofId}), then correct the data or upload
        # a replacement with the same proofType, then call POST .../verify again.
        last_reason = kyc["statusReason"]

    time.sleep(300)  # every 5 minutes
```

## Possíveis resultados

```mermaid theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
%%{init: {'theme': 'base', 'themeVariables': {'background': '#ffffff', 'primaryColor': '#31467c', 'primaryTextColor': '#ffffff', 'primaryBorderColor': '#0c1a29', 'secondaryColor': '#31467c', 'tertiaryColor': '#ffffff', 'lineColor': '#0c1a29', 'textColor': '#0c1a29', 'edgeLabelBackground': '#ffffff', 'fontFamily': 'Manrope'}, 'fontFamily': 'Manrope', 'htmlLabels': false, 'flowchart': {'htmlLabels': false, 'wrappingWidth': 400, 'padding': 20}}}%%
flowchart LR
    R["IN_REVIEW"]:::lp --> A{"Decisão de compliance"}
    A --- L1(["todas as provas aprovadas"]):::lbl --> OK["ACTIVE"]
    A --- L2(["correção solicitada"]):::lbl --> P["PENDING_KYC<br/>statusReason e verificationReason na prova"]
    P --> U["Corrija os dados ou<br/>envie o mesmo proofType novamente,<br/>depois faça POST .../verify de novo"]
    U --> R
    A --- L3(["caso rejeitado"]):::lbl --> NO["REJECTED<br/>motivo no histórico de status"]
    OK --> B["O compliance pode bloquear e desbloquear depois"]
    classDef default fill:#31467c,stroke:#0c1a29,stroke-width:1px,color:#ffffff,font-family:Manrope
    classDef lp fill:#0c1a29,stroke:#0c1a29,color:#ffffff
    classDef terminal fill:#0c1a29,stroke:#0c1a29,color:#ffffff
    classDef lbl fill:#0c1a29,stroke:#0c1a29,color:#ffffff,font-size:13px
```

* **Aprovada:** a entidade passa a `ACTIVE`.
* **Correção solicitada:** a entidade volta para `PENDING_KYC` com o motivo em `statusReason`, e cada arquivo rejeitado traz seu próprio `verificationReason`. Faça o upload de um substituto com o mesmo `proofType`, ou corrija os dados, e depois chame [Request Verification](https://docs.localpayment.com/pt-br/reference/request-entity-verification.md) novamente.
* **Rejeitada:** a entidade passa a `REJECTED` e o motivo fica no histórico de status. Uma entidade `REJECTED` não pode ser enviada novamente: registre uma nova entidade com um novo `externalId`, ou entre em contato com seu gerente de conta.

Histórico de status após a aprovação, com cada alteração, quem a fez e por quê:

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
[
  {
    "fromStatus": "PENDING_KYC",
    "toStatus": "IN_REVIEW",
    "reason": "Review started",
    "changedBy": "12345",
    "correlationId": "b68165b9-1d60-4f9d-9919-7fee12411714",
    "createdAt": "2024-01-15T17:03:15Z"
  },
  {
    "fromStatus": "IN_REVIEW",
    "toStatus": "ACTIVE",
    "reason": "KYC approved",
    "changedBy": "67890",
    "correlationId": "b07a3416-11fb-48d8-8671-be471694f0a2",
    "createdAt": "2024-01-15T17:03:22Z"
  }
]
```

## Regras para lembrar

* Você solicita a revisão com `verify`; aprovar ou rejeitar é feito somente pela Localpayment.
* Editar os dados da entidade após a aprovação não altera a revisão registrada. Editar um documento redefine seus arquivos aprovados para `PENDING`, e eles são revisados novamente.
* `BLOCKED` e o retorno para `ACTIVE` são decididos pela área de Compliance. Você os vê no histórico de status com o respectivo motivo.

## Próximos passos

> [card] [Gerenciar Beneficiários Finais](https://docs.localpayment.com/pt-br/docs/manage-ubos.md)
>
> Para empresas: vincule os beneficiários finais.

> [card] [Status das entidades e códigos de erro](https://docs.localpayment.com/pt-br/reference/entity-statuses-and-error-codes.md)
>
> Todos os status, transições e códigos de erro.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.