Skip to main content

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.

AttributesData TypeDescriptionValidationsAccepted Values
accountNumberStringStoneX Account NumberRequired field with 8 digit alpha-numeric or numeric value without special characters.a-Z, 0-9
entityNumberIntegerStoneX Entity NumberRequired field with 3 digit numeric value without special characters.0-9

Response

A successful request to the Get Account API will retrieve and return a structured response with the following attributes.

AttributesData Type
accountNumberString
entityNumberInteger
registrationTypeRegistration Type
mainMain
mailingAddressMailing Address
primaryOwnerPrimary Owner
associatedPartiesAssociated Parties
electronicDeliveryElectronic Delivery
financialProfileFinancial Profile

Any validation failure associated with the account number will result in an error response and will eventually terminate the account information retrieval process.