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

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.

Example

{
    "accountNumber": "10000681"
}

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

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.

Onboarding-Result

"data": {
    "accountNumber": "10000681",
    "state": [
        {
            "code": "AccountCreation",
            "status": "Success"
        },        
        {
            "code": "MailingAddress",
            "reason": "Timeout Error",
            "status": "Failed"
        },
        {
            "code": "TrustedContact",
            "status": "Success"
        },
        {
            "code": "ElectronicDelivery",
            "status": "Success"
        }         
    ],
    "request": {
        .....
    }
}

Onboarding-Result - Expanded

{
    "statusCode": 200,
    "message": "Request successful.",
    "data": {
        "correlationId": "08dd51a5-7b9e-95c6-565f-1b1c01000000",
        "currentState": "End",
        "createdOn": "2025-02-20T11:55:34.2402371Z",
        "lastUpdated": "2025-02-20T11:55:36.5430706Z",
        "accountNumber": "10000681",
        "remarks": "Account creation was successful",
        "state": [
            {
                "code": "Additional Customer Details",
                "status": "Success"
            },
            {
                "code": "Mailing Address",
                "status": "Success"
            },
            {
                "code": "Trusted Contact",
                "status": "Success"
            },
            {
                "code": "Electronic Delivery",
                "status": "Success"
            },
            {
                "code": "Affiliation",
                "status": "Success"
            },
            {
                "code": "Government Identification",
                "status": "Success"
            }
        ],
        "request": {
            "registrationType": "Individual",
            "main": {
                "repCode": "JC01",
                "proxyDisclosure": "Y"
            },
            "electronicDelivery": {
                "email": "[email protected]",
                "statements": "false",
                "confirms": "false",
                "stonexCommunications": "true",
                "investorCommunications": "true",
                "prospectus": "true",
                "taxDocuments": "false"
            },
            "mailingAddress": {
                "street": "1549 Scott Center Rd",
                "city": "Sherman",
                "stateProvince": "AL",
                "country": "US",
                "postalCode": "14781"
            },
            "accountNumber": "10000681",
            "subNumber": "301",
            "primaryOwner": {
                "firstName": "Raje",
                "middleName": "David",
                "lastName": "Doe",
                "suffix": "JR",
                "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": "123456789",
                "governmentIdentification": {
                    "governmentId1": {
                        "idType": "NationalId",
                        "idNumber": "AL12345",
                        "idIssueDate": "2020-01-01",
                        "idExpiration": "2026-01-01"
                    },
                    "governmentId2": {
                        "idType": "Passport",
                        "idNumber": "j123312345",
                        "idIssueDate": "2020-01-01",
                        "idExpiration": "2026-01-01"
                    }
                },
                "sourceOfFunds": [
                    "Employment",
                    "Other"
                ],
                "otherSourceOfFund": "OtherTesting",
                "phoneNumberCell": "2059871212",
                "phoneNumberHome": "9992986495",
                "caisCustomerType": [
                    "Accredited",
                    "ADVISOR"
                ],
                "accountsAtOtherBrokerage": [],
                "trustedContact": {
                    "name": "Jane Smith",
                    "relationship": "spouse",
                    "phoneRegionCode": "1",
                    "phoneNumber": "2056786578",
                    "email": "[email protected]",
                    "address": {
                        "street": "459 South Segunbagicha",
                        "city": "Ramna",
                        "stateProvince": "AL",
                        "country": "US",
                        "postalCode": "35243"
                    }
                },
                "affiliation": {
                    "publicCompany": "True",
                    "industry": "True",
                    "political": "True",
                    "relationship": "Child",
                    "name": "John Doe",
                    "organization": "Example Organization",
                    "address": {
                        "street": "123 Main St",
                        "city": "Pune",
                        "stateProvince": "AL",
                        "country": "US",
                        "postalCode": "35243"
                    }
                },
                "maritalStatus": "single",
                "dependents": "3"
            },
            "associatedParties": [],
            "financialProfile": {
                "annualIncome": "F",
                "netWorth": "D",
                "liquidNetWorth": "C",
                "liquidityNeed": "Medium",
                "liquidityTime": "High",
                "taxBracket": "LessThan10",
                "investmentTimeHorizon": "5",
                "investmentProfile": "Conservative",
                "investmentExperience": {
                    "stocks": "AVERAGE",
                    "bonds": "EXTENSIVE",
                    "options": "LIMITED",
                    "mutualFunds": "EXTENSIVE",
                    "annuities": "NONE"
                }
            },
            "largeTraders": [],
            "retirementBeneficiaries": [],
            "todBeneficiaries": []
        }
    },
    "errors": [],
    "traceId": "00-b7798c7d7fefa3782929a1863df3c658-6f0d1416f8f14ec1-01",
    "hasErrors": false
}