Send Suitability
Introduction
This resource records the investor's suitability profile in the registration analysis.
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.
| Profile | Host |
|---|---|
| Distributor | distributor-api |
Base URL for each host: Environments (Hosts).
Request
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/suitabilityPUT202Request body
{
"profile": "bold"
}
Body params
| Field | Type | Description | Required |
|---|---|---|---|
profile | string | Profile enumerator | Yes |
profile is the only accepted field. Any other property in the body is rejected with QIT000001.
Profile
| Enumerator | Description |
|---|---|
conservative | Conservative |
moderate | Moderate |
bold | Bold |
not_applicable | Suitability 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:
{
"natural_person": { "...": "..." },
"address": { "...": "..." },
"net_worth": { "...": "..." },
"suitability": {
"profile": "bold"
}
}
When sending is required
| Investor | Suitability |
|---|---|
| Natural person | Required — without it the submit fails with IVR000150 |
Legal entity classified as retail | Required — without it the submit fails with IVR000133 |
Legal entity qualified or professional | Optional — 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:
{
"profile": "not_applicable"
}
The analysis then records suitability: {"profile": "not_applicable"}.
not_applicable is exclusive to external distributionThis 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
| Status | Code | When it happens |
|---|---|---|
| 400 | IVR000018 | The analysis is not in pending_registry_data (it has already been sent or closed) |
| 400 | QIT000001 | profile missing, outside the enumerator, or body with an extra property |
| 404 | IVR000008 | Investor not found for the credentials used |
| 400 | IVR000271 | Non-resident investor without profile: not_applicable |
| 400 | IVR000133 | (at submit) retail legal entity without suitability |
| 400 | IVR000150 | (at submit) natural person without suitability |
Authentication, permission and host errors: see API Errors.