Skip to main content

Enviar Suitability


Introdução

Este recurso registra o perfil de suitability do investidor na análise cadastral.

Na distribuição externa você envia o perfil, não as respostas

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

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/suitability
MÉTODO
PUT
STATUS
202

Request body

Request Body
{
"profile": "bold"
}

Body params

CampoTipoDescriçãoObrigatório
profilestringEnumerador de ProfileSim

profile é o único campo aceito. Qualquer outra propriedade no corpo é recusada com QIT000001.

Profile

EnumeradorDescrição
conservativeConservador
moderateModerado
boldArrojado
not_applicableO 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:

Response Body
{
"natural_person": { "...": "..." },
"address": { "...": "..." },
"net_worth": { "...": "..." },
"suitability": {
"profile": "bold"
}
}

Quando o envio é obrigatório

InvestidorSuitability
Pessoa físicaObrigatório — sem ele o submit falha com IVR000150
Pessoa jurídica enquadrada como retailObrigatório — sem ele o submit falha com IVR000133
Pessoa jurídica qualified ou professionalOpcional — 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:

Request Body
{
"profile": "not_applicable"
}

A análise passa a registrar suitability: {"profile": "not_applicable"}.

not_applicable é exclusivo da distribuição externa

Este 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ódigoHTTPQuando ocorre
IVR000018400A análise não está em pending_registry_data
QIT000001400profile ausente, fora do enumerador, ou corpo com propriedade extra
IVR000008404Investidor não encontrado para as credenciais utilizadas
IVR000133400(no submit) pessoa jurídica retail sem suitability
IVR000150400(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.