Skip to main content
POST
Submit an investor for verification

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"

Response

The run happened. Read status and each subject's result.

Outcome of a submit. Read status; 200 alone does not mean everything was submitted.

status
enum<string>
required

submitted — everything was handed over; poll the investor for the verdict. incomplete — the run did not finish; read the subjects and call again.

Available options:
submitted,
incomplete
investor
object
required

The investor itself. An entity is submitted after its key parties, so not_attempted here means they were not all handed over.

keyParties
object[]
required

One entry per key party, both kinds, in no guaranteed order. Always empty for an individual.