Skip to main content
GET
Gerar PDF da diligência

Como funciona

A resposta não é o arquivo: é um JSON com downloadUrl (link pré-assinado) e expiresAt. Baixe o arquivo antes de expiresAt; depois disso, chame o endpoint de novo.
  • mergeCertificates=0 (padrão): gera só o relatório.
  • mergeCertificates=1: gera um PDF único com o relatório e as certidões concluídas.
Exige ao menos uma certidão concluída; sem isso, retorna 404 com No completed certificates available for download. Para baixar uma certidão isolada, use GET /certificate/{id}/download-pdf.

Authorizations

X-Api-Token
string
header
required

Token de API gerado no dashboard, enviado no header X-Api-Token.

Path Parameters

id
string<uuid>
required

ID da diligência

Query Parameters

mergeCertificates
enum<string>
default:0

1 junta as certidões concluídas ao relatório num PDF único; 0 gera só o relatório.

Available options:
0,
1

Response

Link do PDF.

Link temporário para baixar o arquivo. Esta resposta não usa o envelope statusCode/data.

downloadUrl
string<uri>
required

URL pré-assinada do arquivo.

expiresAt
string<date-time>
required

Momento em que a URL deixa de valer. Baixe o arquivo antes disso ou chame o endpoint de novo.