Pular para o conteúdo principal
GET
Obtenha uma prova
Retorna os metadados de uma prova e um downloadUrl assinado de curta duração para baixar o arquivo.
  • O host, a expiração e a assinatura de downloadUrl estão abreviados no exemplo.
  • O acesso aos arquivos é auditado com o usuário do seu token de acesso.
  • Se a URL expirar, chame este endpoint novamente para obter uma nova.
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

proofId
string<uuid>
obrigatório

ID da prova.

Exemplo:

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

Resposta

OK.

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:

true

downloadUrl
string

URL assinada válida por 10 minutos. Solicite-a imediatamente antes de baixar; não a armazene.

Exemplo:

"https://files.example.com/<object-path>?expires=600&signature=<redacted>"

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