Onboarding Result
This is a diagnostic or status check endpoint. This endpoint provides a status check for account creation. It retrieves processing status, backend validations, and submitted values after a new account request. Status details include mailing address, trusted contact, and electronic delivery setup. It confirms successful execution of related APIs and account creation with input data.
POST
/account-api/v1/onboarding-result
Required Attributes
- Schema
- Example
The user must send the following attributes whenever using the onboarding-result endpoint. These are not changeable or erasable:
| Field Name | Type | Description | Validations | Values Accepted |
|---|---|---|---|---|
accountNumber | String | StoneX Account Number. | Must not be empty.Must be 8 digit or Alphanumeric. | a-Z, 0-9. Exact 8 digits or aplha numeric characters. |
{
"accountNumber": "10003381"
}
Responses
This endpoint will return a standard response with the data below for the account status.
Success Response
Data returned to a successful API call. The onboarding result endpoint retrieves the status of non-synchronous new-account API calls and does not support accounts created outside the new-account endpoint.
- Schema
- Onboarding-Result
- Onboarding-Result - Expanded
| Name | Data Type | Definition |
|---|---|---|
data | Object | The data returned from the API Data Field. |
accountNumber | String | The account number requested. |
state | Array | Array of objects that has three parts properties state.code , state.status , state.reason. |
code | String | Stages on account creation process."AccountCreation", "MailingAddress", "TrustedContact", "ElectronicDelivery". |
reason | String | Provides additional failure details.(Optional). |
status | String | The result of the process (Success or Failed). |
traceId | String | Id for each API transaction that can be used for tracking & debugging. |
request | object | The request that the client has submitted to create the account. |
correlationId | String | Internal tracking ID. |
currentState | String | The state of completion. |
createdOn | String | Datetime account creation request accepetd. |
lastUpdated | String | Datetime of account updated. |
remarks | String | Remarks confirm the completion of key account creation processes, including Mailing address, Trusted contact and Electronic delivery setup. |
{
"statusCode": 200,
"message": "Request successful.",
"data": {
"correlationId": "08de0dab-127e-d3bb-423c-197901000000",
"currentState": "End",
"createdOn": "2025-10-17T18:29:13.4963844Z",
"lastUpdated": "2025-10-17T18:29:15.4420287Z",
"accountNumber": "10003381",
"remarks": "Account creation was successful",
"state": [
{
"code": "Trusted Contact",
"status": "Success"
},
{
"code": "Electronic Delivery",
"status": "Success"
},
{
"code": "Legal Address",
"status": "Success"
},
{
"code": "Associated Parties",
"status": "Success"
},
{
"code": "Beneficiaries",
"status": "Success"
}
],
"request": {
.....
}
},
"errors": [],
"traceId": "00-bf771ce7dc55774820d61d535b3b06af-c7a22824ec008f77-01",
"hasErrors": false
}
{
"statusCode": 200,
"message": "Request successful.",
"data": {
"correlationId": "08de0dab-127e-d3bb-423c-197901000000",
"currentState": "End",
"createdOn": "2025-10-17T18:29:13.4963844Z",
"lastUpdated": "2025-10-17T18:29:15.4420287Z",
"accountNumber": "10003381",
"remarks": "Account creation was successful",
"state": [
{
"code": "Trusted Contact",
"status": "Success"
},
{
"code": "Electronic Delivery",
"status": "Success"
},
{
"code": "Legal Address",
"status": "Success"
},
{
"code": "Associated Parties",
"status": "Success"
},
{
"code": "Beneficiaries",
"status": "Success"
}
],
"request": {
"registrationType": "Individual",
"officeCode": "JC",
"rrCode": "01",
"main": {
"repCode": "JC01"
},
"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"
},
"entityNumber": "301",
"primaryOwner": {
"sourceOfFunds": [
"Employment",
"Other"
],
"otherSourceOfFund": "OtherTesting",
"firstName": "Johnn",
"middleName": "Davidd",
"lastName": "Doe",
"suffix": "",
"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",
"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": {
"publicCompany": "",
"industry": "",
"political": "True",
"relationship": "Child",
"name": "John Doe",
"organization": "Example Organization",
"address": {
"street": "1234 Elmwood Crescent Avenues Springfields 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"
},
"occupation": "Computers",
"employerName": "Stonex1",
"employerPhoneNumber": "5205123987",
"employerAddress": {
"street": "2 Perimeter Park S",
"city": "BOSTON",
"stateProvince": "MA",
"country": "US",
"postalCode": "21345"
},
"taxIdType": "TaxId",
"taxIdNumber": "123456789",
"phoneNumberCell": "2059871212",
"caisInformation": {
"customerType": [
"Advisor"
],
"role": "Auth"
},
"maritalStatus": "Married",
"dependents": "02"
}
],
"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",
"taxIdType": "SSN",
"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",
"taxIdType": "SSN",
"taxIdNumber": "123456771",
"relationship": "Other",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 3",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2003-07-23",
"taxIdType": "SSN",
"taxIdNumber": "123456770",
"relationship": "Spouse",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 4",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2006-01-30",
"taxIdType": "SSN",
"taxIdNumber": "123456771",
"relationship": "Other",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 5",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2003-07-23",
"taxIdType": "SSN",
"taxIdNumber": "123456770",
"relationship": "Spouse",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 6",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2006-01-30",
"taxIdType": "SSN",
"taxIdNumber": "123456771",
"relationship": "Other",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 7",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2003-07-23",
"taxIdType": "SSN",
"taxIdNumber": "123456770",
"relationship": "Spouse",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 8",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2006-01-30",
"taxIdType": "SSN",
"taxIdNumber": "123456771",
"relationship": "Other",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 9",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2003-07-23",
"taxIdType": "SSN",
"taxIdNumber": "123456770",
"relationship": "Spouse",
"percentageAllocation": "10"
},
{
"primaryContingent": "Primary",
"name": "PRIMARY BENE 10",
"address": {
"street": "123 MAIN ST",
"city": "MOUNTAIN BRK",
"stateProvince": "AL",
"country": "US",
"postalCode": "35216"
},
"birthDate": "2006-01-30",
"taxIdType": "SSN",
"taxIdNumber": "123456771",
"relationship": "Other",
"percentageAllocation": "10"
}
]
}
},
"errors": [],
"traceId": "00-bf771ce7dc55774820d61d535b3b06af-c7a22824ec008f77-01",
"hasErrors": false
}