Enviar Suitability
Introdução
Este recurso registra o perfil de suitability do investidor na análise cadastral.
Diferente das demais superfícies, a integração de distribuição externa não responde ao questionário de suitability pela API — não há endpoint de formulário e não se enviam respostas numeradas. Você aplica o suitability no seu próprio canal e informa aqui apenas o resultado: conservative, moderate ou bold.
Request
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/suitabilityPUT202Request body
{
"profile": "bold"
}
Body params
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
profile | string | Enumerador de Profile | Sim |
profile é o único campo aceito. Qualquer outra propriedade no corpo é recusada com QIT000001.
Profile
| Enumerador | Descrição |
|---|---|
conservative | Conservador |
moderate | Moderado |
bold | Arrojado |
not_applicable | O suitability não se aplica a este investidor — ver Suitability não aplicável |
Response
A resposta devolve os dados cadastrais da análise já atualizados, com o objeto suitability preenchido:
{
"natural_person": { "...": "..." },
"address": { "...": "..." },
"net_worth": { "...": "..." },
"suitability": {
"profile": "bold"
}
}
Quando o envio é obrigatório
| Investidor | Suitability |
|---|---|
| Pessoa física | Obrigatório — sem ele o submit falha com IVR000150 |
Pessoa jurídica enquadrada como retail | Obrigatório — sem ele o submit falha com IVR000133 |
Pessoa jurídica qualified ou professional | Opcional — simplesmente não chame este endpoint |
Suitability não aplicável
Quando o suitability não se aplica ao investidor, envie profile: "not_applicable" neste mesmo endpoint:
{
"profile": "not_applicable"
}
A análise passa a registrar suitability: {"profile": "not_applicable"}.
not_applicable é exclusivo da distribuição externaEste valor só é aceito de integrações de distribuição externa. Nas superfícies internas da QI Tech a declaração é recusada com IVR000244.
Pré-condições e erros
| Código | HTTP | Quando ocorre |
|---|---|---|
IVR000018 | 400 | A análise não está em pending_registry_data |
QIT000001 | 400 | profile ausente, fora do enumerador, ou corpo com propriedade extra |
IVR000008 | 404 | Investidor não encontrado para as credenciais utilizadas |
IVR000133 | 400 | (no submit) pessoa jurídica retail sem suitability |
IVR000150 | 400 | (no submit) pessoa física sem suitability |
O envio pode ser repetido enquanto a análise estiver em pending_registry_data — o último perfil enviado substitui o anterior.