Update Account
The Update Account API is designed to modify existing account records within the StoneX system. It validates incoming update requests and atomically persists the changes to the backend database. Additionally, it returns a confirmation response containing the updated account details.
POST
/account-api/v1/update-account
Request
The request body of the Update Account API must contain the following attributes for account updation.
- Schema
- Example
| Attributes | Data Type |
|---|---|
accountNumber | String |
Data Block Attributes to be added or updated | Corresponding attribute data type |
{
"accountNumber": "10002927",
"primaryOwner": {
"email": "[email protected]"
}
}
Response
A successful account updation with the Update Account API will return a structured response with the new or updated account details.
- Example
In this example, the email address of the Primary Owner has been updated as per the changes passed in the request body above.
{
"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": "10002926",
"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": "Secondary",
"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-14fada9b2899b5d656e6e5972bb02fd1-55a4f6c6ba56b54a-01",
"hasErrors": false
}
Deleting Values
Deleting values is not currently supported.
Attributes That Cannot Be Updated
accountNumberentityNumberregistrationTypeaccountNamemain.marginIndicatormain.optionTradingIndicatormain.optionTradingLevelprimaryOwner.citizenshipCountryprimaryOwner.taxIdTypeprimaryOwner.taxIdNumberassociatedParties.citizenshipCountryassociatedParties.taxIdTypeassociatedParties.taxIdNumberretirementBenes.id