Consultar Documentos
Request
ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY/attached_document/DOCUMENT_KEYMÉTODO
GETPath Params
| Parâmetro | Descrição |
|---|---|
assignment_contract_key | Chave da contrato de cessão |
document_key | Chave 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
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
document_key * | string | Chave única de identificação do documento. | 36 |
document_type * | string | Tipo do documento. | -- |
status * | string | Status do documento. | Ver Enumeradores de status do documento. |
document_template_key | string | Chave única de identificação do template que gerou o documento. | 36 |
required_parties | array | Lista de partes que assinam o documento em questão. | -- |
download_url | string | URL de download do PDF. | -- |
Enumeradores
Attached Document Status
| Enumerador | Descrição |
|---|---|
| pending_generate | Pendente geração do documento |
| approved | Documento gerado |
| signed | Documento assinado |