Pular para o conteúdo principal
GET
Obtenha um documento
Retorna um documento declarado com seu status derivado e suas provas ativas.
  • O primeiro exemplo mostra um documento VERIFIED (sua única prova ativa é APPROVED); o segundo, um REJECTED, com o motivo na prova.
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"

docId
string<uuid>
obrigatório

ID do documento.

Exemplo:

"e0ea9515-442e-4bc5-bc82-b8d278255c37"

Resposta

OK.

documentId
string<uuid>

Identificador do documento (docId). Use-o para carregar e listar comprovantes.

Exemplo:

"2e16d844-4fa9-4295-9a21-83ec32ef241a"

entityId
string<uuid>

Entidade proprietária.

Exemplo:

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

type
enum<string>

Tipo de documento.

Opções disponíveis:
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
Exemplo:

"CPF"

id
string

Número do documento conforme declarado.

Exemplo:

"00000000000"

issuingCountry
string

Emitindo dados conforme declarado.

Exemplo:

"BRA"

issueDate
string<date> | null

Emitindo dados conforme declarado.

expirationDate
string<date> | null

Emitindo dados conforme declarado.

isPrimary
boolean

Documento de identificação da entidade.

Exemplo:

true

status
enum<string>

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.

Opções disponíveis:
PENDING,
VERIFIED,
REJECTED,
EXPIRED
Exemplo:

"VERIFIED"

metadata
object | null

Metadados de formato livre.

proofs
object[]

Comprovantes ativos do documento (os arquivos substituídos não são listados).

createdAt
string<date-time>
Exemplo:

"2024-01-15T17:03:10Z"

updatedAt
string<date-time>
Exemplo:

"2024-01-15T17:03:15Z"

Última modificação em 10 de novembro de 2026