Pular para o conteúdo principal
PATCH
Atualizar um documento
Atualiza os dados de emissão de um documento declarado. type, id e isPrimary são imutáveis.
  • Alterar os dados de um documento redefine suas provas APPROVED para PENDING: a Localpayment as revisa novamente.
  • Para alterar o tipo ou o número, adicione um novo documento e exclua o antigo.
Os erros usam application/problem+json com um code estável. Catálogo completo: Statuses de Entidade 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"

Corpo

application/json
issuingCountry
string

ISO 3166-1 alfa-3.

Exemplo:

"BRA"

issueDate
string<date>

AAAA-MM-DD.

Exemplo:

"2024-01-15"

expirationDate
string<date>

AAAA-MM-DD. Uma data passada marca o documento como EXPIRED.

Exemplo:

"2034-01-15"

metadata
object

Metadados de formato livre (substituem o objeto armazenado).

Resposta

OK.

documentId
string<uuid>

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

Exemplo:

"5ca3e868-2b76-4390-b25a-5d10c0db8516"

entityId
string<uuid>

Entidade proprietária.

Exemplo:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

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:

"TAX_ID"

id
string

Número do documento conforme declarado.

Exemplo:

"00.000.000/0001-00"

issuingCountry
string

Emitindo dados conforme declarado.

Exemplo:

"BRA"

issueDate
string<date>

Emitindo dados conforme declarado.

Exemplo:

"2024-01-15"

expirationDate
string<date>

Emitindo dados conforme declarado.

Exemplo:

"2034-01-15"

isPrimary
boolean

Documento de identificação da entidade.

Exemplo:

false

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:

"PENDING"

metadata
object

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:18:54Z"

updatedAt
string<date-time>
Exemplo:

"2024-01-15T17:19:32Z"

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