Pular para o conteúdo principal

Consultar Documentos


Request

ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY/attached_document/DOCUMENT_KEY
MÉTODO
GET

Path Params

ParâmetroDescrição
assignment_contract_keyChave da contrato de cessão
document_keyChave do documento

Response

STATUS
200
{
"document_key":"UUID",
"document_type":"manager_declaration | assignment_contract",
"status":"signed | pending_signature",
"document_template_key":"UUID",
"required_parties":[
"manager | consultant | attestant"
],
"download_url":"url para download do documento"
}
Observação

O campo de download url trás a URL assinada para download do documento em sua versão mais atual, ou seja caso o documento esteja assinado ele vai trazer nesta mesma URL. A mesma expira, e não deve ser utilizada para consulta atemporal.


Definição de Documento Anexo

CampoTipoDescriçãoCaracteres
document_key *stringChave única de identificação do documento.36
document_type *stringTipo do documento.--
status *stringStatus do documento.Ver Enumeradores de status do documento.
document_template_keystringChave única de identificação do template que gerou o documento.36
required_partiesarrayLista de partes que assinam o documento em questão.--
download_urlstringURL de download do PDF.--

Enumeradores

Attached Document Status

EnumeradorDescrição
pending_generatePendente geração do documento
approvedDocumento gerado
signedDocumento assinado