SIM Verification

Common objects & errors

Every SIM Verification response carries the same errors array alongside data, and every call fails the same way at the transport layer — both defined once here and referred to by name from each endpoint page.

Error envelope

When data.status is "failure", errors tells you why the request failed. In case of any other errors, data is empty and errors carries the code the server sent alongside the HTTP status.

{
    "errors": [
            {
                "code": string,
                "message": string,
                "detail": {
                    "field": string, // optional, which parameter is invalid.
                    ... // any other information that can be useful for client
                },
            },
            ... // other errors
        ]
}

Each entry contains:

Shared transport errors

In case of any other errors, the data field will be empty, and the server sends one of the following HTTP status codes with an error code. These are the same on every SIM Verification call.

A code that arrives with HTTP 200 and data.status: "failure" belongs to the endpoint that returned it, and is documented under Failure codes on that endpoint's own page.