Send the investor's compact suitability

curl --request POST \
  --url https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/suitability/compact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isLicensedSecuritiesProfessional": false,
  "isAffiliatedWithSecuritiesFirm": false,
  "annualIncome": "100k_to_250k",
  "investmentApproach": "aggressive_growth",
  "investmentHorizon": "under_3_years",
  "lossTolerance": "over_30_percent",
  "acceptsIlliquidity": true,
  "occupation": "employee",
  "declaresLawfulOriginOfFunds": true,
  "assetExperience": {
    "equities": {
      "experience": "some",
      "tradingFrequency": "occasionally"
    }
  },
  "declarations": {
    "subscriberAgreementReviewed": true,
    "formCrsReviewed": true,
    "affirmationsConfirmed": true
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    isLicensedSecuritiesProfessional: false,
    isAffiliatedWithSecuritiesFirm: false,
    annualIncome: '100k_to_250k',
    investmentApproach: 'aggressive_growth',
    investmentHorizon: 'under_3_years',
    lossTolerance: 'over_30_percent',
    acceptsIlliquidity: true,
    occupation: 'employee',
    declaresLawfulOriginOfFunds: true,
    assetExperience: {equities: {experience: 'some', tradingFrequency: 'occasionally'}},
    declarations: {
      subscriberAgreementReviewed: true,
      formCrsReviewed: true,
      affirmationsConfirmed: true
    }
  })
};

fetch('https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/suitability/compact', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/suitability/compact"

payload = {
    "isLicensedSecuritiesProfessional": False,
    "isAffiliatedWithSecuritiesFirm": False,
    "annualIncome": "100k_to_250k",
    "investmentApproach": "aggressive_growth",
    "investmentHorizon": "under_3_years",
    "lossTolerance": "over_30_percent",
    "acceptsIlliquidity": True,
    "occupation": "employee",
    "declaresLawfulOriginOfFunds": True,
    "assetExperience": { "equities": {
            "experience": "some",
            "tradingFrequency": "occasionally"
        } },
    "declarations": {
        "subscriberAgreementReviewed": True,
        "formCrsReviewed": True,
        "affirmationsConfirmed": True
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "completed",
  "verificationStatus": "verified"
}

Suitability and DLT test

Send the investor's compact suitability

Records a shorter suitability for an individual — the part of Securitize’s investor profile that a Securitize Markets brokerage account for stocks and ‘40 Act funds requires — in one call, and answers the verdict in the same response. Its fields have the same names and values as the full suitability’s; fields outside the compact set are ignored. It can be sent at any investor status, and for an investor you have limited access to.

Individuals only. An entity answers 422 with details.reason: investor_type_not_supported and nothing is stored: send it the full suitability.

The verdict is in verificationStatus, decided as for the full suitability:

verified — investmentApproach is aggressive_growth, lossTolerance is over_30_percent, acceptsIlliquidity is true, and both isLicensedSecuritiesProfessional and isAffiliatedWithSecuritiesFirm are false. Once the investor’s own status (GET /investors/{investorId}) is verified, their Securitize Markets brokerage account is approved too.
rejected — investmentApproach is not aggressive_growth, lossTolerance is not over_30_percent, or acceptsIlliquidity is false, whatever the other answers. A Securitize Markets brokerage account is not available to the investor; tell them: “Based on your answers, a Securitize Markets brokerage account is not available to you at this time.”
processing — the answers above qualify, but isLicensedSecuritiesProfessional or isAffiliatedWithSecuritiesFirm is true. Securitize’s compliance team reviews the account and may contact the investor; the investor.suitability.updated webhook announces its decision.

Securitize can change which answers lead to each verdict: act on the verificationStatus you receive, not on the answers you sent.

Decided once. Once the verdict is verified, or the full suitability is complete — sent by you, another partner or the investor on Securitize — a call writes nothing and answers 200 with the current state. While the verdict is processing or rejected, a call answers 422 with details.reason suitability_under_review or suitability_not_approved and stores nothing. A retry after a timeout therefore answers the verdict the first call reached.

Toward the full suitability. The compact answers are recorded on the same questions as the full suitability. While the verdict is verified, the investor can complete the full one later, through POST /investors/{investorId}/suitability or on Securitize.

An invalid body answers 400 with every field to fix and stores nothing. employerName is required when isLicensedSecuritiesProfessional is true, and refused when it is false. The three declarations must be true: they are the same block as the full suitability’s.

POST

investors

{investorId}

suitability

compact

Send the investor's compact suitability

curl --request POST \
  --url https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/suitability/compact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isLicensedSecuritiesProfessional": false,
  "isAffiliatedWithSecuritiesFirm": false,
  "annualIncome": "100k_to_250k",
  "investmentApproach": "aggressive_growth",
  "investmentHorizon": "under_3_years",
  "lossTolerance": "over_30_percent",
  "acceptsIlliquidity": true,
  "occupation": "employee",
  "declaresLawfulOriginOfFunds": true,
  "assetExperience": {
    "equities": {
      "experience": "some",
      "tradingFrequency": "occasionally"
    }
  },
  "declarations": {
    "subscriberAgreementReviewed": true,
    "formCrsReviewed": true,
    "affirmationsConfirmed": true
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    isLicensedSecuritiesProfessional: false,
    isAffiliatedWithSecuritiesFirm: false,
    annualIncome: '100k_to_250k',
    investmentApproach: 'aggressive_growth',
    investmentHorizon: 'under_3_years',
    lossTolerance: 'over_30_percent',
    acceptsIlliquidity: true,
    occupation: 'employee',
    declaresLawfulOriginOfFunds: true,
    assetExperience: {equities: {experience: 'some', tradingFrequency: 'occasionally'}},
    declarations: {
      subscriberAgreementReviewed: true,
      formCrsReviewed: true,
      affirmationsConfirmed: true
    }
  })
};

fetch('https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/suitability/compact', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://partners-api.sandbox.securitize.io/investors/v1/onboarding-reliance/investors/{investorId}/suitability/compact"

payload = {
    "isLicensedSecuritiesProfessional": False,
    "isAffiliatedWithSecuritiesFirm": False,
    "annualIncome": "100k_to_250k",
    "investmentApproach": "aggressive_growth",
    "investmentHorizon": "under_3_years",
    "lossTolerance": "over_30_percent",
    "acceptsIlliquidity": True,
    "occupation": "employee",
    "declaresLawfulOriginOfFunds": True,
    "assetExperience": { "equities": {
            "experience": "some",
            "tradingFrequency": "occasionally"
        } },
    "declarations": {
        "subscriberAgreementReviewed": True,
        "formCrsReviewed": True,
        "affirmationsConfirmed": True
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "completed",
  "verificationStatus": "verified"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL (the host root, not under the base URL), with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed. The token identifies your partner account, so you never send a partner id, and every record you create is scoped to you.

Path Parameters

investorId

string

required

The investorId Securitize returned when you created the investor. Not your externalInvestorId.

Identifier assigned by Securitize, opaque and specific to your partner account. Store it as an opaque string.

Minimum string length: 1

Example:

"6aca84e5dc49fe8369dd1da4"

Body

application/json

The compact suitability of an individual, complete in one call. Each field has the same values as in the full suitability.

isLicensedSecuritiesProfessional

boolean

required

Registered or licensed to sell securities in any jurisdiction (FINRA, FCA, BaFin or equivalent).

isAffiliatedWithSecuritiesFirm

boolean

required

The investor or immediate family is employed by or associated with a securities firm, brokerage or regulated exchange.

annualIncome

enum<string>

required

Annual income, in US dollars.

Available options:

under_50k,

50k_to_100k,

100k_to_250k,

over_250k

investmentApproach

enum<string>

required

Investment approach.

Available options:

capital_preservation,

balanced_growth,

aggressive_growth

investmentHorizon

enum<string>

required

How long the investor expects to hold investments.

Available options:

under_3_years,

3_to_5_years,

over_5_years

lossTolerance

enum<string>

required

Loss the investor could bear without affecting their standard of living, as a share of invested capital.

Available options:

up_to_10_percent,

up_to_30_percent,

over_30_percent

acceptsIlliquidity

boolean

required

The investor understands securities may be illiquid and has no immediate need for liquidity. false rejects the suitability.

assetExperience

object

required

Experience with equities, the only asset class the compact suitability asks about.

Show child attributes

declarations

object

required

Your attestation that the investor completed the documents step. All three must be true.

Show child attributes

employerName

string

The firm the investor is licensed through. Required when isLicensedSecuritiesProfessional is true; omit it when false.

Required string length: 1 - 255

occupation

enum<string>

Occupation.

Available options:

employee,

self_employed,

retired,

student,

unemployed

declaresLawfulOriginOfFunds

boolean

The investor's resources and income come from lawful activities.

isPoliticallyExposedPerson

boolean

The investor or immediate family is currently a politically exposed person. Optional in the compact suitability; when sent, it is stored and returned, and it does not change the verdict.

Response

The current state. Without a change when the verdict was already verified or the full suitability complete.

The investor's suitability state.

status

enum<string>

required

Whether the questionnaire is complete.

Available options:

not_started,

completed

verificationStatus

enum<string>

required

Securitize's verdict. none — not verified. verified — verified. processing — under review by Securitize's compliance team. rejected — not approved. Only verified counts as verified; contact Securitize if another value persists.

Available options:

none,

processing,

verified,

rejected

Get started

Guides

Concepts

Help

API reference

Send the investor's compact suitability

Authorizations

Path Parameters

Body

Response