Onboarding Result

This is a diagnostic or status check endpoint.

After submitting a new account at the new account endpoint, this endpoint returns the processing status of the request, backend validations, and the original values that were submitted.

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:

Attributes	Data Type	Length	Description
accountNumber	String	8	StoneX Account Number

Example

{
    "accountNumber": "30239138"
}

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.

Schema

Name	Data Type	Definition
StatusCode	Integer	HTTP status code
Message	String	Brief message about the status of the request
Data	Object	The data returned from the API Data Field
Errors	Array of Errors	Error Object
TraceId	String	Id for each API transaction that can be used for tracking & debugging
HasErrors	Boolean	Indicates if there are errors related to the request

Example

{
  "statusCode": 200,
  "message": "Request successful.",
  "data": {
    "correlationId": "08dbce5a-7a5b-cdbc-3a0f-630c01000000",
    "currentState": "CreationComplete",
    "createdOn": "2023-10-16T15:13:39.8686111Z",
    "lastUpdated": "2023-10-16T15:13:49.89893Z",
    "accountNumber": "52778722",
    "remarks": "Account Number has been created on beta. Errors while processing information.",
    "errorResponses": []
  },
  "errors": [],
  "traceId": "00-3037b8209938238fb33e78535cb8fc95-56575282709b6921-00",
  "hasErrors": false
}

Schema

Data Field

Name	Data Type	Definition
correlationId	String	Internal tracking ID
currentState	String	The state of completion
createdOn	String	Duration of account creation
lastUpdated	String	Duration of account updated
remarks	String	Account status on the StoneX backend
errorResponses	Array of Errors	Indicates if there are errors related to the request Error Object

Example

{
    "statusCode": 200,
    "message": "Request successful.",
    "data": {
        "correlationId": "08dbcf47-0a83-6925-96cb-6da001000000",
        "currentState": "CreationComplete",
        "createdOn": "2023-10-17T19:27:02.9415978Z",
        "lastUpdated": "2023-10-17T19:27:15.2327411Z",
        "accountNumber": "39972429",
        "remarks": "Account Number has been created on beta. Errors while processing information.",
        "errorResponses": [
            {
                "code": "Beta.6321",
                "field": "Beta",
                "reason": "INVALID ADDRESS."
            }
        ]
    },
    "errors": [],
    "traceId": "00-89b4799002c498e136a2260596bddf89-0a6ef0999fd6dc05-00",
    "hasErrors": false
}