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": "53725129",
"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": {
"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": "[email protected]",
"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": "[email protected]",
"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": "",
"caisInformation": {
"customerType": [
"Trust"
],
"AccountType": [
"Institution",
"Retirement"
],
"Role": "Auth"
},
"trustedContact": {
"name": "JANE SMITH",
"relationship": "SPOUSE",
"phoneRegionCode": "AF",
"phoneNumber": "2056786578",
"email": "[email protected]",
"address": {
"street": "459 SOUTH SEGUNBAGICHA ",
"city": "RAMNA",
"country": "BG",
"postalCode": "1217"
}
},
"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
}
Deleting Values
Deleting values is not currently supported.
Attributes That Cannot Be Updated
accountNumber
subNumber
registrationType
accountName
nameType
main.marginIndicator
main.optionTradingIndicator
main.optionTradingLevel
primaryOwner.citizenshipCountry
primaryOwner.taxIdType
primaryOwner.taxIdNumber
additionalParty.customerId
additionalParty.citizenshipCountry
additionalParty.taxIdType
additionalParty.taxIdNumber
todBenes.id
retirementBenes.id