Pular para o conteúdo principal

Baixar Documento

Devolve o conteúdo de um documento do aditamento em base64 — o termo aditivo gerado pela QI Tech, o termo que você enviou, ou a versão assinada.


Request

ENDPOINT
/security_amendment/amendment/AMENDMENT-KEY/document/DOCUMENT-KEY
MÉTODO
GET

Path Params

CampoTipoDescriçãoCaracteres
AMENDMENT-KEYstringChave única do aditamento (UUID v4).36
DOCUMENT-KEYstringChave do documento (UUID v4), obtida em documents[].document_key na consulta.36

Query Params

CampoTipoObrigatórioPadrãoDescrição
is_signedbooleanNãofalseQuando true, devolve a versão assinada do documento.

Response

STATUS
200
{
"document_base64": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL1BhZ2UvTWVkaWFCb3hbMCAwIDU5NSA4NDJd..."
}
CampoTipoDescrição
document_base64stringConteúdo do arquivo em base64.
A versão assinada só existe depois da assinatura

is_signed=true em um documento que ainda não foi assinado retorna AMD000038. Confira o campo documents[].signed_file_key na consulta: ele só é preenchido quando a versão assinada está disponível.


Erros

StatusCódigoDescrição
404AMD000017Aditamento não encontrado.
403AMD000018O aditamento não pertence ao seu tenant.
404AMD000037Documento não encontrado neste aditamento.
422AMD000038O documento ainda não tem versão assinada.

Veja também