Skip to main content

Send Suitability


Introduction​

This resource records the investor's suitability profile in the registration analysis.

In external distribution you send the profile, not the answers

Unlike the other surfaces, the external distribution integration does not answer the suitability questionnaire through the API — there is no form endpoint and no numbered answers are sent. You apply the suitability in your own channel and only report the result here: conservative, moderate or bold.

Available on
ProfileHost
Distributordistributor-api

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/suitability
METHOD
PUT
STATUS
202

Request body​

Request Body
{
"profile": "bold"
}

Body params​

FieldTypeDescriptionRequired
profilestringProfile enumeratorYes

profile is the only accepted field. Any other property in the body is rejected with QIT000001.

Profile​

EnumeratorDescription
conservativeConservative
moderateModerate
boldBold
not_applicableSuitability does not apply to this investor — see Suitability not applicable

Response​

The response returns the analysis registration data already updated, with the suitability object filled in:

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

When sending is required​

InvestorSuitability
Natural personRequired — without it the submit fails with IVR000150
Legal entity classified as retailRequired — without it the submit fails with IVR000133
Legal entity qualified or professionalOptional — simply do not call this endpoint

Suitability not applicable​

When suitability does not apply to the investor, send profile: "not_applicable" on this same endpoint:

Request Body
{
"profile": "not_applicable"
}

The analysis then records suitability: {"profile": "not_applicable"}.

not_applicable is exclusive to external distribution

This value is only accepted from external distribution integrations. On QI Tech's internal surfaces the declaration is rejected with IVR000244.

Sending can be repeated while the analysis is in pending_registry_data — the last profile sent replaces the previous one.

Errors​

StatusCodeWhen it happens
400IVR000018The analysis is not in pending_registry_data (it has already been sent or closed)
400QIT000001profile missing, outside the enumerator, or body with an extra property
404IVR000008Investor not found for the credentials used
400IVR000271Non-resident investor without profile: not_applicable
400IVR000133(at submit) retail legal entity without suitability
400IVR000150(at submit) natural person without suitability

Authentication, permission and host errors: see API Errors.