Pular para o conteúdo principal

Consultar documentos


Retorna um documento anexo do contrato de cessão (o contrato ou a declaração da gestora) com a URL para download da versão mais recente.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer contratos de cessão

URL base de cada host: Ambientes (Hosts).

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
Response Body
{
"document_key": "8f1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"document_type": "assignment_contract",
"status": "signed",
"generation_method": "internal",
"signature_validation_method": "internal",
"document_template_key": "2a7c9e1b-3d5f-4b8a-9c0e-6f1a2b3c4d5e",
"required_parties": ["manager", "assignor"],
"upload_document_analyses": [],
"download_url": "url para download do documento"
}
Observação

O campo download_url traz a URL assinada para download do documento em sua versão mais atual: se o documento já estiver assinado, é a versão assinada. A URL expira e não deve ser guardada para consulta posterior.

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 Attached Document Status.
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.--
generation_methodstringComo o documento é gerado: internal (pela plataforma) ou external (enviado por upload).--
signature_validation_methodstringComo a assinatura é validada (por exemplo, internal ou external).--
upload_document_analysesarrayAnálises dos documentos enviados por upload. Vazio quando não há upload.--
download_urlstringURL de download do PDF.--

Erros​

StatusCódigoQuando acontece
404ACT000023assignment_contract_key não encontrado.
404ACT000087document_key não encontrado ou não pertence ao contrato indicado.

Erros de autenticação, permissão e host: veja Erros da API.