Get Account
The Get Account API is designed to provide detailed information about a specific account, granting access to personal, financial, and other relevant details. It supports reporting, validation, and further processing, ensuring accurate and efficient account management.
POST
/account-api/v1/get-account
Request
The request body of the Get Account API must contain the following attributes to ensure precise and efficient retrieval of account information.
- Schema
- Example
| Attributes | Data Type | Description | Validations | Accepted Values |
|---|---|---|---|---|
accountNumber | String | StoneX Account Number | Required field with 8 digit alpha-numeric or numeric value without special characters. | a-Z, 0-9 |
entityNumber | String | StoneX Entity Number | Required field with 3 digit numeric value without special characters. | 0-9 |
{
"accountNumber": "10003382",
"entityNumber": "301"
}
Response
A successful request to the Get Account API will retrieve and return a structured response with the following attributes.
- Schema
- Example
| Attributes | Data Type |
|---|---|
accountNumber | String |
entityNumber | String |
registrationType | Registration Type |
main | Main |
mailingAddress | Mailing Address |
primaryOwner | Primary Owner |
associatedParties | Associated Parties |
electronicDelivery | Electronic Delivery |
financialProfile | Financial Profile |
{
"statusCode": 200,
"message": "Request successful.",
"data": {
"message": {
"registrationType": "Individual",
"main": {
"repCode": "JC01",
"proxyDisclosure": "L"
},
"electronicDelivery": {
"email": "[email protected]",
"statements": "False",
"confirms": "False",
"stonexCommunications": "True",
"investorCommunications": "True",
"prospectus": "True",
"taxDocuments": "False"
},
"mailingAddress": {
"street": "1549 SCOTT CENTER",
"city": "BALLSTON LAKE",
"stateProvince": "AL",
"country": "US",
"postalCode": "14781"
},
"accountNumber": "10003382",
"primaryOwner": {
"sourceOfFunds": [
"Employment",
"Other"
],
"otherSourceOfFund": "OTHERTESTING",
"firstName": "JOHNN",
"middleName": "DAVIDD",
"lastName": "DOE",
"citizenshipCountry": "US",
"birthDate": "1980-05-25",
"email": "[email protected]",
"legalAddress": {
"street": "62 BLUE SPRUCE LN",
"city": "BALLSTON LAKE",
"stateProvince": "NY",
"country": "US",
"postalCode": "12019"
},
"occupation": "AccountingOrAuditing",
"jobTitle": "SOFTWARE DEVELOPER",
"employerName": "ABC ACCOUNTING",
"employerPhoneNumber": "5205123987",
"employerAddress": {
"street": "2 PERIMETER PARK S",
"city": "BIRMINGHAM",
"stateProvince": "AL",
"country": "US",
"postalCode": "35243"
},
"taxIdType": "TaxId",
"taxIdNumber": "123456788",
"governmentIdentification": {},
"phoneNumberCell": "2059871212",
"phoneNumberHome": "9992986495",
"phoneNumberBusiness": "1234567890",
"caisInformation": {
"customerType": [
"Advisor"
],
"accountType": [
"Institution",
"Retirement"
],
"role": "AUTH"
},
"trustedContact": {
"name": "JANE SMITH",
"relationship": "SPOUSE",
"phoneNumber": "2056786578",
"email": "[email protected]",
"address": {
"street": "459 SOUTH SEGUNBAGICHA",
"city": "RAMNA",
"stateProvince": "NY",
"country": "US",
"postalCode": "35243"
}
},
"affiliation": {
"political": "True",
"relationship": "CHILD",
"name": "JOHN DOE",
"organization": "EXAMPLE ORGANIZATION",
"address": {
"street": "1234 ELMWOOD CRESCENT AVENUES SPRINGFIEDS IL BOOMER",
"city": "BOSTON",
"stateProvince": "AL",
"country": "US",
"postalCode": "35243"
}
},
"maritalStatus": "Single",
"dependents": "3"
},
"associatedParties": [
{
"role": "Associate",
"financialProfile": {
"investmentExperience": {
"stocks": "Average",
"bonds": "Extensive",
"options": "Limited",
"mutualFunds": "Extensive",
"annuities": "None"
}
},
"firstName": "ROB",
"middleName": "JACK",
"lastName": "TEST1",
"suffix": "MR",
"citizenshipCountry": "US",
"birthDate": "1983-12-13",
"email": "[email protected]",
"legalAddress": {
"street": "2 PERIMETER PARK S",
"city": "BOSTON",
"stateProvince": "MA",
"country": "US",
"postalCode": "22333"
},
"employerName": "STONEX1",
"employerPhoneNumber": "5205123987",
"employerAddress": {
"street": "2 PERIMETER PARK S",
"city": "BOSTON",
"stateProvince": "MA",
"country": "US",
"postalCode": "21345"
},
"taxIdType": "TaxId",
"taxIdNumber": "123456789",
"governmentIdentification": {},
"phoneNumberCell": "2059871212",
"caisInformation": {
"customerType": [
"Advisor"
],
"accountType": [],
"role": "AUTH"
},
"maritalStatus": "Married",
"dependents": "2"
}
],
"financialProfile": {
"annualIncome": "F",
"netWorth": "B",
"liquidNetWorth": "B",
"liquidityNeed": "None",
"liquidityTime": "Medium",
"taxBracket": "TenToFifteen",
"investmentTimeHorizon": "OneToThreeYears",
"investmentProfile": "Moderate",
"investmentExperience": {
"stocks": "Limited",
"bonds": "None",
"options": "None",
"mutualFunds": "Limited",
"annuities": "Limited"
}
},
"beneficiaries": [
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 1",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2003-07-23",
"taxIdNumber": "123456770",
"relationship": "Spouse",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 2",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2006-01-30",
"taxIdNumber": "123456771",
"relationship": "Other",
"percentageAllocation": "10"
}
]
}
},
"errors": [],
"traceId": "00-2bf2fc581e60db2190bc41f9ff817e07-ede43ddb00d2e4a5-01",
"hasErrors": false
}
Any validation failure associated with the account number will result in an error response and will eventually terminate the account information retrieval process.