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.

Disponível em

Perfil	Host
Distribuidor	distributor-api

URL base de cada host: Ambientes (Hosts).

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

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:

Response Body

{
  "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:

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.

O envio pode ser repetido enquanto a análise estiver em pending_registry_data — o último perfil enviado substitui o anterior.

Erros

Status	Código	Quando acontece
400	IVR000018	A análise não está em pending_registry_data (já foi enviada ou encerrada)
400	QIT000001	profile ausente, fora do enumerador, ou corpo com propriedade extra
404	IVR000008	Investidor não encontrado para as credenciais utilizadas
400	IVR000271	Investidor não residente sem profile: not_applicable
400	IVR000133	(no submit) pessoa jurídica retail sem suitability
400	IVR000150	(no submit) pessoa física sem suitability

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