Query Documents
Request
ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY/attached_document/DOCUMENT_KEYMETHOD
GETPath Params
| Parameter | Description |
|---|---|
assignment_contract_key | Assignment contract key |
document_key | Document key |
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"
}
Note
The download url field provides the signed URL for downloading the document in its most current version, meaning if the document is signed it will be provided through this same URL. It expires and should not be used for timeless queries.
Attached Document Definition
| Field | Type | Description | Characters |
|---|---|---|---|
document_key * | string | Document unique identification key. | 36 |
document_type * | string | Document type. | -- |
status * | string | Document status. | See Document status enumerators. |
document_template_key | string | Unique identification key of the template that generated the document. | 36 |
required_parties | array | List of parties that sign the document in question. | -- |
download_url | string | PDF download URL. | -- |
Enumerators
Attached Document Status
| Enumerator | Description |
|---|---|
| pending_generate | Pending document generation |
| approved | Document generated |
| signed | Document signed |