Skip to main content
POST

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

A natural person the entity is verified through. The same body creates the key party and, on PUT, replaces it in full: an optional field you omit on PUT is cleared.

externalKeyPartyId
string
required

Your own id for this person, unique within the entity. Fixed at create.

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

"ent-test-0001"

isBeneficialOwner
boolean
required

true declares the person a beneficial owner (UBO), false a shareholder. Declare at least one person as a beneficial owner. A company whose people are all shareholders is refused at verification: submit answers 200 with status: incomplete and the company failed, the people already sent stay locked, and the company's status can read processing until you add a beneficial owner and submit again.

firstName
string
required

First name.

Required string length: 1 - 128
lastName
string
required

Last name.

Required string length: 1 - 128
dateOfBirth
string<date>
required

Date of birth, YYYY-MM-DD, not later than today (UTC); a later date answers 400 validation_error. Returned as a timestamp.

Example:

"2015-06-30"

birthCountry
string
required

Country of birth.

Pattern: ^[A-Za-z]{2}$
Example:

"US"

address
object
required

Residential address.

signerType
enum<string>

Optional. When present it must be individual; entity answers 422.

Available options:
individual
middleName
string

Middle name.

Maximum string length: 128
gender
enum<string>

Gender. Accepted and used for verification, but not echoed back.

Available options:
male,
female
email
string<email>

Contact email. ASCII local part only.

phone
object

Contact phone. Accepted and used for verification, but not echoed back.

uboOwning
enum<string>
default:none

Ownership band of the key party in the entity: none, 10+ (10 % or more) or 25+ (25 % or more). Recorded for compliance reporting. Defaults to none when omitted, including on a correction.

Available options:
none,
10+,
25+
isLegalSigner
boolean

Whether the person can sign for the entity. Recorded only.

Response

Recorded, or the same create repeated. Nothing is under review. gender and phone are accepted but not echoed.

A person key party. It has no status: a key party is never verified on its own, only with its entity at submit.

keyPartyId
string
required

Securitize's id for this key party. Store it.

Minimum string length: 1
Example:

"6aca84e5dc49fe8369dd1da4"

externalKeyPartyId
string
required

Your own id for this key party.

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

"ent-test-0001"

investorId
string
required

The entity this key party belongs to.

Minimum string length: 1
Example:

"6aca84e5dc49fe8369dd1da4"

signerType
enum<string>
required

The kind of key party.

Available options:
individual
uboOwning
enum<string>
default:none
required

Ownership band of the key party in the entity: none, 10+ (10 % or more) or 25+ (25 % or more). Recorded for compliance reporting. Defaults to none when omitted, including on a correction.

Available options:
none,
10+,
25+
isBeneficialOwner
boolean
required

Whether the person is declared a beneficial owner.

details
object
required

The person data Securitize holds for a key party. gender and phone are accepted on input but not returned.

isLegalSigner
boolean

Whether the person was declared a legal signer; absent when it was never sent.