Get Account
Retrieve information about a StoneX account.
POST
/account-api/v1/get-account
Request
The below attributes are required in the request body.
- Schema
- Example
| Attributes | Data Type | Length | Description |
|---|---|---|---|
accountNumber | String | 8 | StoneX Account Number |
{
"accountNumber": "84338611"
}
Response
- Schema
- Example
A successful request will respond with a result containing the account number, account status & all the current account data.
| Attributes | Data Type |
|---|---|
accountNumber | String |
subNumber | Integer |
accountStatus | Account Status |
registrationType | Registration Type |
main | Main |
mailingAddress | Mailing Address |
primaryOwner | Primary Owner |
associatedParties | Associated Parties |
electronicDelivery | Electronic Delivery |
financialProfile | Financial Profile |
largeTraders | Large Traders |
transferOfDeathBeneficiaries | T.O.D. Beneficiaries |
retirementBenes | Retirement Beneficiaries |
{
"statusCode": 200,
"message": "Request successful.",
"data": {
"accountStatus": "Open",
"accountName": "S MITCHELL & S PATEL & S PATELAA & S PATELBB & S PATELCC JTWROS",
"registrationType": "IndividualJointForeign",
"main": {
"marginIndicator": "false",
"optionTradingLevel": "",
"repCode": "JC01",
"sweepIndicator": "true"
},
"electronicDelivery": {
"email": "TEST.PERSON@EXAMPLE.COM",
"statements": "false",
"confirms": "true",
"stonexCommunications": "true",
"investorCommunications": "true",
"prospectus": "true",
"taxDocuments": "false"
},
"mailingAddress": {
"street": "193 NOYATOLA MOGHBAZAR",
"city": "RAMNA",
"stateProvince": "",
"country": "BG",
"postalCode": "1217"
},
"mailingAddressString": "193 NOYATOLA MOGHBAZAR RAMNA BANGLADESH 1217",
"accountNumber": "84338611",
"subNumber": "301",
"primaryOwner": {
"customerId": "265904400231400242",
"nameType": "Individual",
"name1": "SAMANTHA",
"name2": "GANI",
"name3": "MITCHELL",
"name4": "JR",
"citizenshipCountry": "BG",
"birthDate": "1980-05-25",
"email": "CYNTHIA.MEYER.DOE@EXAMPLE.COM",
"legalAddress": {
"street": "193 NOYATOLA MOGHBAZAR",
"city": "DHAKA",
"stateProvince": "",
"country": "BG",
"postalCode": "1217"
},
"occupation": "MedicalOrDental",
"jobTitle": "DENTIST",
"jobIndustry": "HEALTHCAREMEDICALSERVICES",
"employerName": "SMILE DENTAL",
"employerPhoneRegionCode": "54",
"employerPhoneNumber": "1143907595",
"employerAddress": {
"street": "459 SOUTH SEGUNBAGICHA ",
"city": "RAMNA",
"stateProvince": "",
"country": "BG",
"postalCode": "1217"
},
"governmentIdentification": {
"governmentId1": {
"idType": "NationalId",
"idNumber": "345987432",
"idLocation": "BG",
"idIssueDate": "2020-01-01",
"idExpiration": "2024-01-01"
},
"governmentId2": {
"idType": "Passport",
"idNumber": "E00007734",
"idLocation": "BG",
"idIssueDate": "2020-01-01",
"idExpiration": "2030-01-01"
}
},
"sourceOfFunds": "Gift",
"phoneRegionCell": "1",
"phoneNumberCell": "1143907595",
"phoneNumberHome": "",
"phoneNumberBusiness": "",
"caisCustomerType": [
"Foreign"
],
"trustedContact": {
"name": "JANE SMITH",
"relationship": "SPOUSE",
"phoneRegionCode": "AF",
"phoneNumber": "2056786578",
"email": "JANE.SMITH@EXAMPLE.COM",
"address": {
"street": "459 SOUTH SEGUNBAGICHA ",
"city": "RAMNA",
"country": "BG",
"postalCode": "1217"
}
},
"maritalStatus": "Single",
"dependents": "0"
},
"associatedParties": [
{
"customerId": "265904199550199562",
"role": "Secondary",
"tradingAuthority": "Full",
"nameType": "Individual",
"name1": "SMITHBB",
"name2": "",
"name3": "PATELBB",
"name4": "",
"citizenshipCountry": "BG",
"birthDate": "1987-05-22",
"email": "SMITH.PATEL.DOE@EXAMPLE.COM",
"legalAddress": {
"street": "1549 SCOTT CENTER RD",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
},
"occupation": "Retired",
"jobTitle": "",
"jobIndustry": "",
"employerName": "",
"employerPhoneRegionCode": "",
"employerPhoneNumber": "",
"employerAddress": {
"street": " ",
"city": "",
"stateProvince": "",
"country": "US",
"postalCode": ""
},
"taxIdType": "SSN",
"taxIdNumber": "987453211",
"governmentIdentification": {
"governmentId1": {
"idType": "DriversLicense",
"idNumber": "A7654370",
"idLocation": "BG",
"idIssueDate": "2020-01-01",
"idExpiration": "2024-01-01"
},
"governmentId2": {
"idType": "Passport",
"idNumber": "E00007738",
"idLocation": "AL",
"idIssueDate": "2020-01-01",
"idExpiration": "2030-01-01"
}
},
"sourceOfFunds": "Retirement",
"phoneRegionCell": "1",
"phoneNumberCell": "1143907527",
"phoneNumberHome": "",
"phoneNumberBusiness": "",
"caisCustomerType": [
"Foreign"
],
"trustedContact": {
"name": "JANEBB SMITHBB",
"relationship": "SPOUSE",
"phoneRegionCode": "AF",
"phoneNumber": "2056786579",
"email": "JANEBB.SMITHBB@EXAMPLE.COM",
"address": {
"street": "1549 SCOTT CENTER RD ",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
}
},
"maritalStatus": "Single",
"dependents": "0"
},
{
"customerId": "265904423055423063",
"role": "Secondary",
"tradingAuthority": "Full",
"nameType": "Individual",
"name1": "SMITHCC",
"name2": "",
"name3": "PATELCC",
"name4": "",
"citizenshipCountry": "BG",
"birthDate": "1989-05-22",
"email": "SMITHCC.PATELCC.DOE@EXAMPLE.COM",
"legalAddress": {
"street": "1549 SCOTT CENTER RD",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
},
"occupation": "Retired",
"jobTitle": "",
"jobIndustry": "",
"employerName": "",
"employerPhoneRegionCode": "",
"employerPhoneNumber": "",
"employerAddress": {
"street": " ",
"city": "",
"stateProvince": "",
"country": "US",
"postalCode": ""
},
"taxIdType": "SSN",
"taxIdNumber": "987453211",
"governmentIdentification": {
"governmentId1": {
"idType": "DriversLicense",
"idNumber": "A7654372",
"idLocation": "BG",
"idIssueDate": "2020-01-01",
"idExpiration": "2024-01-01"
},
"governmentId2": {
"idType": "Passport",
"idNumber": "E00007731",
"idLocation": "AL",
"idIssueDate": "2020-01-01",
"idExpiration": "2030-01-01"
}
},
"sourceOfFunds": "Retirement",
"phoneRegionCell": "1",
"phoneNumberCell": "1143907522",
"phoneNumberHome": "",
"phoneNumberBusiness": "",
"caisCustomerType": [
"Foreign"
],
"trustedContact": {
"name": "JANECC SMITHCC",
"relationship": "SPOUSE",
"phoneRegionCode": "AF",
"phoneNumber": "2056786579",
"email": "JANECC.SMITHCC@EXAMPLE.COM",
"address": {
"street": "1549 SCOTT CENTER RD ",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
}
},
"maritalStatus": "Single",
"dependents": "0"
},
{
"customerId": "265904714480714487",
"role": "Secondary",
"tradingAuthority": "Full",
"nameType": "Individual",
"name1": "SMITH",
"name2": "",
"name3": "PATEL",
"name4": "",
"citizenshipCountry": "US",
"birthDate": "1980-05-25",
"email": "SMITH.PATEL.DOE@EXAMPLE.COM",
"legalAddress": {
"street": "1549 SCOTT CENTER RD",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
},
"occupation": "Retired",
"jobTitle": "",
"jobIndustry": "",
"employerName": "",
"employerPhoneRegionCode": "",
"employerPhoneNumber": "",
"employerAddress": {
"street": " ",
"city": "",
"stateProvince": "",
"country": "US",
"postalCode": ""
},
"taxIdType": "SSN",
"taxIdNumber": "987453211",
"governmentIdentification": {
"governmentId1": {
"idType": "DriversLicense",
"idNumber": "A7654378",
"idLocation": "BG",
"idIssueDate": "2020-01-01",
"idExpiration": "2024-01-01"
},
"governmentId2": {
"idType": "Passport",
"idNumber": "E00007734",
"idLocation": "AL",
"idIssueDate": "2020-01-01",
"idExpiration": "2030-01-01"
}
},
"sourceOfFunds": "Retirement",
"phoneRegionCell": "1",
"phoneNumberCell": "1143907525",
"phoneNumberHome": "",
"phoneNumberBusiness": "",
"caisCustomerType": [
"Foreign"
],
"trustedContact": {
"name": "JANE SMITH",
"relationship": "SPOUSE",
"phoneRegionCode": "AF",
"phoneNumber": "2056786578",
"email": "JANE.SMITH@EXAMPLE.COM",
"address": {
"street": "1549 SCOTT CENTER RD ",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
}
},
"maritalStatus": "Single",
"dependents": "0"
},
{
"customerId": "265904983773983780",
"role": "Secondary",
"tradingAuthority": "Full",
"nameType": "Individual",
"name1": "SMITHAA",
"name2": "",
"name3": "PATELAA",
"name4": "",
"citizenshipCountry": "BG",
"birthDate": "1985-05-03",
"email": "SMITHAA.PATELAA.DOE@EXAMPLE.COM",
"legalAddress": {
"street": "1549 SCOTT CENTER RD",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
},
"occupation": "Retired",
"jobTitle": "",
"jobIndustry": "",
"employerName": "",
"employerPhoneRegionCode": "",
"employerPhoneNumber": "",
"employerAddress": {
"street": " ",
"city": "",
"stateProvince": "",
"country": "US",
"postalCode": ""
},
"taxIdType": "SSN",
"taxIdNumber": "987453211",
"governmentIdentification": {
"governmentId1": {
"idType": "DriversLicense",
"idNumber": "A7654379",
"idLocation": "BG",
"idIssueDate": "2020-01-01",
"idExpiration": "2024-01-01"
},
"governmentId2": {
"idType": "Passport",
"idNumber": "E00007735",
"idLocation": "AL",
"idIssueDate": "2020-01-01",
"idExpiration": "2030-01-01"
}
},
"sourceOfFunds": "Retirement",
"phoneRegionCell": "1",
"phoneNumberCell": "1143907525",
"phoneNumberHome": "",
"phoneNumberBusiness": "",
"caisCustomerType": [
"Foreign"
],
"trustedContact": {
"name": "JANEAA SMITHAA",
"relationship": "SPOUSE",
"phoneRegionCode": "AF",
"phoneNumber": "2056786578",
"email": "JANEAA.SMITHAA@EXAMPLE.COM",
"address": {
"street": "1549 SCOTT CENTER RD ",
"city": "SHERMAN",
"stateProvince": "NY",
"country": "US",
"postalCode": "14781"
}
},
"maritalStatus": "Single",
"dependents": "0"
}
],
"financialProfile": {
"annualIncome": "",
"netWorth": "",
"liquidNetWorth": "",
"investmentExperience": {}
},
"transferOfDeathBeneficiaries": [
{
"customerId": "265904200719200730",
"nameType": "Individual",
"name1": "JOHN",
"name2": "THOMAS",
"name3": "GOLDBERG",
"name4": "JR",
"address": {
"street": "62 BLUE SPRUCE LN ",
"city": "BALLSTON LAKE",
"stateProvince": "",
"country": "BG",
"postalCode": "12019"
},
"birthDate": "1980-01-25",
"taxIdType": "TaxId",
"taxId": "999999999",
"percentAllocation": "100.00",
"citizenshipCountry": "BO",
"primaryContingent": "Contingent"
}
]
},
"errors": [],
"traceId": "00-272526c8927c1ebeeb8a6ab6190955f2-12f79dde2986ac6c-01",
"hasErrors": false
}