Pular para o conteúdo principal
POST
Enviar comprovante
Envia o arquivo que comprova um documento declarado (imagem de um documento de identidade, PDF de um comprovante de endereço, contrato social). A prova é criada em verificationStatus: PENDING e armazenada de forma criptografada; a Localpayment a revisa. Quando todos os arquivos forem enviados, chame Request Verification.
  • Arquivos por documento. Um documento comporta quantas provas forem necessárias: frente, verso e selfie de um documento de identidade, as páginas de um contrato, um recibo. Não há limite para o número de arquivos por id de documento.
  • Substituição. FRONT, BACK e SELFIE têm um arquivo atual cada: enviar o mesmo tipo novamente substitui o anterior, que passa a ser SUPERSEDED. DOCUMENT e OTHER são cumulativos: cada envio adiciona um arquivo (páginas de um contrato, vários recibos).
  • Arquivos aprovados são mantidos. Substituir um FRONT, BACK ou SELFIE APPROVED retorna 409 PROOF_APPROVED.
  • Durante uma revisão. Enquanto a entidade estiver IN_REVIEW, nenhum arquivo pode ser enviado, substituído ou excluído (409 ENTITY_IN_REVIEW).
  • Verifique sizeBytes > 0 na resposta: uma solicitação multipart sem a parte de arquivo armazena uma prova vazia.
  • Os arquivos nunca são retornados inline; baixe-os por meio de Get a Proof ou Download a Proof File.
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

docId
string<uuid>
obrigatório

ID do documento ao qual o arquivo pertence.

Exemplo:

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

Parâmetros de consulta

proofType
enum<string>
obrigatório

FRONT, BACK, SELFIE, DOCUMENT, OTHER.

Opções disponíveis:
FRONT,
BACK,
SELFIE,
DOCUMENT,
OTHER
Exemplo:

"FRONT"

metadata
string

Objeto JSON codificado em URL com metadados de formato livre, por exemplo %7B%22issuer%22%3A%22utility%22%7D.

Corpo

multipart/form-data
file
file
obrigatório

JPG, PNG ou PDF com até 10 MB. Arquivo multipartes com nome definido.

Resposta

Criado.

id
string

Identificador da prova (proofId).

Exemplo:

"2c4c2f74-7179-4113-83fb-f11dbce9e07d"

documentId
string<uuid>

Documento que o arquivo comprova.

Exemplo:

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

proofType
enum<string>

FRONT, BACK, SELFIE, DOCUMENT, OTHER.

Opções disponíveis:
FRONT,
BACK,
SELFIE,
DOCUMENT,
OTHER
Exemplo:

"FRONT"

fileName
string

Metadados do arquivo conforme carregado. Verifique o tamanho em bytes. > 0 após o upload.

Exemplo:

"id_front.jpg"

mimeType
string

Metadados do arquivo conforme carregado. Verifique o tamanho em bytes. > 0 após o upload.

Exemplo:

"image/jpeg"

sizeBytes
integer

Metadados do arquivo conforme carregado. Verifique o tamanho em bytes. > 0 após o upload.

Exemplo:

102400

verificationStatus
enum<string>

PENDING, IN_REVIEW, APPROVED, REJECTED. Definido pela Localpayment Compliance.

Opções disponíveis:
PENDING,
IN_REVIEW,
APPROVED,
REJECTED
Exemplo:

"PENDING"

verifiedBy
string | null

Resultado da verificação. verificationReason é preenchido em caso de rejeição.

verifiedAt
string<date-time> | null

Resultado da verificação. verificationReason é preenchido em caso de rejeição.

verificationReason
string | null

Resultado da verificação. verificationReason é preenchido em caso de rejeição.

uploadedBy
string

Usuário da sua conta que carregou o arquivo (a partir do token de acesso) e horário do upload.

Exemplo:

"12345"

uploadedAt
string<date-time>

Usuário da sua conta que carregou o arquivo (a partir do token de acesso) e horário do upload.

Exemplo:

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

status
enum<string>

Ciclo de vida da prova: CURRENT (ativa), SUPERSEDED (substituída por um upload mais recente do mesmo proofType) ou DELETED. Independente de verificationStatus.

Opções disponíveis:
CURRENT,
SUPERSEDED,
DELETED
Exemplo:

"CURRENT"

supersededAt
string<date-time> | null

Definido quando a prova foi substituída.

supersededBy
string | null

Definido quando a prova foi substituída.

replacedByProofId
string<uuid> | null

Definido quando a prova foi substituída.

deletedAt
string<date-time> | null

Definido quando a prova foi excluída.

deletedBy
string | null

Definido quando a prova foi excluída.

inVerification
boolean

Verdadeiro enquanto a prova estiver em revisão (entidade IN_REVIEW); ela não pode ser substituída ou excluída nesse período.

Exemplo:

false

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