Enviar Documento da Garantia
Introdução
Este recurso tem como objetivo nos enviar o documento relacionado a formalização da garantia ao qual se está solicitando o bloqueio de cotas
Input / Output:
Como input deve ser enviado o tipo do documento e o base 64 do documento. Segue abaixo exemplo.
Como output será entregue uma collateral_document_key. A collateral_document_key é utilizada para identificar o documento da garantia enviado.
Disponível em
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Escrita |
| Consultoria | consultant-api | Liberada pelo time de integração |
URL base de cada host: Ambientes (Hosts).
Request
ENDPOINT
/quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/collateral/COLLATERAL_KEY/documentMÉTODO
POSTSTATUS
201Request body
Request Body
{
"document_type": "collateral_contract",
"document_b64" : "B64"
}
Collateral Document
| Campo | Tipo | Descrição | Caracteres | Obrigatório |
|---|---|---|---|---|
document_type | string | Enumerador de tipo de documento da garantia | até 255 | Sim |
document_b64 | string | Conteúdo do documento codificado em base64 | - | Sim |
Document Type
| Enumerador | Descrição |
|---|---|
collateral_contract | Contrato de garantia |
rental_contract | Contrato de aluguel |
Response
Response Body
{
"collateral_document_key": "UUID"
}
Erros
Erros de autenticação, permissão e host: veja Erros da API.