Análise do lote de contratos

A análise é a segunda das duas validações: com o lastro pronto, o lote inteiro é avaliado antes da assinatura. Quem analisa pode aprovar, recusar ou abrir uma pendência — uma pergunta ou um pedido de documento — que você responde para a análise continuar.

Chamada	Quem chama
Enviar para análise	Gestora, consultoria ou cedente
Responder a uma pendência	Gestora, consultoria ou cedente
Decidir o lote	Gestora
Abrir uma pendência	Gestora
Validar um documento	Gestora

A administradora do fundo também analisa, decide e abre pendências, pelo portal. As chamadas de decisão estão na API para a gestora que faz a própria análise.

Disponível em

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

URL base de cada host: Ambientes (Hosts).

Enviar para análise

Leva o lote de pending_asset_documents a pending_administrator_analysis. Exige que todos os documentos da configuração existam e que nenhum esteja aguardando geração ou validação. Se você não chamar, a QI Tech envia o lote sozinha assim que o lastro fica pronto; chamar só antecipa.

ENDPOINT

/trade_contract/fund_class/{fund_class_key}/assignment/{assignment_key}/submit

MÉTODO

PUT

Sem body.

Response Body — 202

{
    "assignment_key": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
    "status": "pending_administrator_analysis"
}

Responder a uma pendência

Responde a uma pendência aberta, com texto, com um documento já anexado ao lote, ou com os dois. Com a resposta, o lote volta de pending_annotation para pending_administrator_analysis. As pendências abertas estão em annotations na consulta do lote, com status opened.

ENDPOINT

/trade_contract/fund_class/{fund_class_key}/assignment/{assignment_key}/annotation/{annotation_key}/answer

MÉTODO

PUT

Request Body

{
    "response": "Segue o pedido de compra assinado pelo comprador.",
    "response_document_key": "6f5e4d3c-2b1a-4098-8f7e-6d5c4b3a2918"
}

Campo	Tipo	Obrigatoriedade	Descrição
response	string	condicional	Texto da resposta, até 500 caracteres.
response_document_key	string	condicional	document_key de um documento que responde à pendência. Envie antes o arquivo como documento adicional.

Envie ao menos um dos dois (TRC000017).

Response Body — 202

{
    "annotation_key": "2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a",
    "status": "answered"
}

Decidir o lote

Somente gestora. Aprova ou recusa o lote em pending_administrator_analysis ou pending_annotation. Aprovado, o lote vai para pending_signature; recusado, para rejected.

ENDPOINT

/trade_contract/fund_class/{fund_class_key}/assignment/{assignment_key}/approval

MÉTODO

PUT

Request Body

{
    "decision": "rejected",
    "denial_reason": "manual",
    "denial_metadata": {
        "comment": "Pedido de compra sem a assinatura do comprador."
    }
}

Campo	Tipo	Obrigatoriedade	Descrição
decision	string	obrigatório	approved ou rejected.
denial_reason	string	opcional	Na recusa: risk_analysis (padrão) ou manual.
denial_metadata	object	opcional	Detalhes livres da recusa, guardados no histórico do lote.

Response Body — 202

{
    "assignment_key": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
    "status": "rejected"
}

Abrir uma pendência

Somente gestora. Abre uma pendência no lote em análise, com texto ou com um documento, e leva o lote a pending_annotation.

ENDPOINT

/trade_contract/fund_class/{fund_class_key}/assignment/{assignment_key}/annotation

MÉTODO

POST

Request Body

{
    "kind": "text",
    "message": "Envie o pedido de compra assinado pelo comprador."
}

Campo	Tipo	Obrigatoriedade	Descrição
kind	string	obrigatório	text ou document.
message	string	condicional	Texto da pendência, até 500 caracteres.
message_document_key	string	condicional	Documento do lote que acompanha a pendência.

Envie message, message_document_key ou os dois.

Response Body — 201

{
    "annotation_key": "2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a",
    "status": "opened"
}

Validar um documento

Somente gestora. Valida ou recusa um documento em pending_validation, no lugar da validação automática. Recusar um documento recusa o lote, com o motivo asset_documents.

ENDPOINT

/trade_contract/fund_class/{fund_class_key}/assignment/{assignment_key}/document/{document_key}/validation

MÉTODO

PUT

Request Body

{
    "decision": "validated"
}

Campo	Tipo	Obrigatoriedade	Descrição
decision	string	obrigatório	validated ou rejected.
asset_documents_key	string	opcional	Chave da validação de lastro do documento, devolvida no envio.

Response Body — 202

{
    "document_key": "3c2b1a09-8f7e-4d6c-b5a4-938271605f4e",
    "status": "validated"
}

Erros

Status	Código	Quando acontece
400	QIT000001	O body não segue o formato.
404	TRC000011	Não existe lote com essa assignment_key neste fundo.
409	TRC000012	O lote não está num status que aceita a operação.
409	TRC000021	Ainda há documentos aguardando geração ou validação.
409	TRC000041	Falta um documento exigido pela configuração, ou ele foi recusado.
400	TRC000017	Resposta de pendência sem texto e sem documento.
409	TRC000033	A pendência já foi respondida.
404	TRC000015	Não existe documento com essa document_key.
403	QIT000005	A integração não é da gestora do fundo, ou a chamada é exclusiva da gestora.
403	QIT000004 / QIT000008	O cedente ou a consultoria da integração não tem acesso a este lote.