Skip to main content
GET
Get an investor

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"

Query Parameters

include
enum<string>[]

Expansions to add, repeated for several values: ?include=details&include=documents. An unknown value answers 400 invalid_include.

Available options:
details,
documents

Response

The investor. email, riskLevel and createdAt are absent for an investor you have limited access to.

One investor. investorId, externalInvestorId and status are always present. email, riskLevel and createdAt are present unless you have limited access to the investor. details and documents are present only when requested with include.

investorId
string
required

Securitize's id for this investor.

Minimum string length: 1
Example:

"6aca84e5dc49fe8369dd1da4"

externalInvestorId
string
required

Your own id.

Pattern: ^[A-Za-z0-9._-]{1,128}$
Example:

"ent-test-0001"

status
enum<string>
required

The investor's verification state.

  • none — created, nothing under review. An investor stays here until you submit it.
  • processing — under review.
  • verified — verified.
  • manual-review — a Securitize operator is reviewing it. Not a rejection.
  • updates-required — Securitize needs updated information; contact Securitize support.
  • expired — the verification lapsed; contact Securitize support.
  • rejected — final.

When status becomes verified — at submit, or after Securitize's screening and compliance review — depends on your agreement with Securitize. Treat any value you do not recognise as "not verified" rather than failing.

Available options:
none,
processing,
verified,
manual-review,
updates-required,
expired,
rejected
email
string<email>

The email sent at create.

riskLevel
enum<string>

Risk level computed by Securitize from the investor's countries.

Available options:
none,
low,
medium,
high
createdAt
string<date-time>

When the investor was created.

details
object

Present with include=details. The company block for an entity (has entityName), the person block for an individual (has firstName).

documents
object[]

Present with include=documents. The investor's own documents — an individual's identity documents, an entity's company documents. Key-party documents are listed with the key parties.