Download de um Documento (API)
Esta seção da API D4Sign permite que você gere uma URL para fazer o download de um documento. Você pode escolher entre baixar o arquivo em PDF, um ZIP contendo o documento completo e até mesmo as fotos de documentos dos signatários, se houver.
🚧 Importante: Para que sua requisição seja autenticada e funcione corretamente, inclua seu tokenAPI
e cryptKey
diretamente na URL da requisição.
Exemplo de URL completa para requisição:
https://secure.d4sign.com.br/api/v1/documents/{UUID-DOCUMENT}/download?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}
Este endpoint cria uma URL temporária e única que você pode usar para baixar o documento especificado.
POST /documents/{UUID-DOCUMENT}/download
Parâmetros de Requisição (URL)
Parâmetro |
Descrição |
|
(obrigatório) O UUID (Identificador Universalmente Único) do documento que você deseja baixar. Você obtém este UUID ao criar ou listar documentos. |
Header
O cabeçalho da requisição deve especificar o tipo de conteúdo como JSON.
{
"Content-Type": "application/json"
}
Body
O corpo da requisição é um objeto JSON que contém as opções de download, permitindo que você personalize o tipo de arquivo e a inclusão de fotos de autenticação.
{
"type": "{type}",
"language": "pt",
"document": "true"
}
Detalhes e Opções dos Parâmetros do Body:
Parâmetro | Descrição |
---|---|
type (opcional) | Para realizar o download do arquivo completo, escolha ZIP nesse atributo. Para realizar o download apenas do PDF, escolha PDF nesse atributo. |
language (opcional) | Para realizar o download do arquivo em inglês, escolha en nesse atributo. Para realizar o download do arquivo em português, escolha pt nesse atributo. |
document \n(opcional) | True: Traz na resposta as fotos do documento do signatário em base 64 caso tenho sido usada a autenticação documento com foto ou foto e selfie. Trazendo assim 3 arquivos: a frente do documento, o verso do documento e a foto selfie, caso tenho sido solicitada na autenticação. \nfalse: não traz na resposta as fotos do documento do signatário em base 64. |
{ "url": "https://secure.d4sign.com.br/CODIGO", "name": "teste.pdf" }
{
"type": "{type}",
"language": "pt",
"document": "true"
}