Inserção de Documentos do Ativo

Endpoint para enviar os documentos exigidos para um ativo do lote de cessão. O arquivo vai codificado em Base64, um documento por requisição.

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Escrita
Consultoria	consultant-api	Lotes
Cedente	assignor-api	Escrita

URL base de cada host: Ambientes (Hosts).

Onde estou no fluxo?

Você pode enviar os documentos logo depois de inserir o ativo (status pending_eligibility) ou depois do webhook pending_documentation, que indica que o ativo foi aprovado na elegibilidade e aguarda documentação. Um ativo reprovado por documento (denied com denied_by = document) volta para pending_documentation quando recebe um novo documento.

Quais documentos enviar?

Os tipos exigidos são definidos por produto e vêm na configuração de cessão, nos campos required_documents (antes da cessão) e after_assignment_required_documents (depois da cessão). Só esses tipos são aceitos.

• Duplicata mercantil (duplicata_mercantil): não é preciso enviar documento — a QI Tech gera o documento da duplicata a partir dos dados da nota fiscal. A chamada é aceita e devolve um document_key, mas nada é armazenado.
• Contrato parcelado (contract): veja Qual documento enviar no contrato parcelado.

O ativo só avança para pre_approved depois que todos os documentos exigidos forem enviados e validados.

Formato do documento

Arquivo em PDF, P7S ou XML, codificado em Base64, com até 10 MB. Outros formatos são recusados com TRC000166.

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âmetro	Tipo	Descrição
fund_class_key	string	Chave única do fundo (UUID).
assignment_configuration_key	string	Chave da configuração de cessão (UUID).
assignment_external_id	string	Identificador externo do lote, informado na criação do lote.
asset_external_id	string	O external_id informado na criação do ativo.

Request Body

{
    "document_type": "ccb",
    "document_b64": "aGVsbG8gd29ybGQgaWYgeW91IGRlY29kZWQgbWUsIGJlIGNhcmVmdWwuIEl0IG11c3QgYmUgYSBQREYgRmlsZSBvdGhlcndpc2UgSSB3aWxsIHJhaXNlIGFuIEVycm9yLg=="
}

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
document_type	string	obrigatório	Tipo do documento que está sendo enviado. Os valores aceitos são os configurados na configuração de cessão utilizada — veja os enumeradores abaixo.
document_b64	string	obrigatório	Conteúdo do arquivo codificado em Base64 (PDF, P7S ou XML; até 10 MB).

Valores de document_type (aceitos só quando constam da configuração de cessão):

Valor	Descrição
ccb	Cédula de Crédito Bancário — ativos do tipo CCB.
duplicata_servicos	Duplicata de serviços.
invoice	Nota fiscal.
cte	Conhecimento de Transporte Eletrônico.
discounted_contract	Contrato descontado.
contract	O próprio contrato parcelado cedido (o ativo), e não o contrato de cessão.
legal_fees_contract	Contrato de honorários advocatícios.
check	Cheque.
promissory_note	Nota promissória.
disbursement_receipt	Comprovante de desembolso.
vehicle_reservation_receipt	Comprovante de reserva do veículo — operações com garantia de veículo. Documento pós-cessão.

Qual documento enviar no contrato parcelado

No document_type contract, envie o contrato que está sendo cedido: o instrumento firmado entre o originador e o devedor, com as parcelas informadas na criação do ativo. Ele é o lastro do ativo.

Não envie aqui o contrato de cessão nem o termo de cessão. Esses documentos formalizam a transferência dos ativos ao fundo e têm fluxo próprio no documento da cessão.

Cada ativo recebe um PDF com o seu próprio contrato. Em um lote com três contratos (A, B e C), envie três arquivos: o contrato A no ativo A, o B no ativo B e o C no ativo C. Não junte vários contratos no mesmo PDF. Um ativo aceita um único documento de cada tipo; enviar outro contract para o mesmo ativo devolve TRC000035, a menos que o anterior tenha sido reprovado.

Dois momentos de envio de documento

Este endpoint atende a dois momentos distintos do fluxo, e o que muda entre eles é apenas o status do ativo:

• Antes da cessão. O ativo entra em pending_documentation depois de aprovado na elegibilidade individual e aguarda os documentos configurados como obrigatórios do produto. Com todos enviados, ele avança para pre_approved.
• Depois da cessão. Se a configuração de cessão exigir documentos pós-cessão, o ativo entra em pending_after_assignment_documentation após a liquidação do lote. É aqui que entra o comprovante de reserva do veículo (vehicle_reservation_receipt) das operações com garantia de veículo. Com todos enviados, o ativo avança para completed e é enviado o webhook completed do ativo, se você assina esse status. Também é possível acompanhar pela consulta do ativo.

A lista de documentos exigidos em cada momento é definida por produto e vem na resposta da configuração de cessão, nos campos required_documents (antes da cessão) e after_assignment_required_documents (depois da cessão). Enviar um document_type que não está configurado para aquela cessão, inclusive um valor que não existe, devolve TRC000032.

Response

STATUS

201

Response Body

{
    "document_key": "8e515a17-8b4d-49a3-aed6-47c9574e426a"
}

Atributos da resposta

Campo	Tipo	Descrição
document_key	string	Identificador único do documento gerado pela QI Tech (UUID).

Erros

Status	Código	Quando acontece
400	TRC000032	document_type não consta de required_documents nem de after_assignment_required_documents da configuração de cessão (inclui valores inexistentes).
400	TRC000034	document_b64 não é um Base64 válido.
400	TRC000155	Arquivo acima de 10 MB.
400	TRC000166	Formato não aceito. Formatos aceitos: PDF, P7S e XML.
404	TRC000020	Nenhum ativo com esse asset_external_id no lote.
409	TRC000026	O ativo não está num status que receba documentos (pending_eligibility, pending_documentation, denied por documento ou pending_after_assignment_documentation).
409	TRC000035	O ativo já tem um documento desse tipo que não foi reprovado.
409	TRC000162	O lote está denied ou discarded.

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

Próximos passos

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

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