This route is used to retrieve the details of accounts, given a set of search filters.
This endpoint is paginated, up to 25 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readAccount".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The key to search within the extraData property. Will be used in combination with "extraDataValueFilter". If "extraDataValueFilter" is not provided then this property is discarded.
The value to search within the extraData property. Will be used in combination with "extraDataKeyFilter". If "extraDataKeyFilter" is not provided then this property is discarded.
The comma delimited list of account ids to filter the account records. Up to 25 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of account correlation ids to filter the account records. Up to 25 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "accountCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of investor ids to filter the account records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of investor correlation ids to filter the account records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The organization identifier linked to the correlation ids provided in the "investorCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/account HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"secureExtraData": {
"some": "Sensitive Data"
},
"name": "text",
"bankAccount": {
"accountId": "111111111",
"accountName": "savings account",
"bankABA": "555555555",
"bankName": "Test Bank",
"bankSwift": "AAAA-BB-CC-123"
},
"contactInfo": [
{
"email": "[email protected]",
"phoneNumber": "832-426-4242"
}
],
"benefitPlanInvestor": true,
"type": "Individual",
"subType": "Individual",
"additionalTypeInfo": "LLCPartnership",
"relationshipType": "Brokerage",
"authorizedSigners": [
{
"name": "John Doe",
"primary": true,
"extraData": {
"externalId": "12345"
}
}
],
"beneficiaries": [
{
"name": "John Doe",
"beneficialOwnership": 40,
"individualInfo": {
"name": "John Doe",
"taxId": "123456789"
}
},
{
"name": "Jane Doe LLC",
"beneficialOwnership": 60,
"legalEntityInfo": {
"name": "Jane Doe LLC",
"type": "LLC",
"taxId": "987654321"
}
}
],
"questionnaires": [
{
"type": "AccreditedInvestor",
"title": "US Accredited Investor Questionnaire",
"questions": [
{
"question": {
"questionId": "q1",
"questionText": "Are you an accredited investor as defined by the SEC?",
"answerType": "Boolean"
},
"answers": [
{
"booleanValue": true
}
]
},
{
"question": {
"questionId": "q2",
"questionText": "Please select the criteria under which you qualify as an accredited investor.",
"answerType": "Choice",
"allowedAnswerValues": [
"Income exceeding $200,000 in each of the two most recent years",
"Net worth exceeding $1 million",
"Other criteria as defined by the SEC"
]
},
"answers": [
{
"choiceValue": "Net worth exceeding $1 million"
}
]
},
{
"question": {
"questionId": "q3",
"questionText": "Please provide any additional information or comments.",
"answerType": "Text"
},
"answers": [
{
"textValue": "No additional comments."
}
]
}
]
}
],
"custodian": {
"custodianId": "US1W12QDRJ9O"
},
"advisors": [
{
"advisorId": "US1W1V3RQK3X"
}
],
"accountId": "TEST1234",
"associatedInvestors": [
{
"investorId": "ORG1X123456",
"isPrimaryHolder": false
}
],
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"status": "sync",
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies account on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
]
}
]