Send Collateral Document
Introduction
This resource is used to send us the document related to the formalization of the collateral for which the quota lock is being requested
Input / Output:
As input, the document type and the base 64 of the document must be sent. See the example below.
As output, a collateral_document_key is delivered. The collateral_document_key is used to identify the uploaded collateral document.
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
| Consultant | consultant-api | Granted by the integration team |
Base URL for each host: Environments (Hosts).
Request
ENDPOINT
/quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/collateral/COLLATERAL_KEY/documentMETHOD
POSTSTATUS
201Request body
Request Body
{
"document_type": "collateral_contract",
"document_b64" : "B64"
}
Collateral Document
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
document_type | string | Collateral document type enumerator | up to 255 | Yes |
document_b64 | string | Document content encoded in base64 | - | Yes |
Document Type
| Enumerator | Description |
|---|---|
collateral_contract | Collateral contract |
rental_contract | Rental contract |
Response
Response Body
{
"collateral_document_key": "UUID"
}
Errors
Authentication, permission and host errors: see API Errors.