InvestorAccounts

Get investor accounts

get
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault: 1
limitnumber · nullableOptionalDefault: 10
includestringOptionalExample: account,trades,individuals,legalEntities,trustedContacts
investorAccountTypestring · enumOptionalPossible values:
kycStatusstring · enumOptionalPossible values:
kybStatusstring · enumOptionalPossible values:
amlStatusstring · enumOptionalPossible values:
aicStatusstring · enumOptionalPossible values:
offeringIdanyOptional
regAQualifiedbooleanOptional
regCfQualifiedbooleanOptional
regDQualifiedbooleanOptional
emailstringOptional
accountIdstringOptionalExample: account_01j1xgme5qeqq97gpdztd7e4a6
userTypestring · enumOptionalPossible values:
startDatestring · nullableOptionalExample: 05/20/1990
endDatestring · nullableOptionalExample: 05/20/1990
userIdstringOptional
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/investor-accounts

Create investor account

post
Authorizations
X-API-KEYstringRequired
Body
investorAccountTypestring · enumRequiredPossible values:
emailstring · emailOptional
namestring · min: 1 · max: 100Optional
tidstringOptional
userIdanyRequired
Responses
post
/clients/api/v1/investor-accounts

Get investor account by id

get
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Query parameters
includestringOptionalExample: account,trades,individuals,legalEntities,trustedContacts
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/investor-accounts/{id}

Update investor account

patch
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
namestringOptional
emailstring · emailOptionalExample: [email protected]
Responses
patch
/clients/api/v1/investor-accounts/{id}

Last updated