Pular para o conteúdo principal
POST
Adicionar um documento
Declara um documento adicional para uma entidade existente: um comprovante de endereço, contrato social, procuração ou qualquer outro documento de suporte. Os arquivos são enviados depois com Upload a Proof.
  • O documento principal é sempre o documento enviado na criação da entidade. Enviar isPrimary: true aqui retorna 400 VALIDATION_ERROR.
  • A entidade não pode estar IN_REVIEW, REJECTED, BLOCKED ou CLOSED.
Os erros usam application/problem+json com um code estável. Catálogo completo: Entity Statuses and Error Codes.

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"

Corpo

application/json
type
enum<string>
obrigatório

Consulte Tipos de Documentos e Provas.

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:

"PROOF_OF_ADDRESS"

id
string
obrigatório

Número do documento, de 1 a 30 caracteres. Único em conjunto com o tipo no seu merchant. Para comprovantes sem número oficial, use sua própria referência (por exemplo, POA-0001).

Exemplo:

"POA-0001"

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.

Exemplo:

"2034-01-15"

metadata
object

Metadados de formato livre.

Resposta

Criado.

documentId
string<uuid>

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

Exemplo:

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

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:

"PROOF_OF_ADDRESS"

id
string

Número do documento conforme declarado.

Exemplo:

"POA-0001"

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:

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 | 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:11Z"

updatedAt
string<date-time>
Exemplo:

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

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