Error Handling

Client Registration – Create New Account

[POST] OR [PATCH] gw/api/v1/accounts

When making requests to our API, you will receive HTTP status codes that indicate the outcome of your request. However, it’s important to understand that a status code of 200 doesn’t always mean your request was successful.

HTTP Status Codes

1. 200: Your request reached the server and was processed
2. Non-200 Codes: Your request did not pass gateway validation (e.g., 400, 401, 404, 500)

200 OK

A 200 status code simply means your request successfully reached our application and was processed. However, the actual outcome can be one of two types:

Success Response (200): This indicates that your request not only reached the server but also passed all validation checks and was successfully processed.

Error Response (200 with Error): This indicates that while your request successfully reached the application (passing gateway validation), it failed some business logic or validation check within the application itself.

• The status within response will return ERROR
• Error detail will be included within error.value

Sample Response

{
    "requestId": 464041722,
    "dateSubmitted": "20250805143508 UTC",
    "fileData": {
        "data": {
            "execution": {
                "executedAt": "20250805143509 UTC",
                "client": "Test client for account I19565014",
                "clientMasterAccount": "I1111111",
                "processFile": "II1111111-08-05_103508896_853839.json"
            },
            "application": {
                "customer": "Jane F Tester",
                "externalId": "testUser12345",
                "status": "Error",
                "error": [
                    {
                        "value": "Unable to determine client IB entity. Kindly provide valid Residence country and Legal Residence Country."
                    }
                   
                    }
                ]
            }
        },
        "name": "II1111111-103509392_144127.json.report"
    }
}

Understanding this distinction is crucial because:

1. You cannot rely solely on the HTTP status code to determine if your operation succeeded
2. Your code should always check the response body’s structure and status field
3. Gateway errors (non-200) indicate problems with your request format, authentication, or server availability
4. Application errors (200 with error status) indicate problems with the data or business logic

Error Library

200 with Error

customer

AssociatedIndividual

accounts

users

documents

Non-200 Codes

Your request did not pass gateway validation (e.g., 400, 401, 404, 500)