Pular para o conteúdo principal
GET
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.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string
obrigatório

Token de acesso Bearer para autenticação. Este token é obtido nos endpoints Obter token de acesso ou Renovar token de acesso. Sua conta de comerciante e o usuário que realiza a ação são identificados a partir dele.

Exemplo:

"Bearer <your_access_token>"

X-Correlation-ID
string

Identificador de rastreamento (UUID). Exibido na resposta; gerado pelo Localpayment se ausente.

Exemplo:

"0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10"

Parâmetros de caminho

entityId
string<uuid>
obrigatório

ID interno da entidade.

Exemplo:

"5aced5da-40c1-4bec-85ff-c8cd1bcb4526"

Resposta

OK.

entityId
string<uuid>

Entidade.

Exemplo:

"5aced5da-40c1-4bec-85ff-c8cd1bcb4526"

status
enum<string>

Status da entidade. Consulte Status da entidade e Códigos de erro.

Opções disponíveis:
PENDING_KYC,
IN_REVIEW,
ACTIVE,
REJECTED,
BLOCKED,
CLOSED
Exemplo:

"IN_REVIEW"

documentationStatus
enum<string>

NO_FILES, PARTIAL, COMPLETE.

Opções disponíveis:
NO_FILES,
PARTIAL,
COMPLETE
Exemplo:

"COMPLETE"

statusReason
string

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.

Exemplo:

"Review started"

documents
object[]
Última modificação em 10 de novembro de 2026