Pular para o conteúdo principal

Inserção de Documentos do Ativo

Endpoint para enviar os documentos obrigatórios associados a um ativo do lote de cessão. Os documentos devem ser enviados em formato PDF codificado em Base64.

Onde estou no fluxo?

O envio de documentos ocorre após a inserção do ativo e após o ativo ter sido aprovado na elegibilidade individual. Você receberá um webhook com o status pending_documentation indicando que o ativo está aguardando documentação.

Duplicatas: quando enviar documentos?

Ativos do tipo duplicata_mercantil não exigem envio de documentos — a documentação é gerada automaticamente pelo sistema a partir dos dados da nota fiscal. Já ativos do tipo duplicata_servicos exigem o envio de documentos por este endpoint.

Formato do documento

O arquivo enviado deve ser um PDF válido codificado em Base64. Outros formatos serão rejeitados com erro.

Request

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/asset/{asset_external_id}/document
MÉTODO
POST

Path params

ParâmetroTipoDescrição
asset_external_idstringO external_id informado na criação do ativo.
Request Body
{
"document_type": "ccb",
"document_b64": "aGVsbG8gd29ybGQgaWYgeW91IGRlY29kZWQgbWUsIGJlIGNhcmVmdWwuIEl0IG11c3QgYmUgYSBQREYgRmlsZSBvdGhlcndpc2UgSSB3aWxsIHJhaXNlIGFuIEVycm9yLg=="
}

Atributos do body

CampoTipoObrigatoriedadeDescrição
document_typestringobrigatórioTipo do documento que está sendo enviado. Valores aceitos: ccb ou duplicata_servicos.
document_b64stringobrigatórioConteúdo do arquivo PDF codificado em Base64.

Response

STATUS
201
Response Body
{
"document_key": "8e515a17-8b4d-49a3-aed6-47c9574e426a"
}

Atributos da resposta

CampoTipoDescrição
document_keystringIdentificador único do documento gerado pela QI Tech (UUID).

Possíveis erros

STATUS
404
Ativo não encontrado

O asset_external_id informado na URL não corresponde a nenhum ativo do lote. Verifique se o identificador está correto e se o ativo pertence ao lote informado.

{
"title": "Asset not found",
"description": "Asset not found",
"translation": "Ativo não foi encontrado",
"code": "TRC000020"
}
STATUS
400
Tipo de documento inválido para esta configuração

O valor informado em document_type não corresponde a nenhum tipo de documento configurado para esta cessão. Verifique quais tipos de documento são aceitos na configuração de cessão utilizada.

{
"title": "Invalid documents",
"description": "Required documents type are invalid",
"translation": "Tipo de Documentos requeridos sao inválidos",
"code": "TRC000032"
}
STATUS
400
Tipo de documento não reconhecido

O tipo de documento informado não é reconhecido pelo sistema. Verifique se o valor de document_type está correto.

{
"title": "Invalid document type",
"description": "Invalid document type",
"translation": "Tipo de documento invalido",
"code": "TRC000033"
}
STATUS
400
Formato do documento inválido

O arquivo enviado não está em formato PDF válido ou a codificação Base64 está incorreta. Verifique se o arquivo é um PDF válido e se a codificação Base64 foi feita corretamente.

{
"title": "Invalid document format",
"description": "Invalid document format",
"translation": "Formato do documento invalido",
"code": "TRC000034"
}

Próximos passos

Após enviar todos os documentos exigidos, o fluxo continua com:

  1. Encerramento da inserção — sinalize que todos os ativos e documentos foram inseridos para que o lote siga para a análise de elegibilidade.