API reference, Phone number input

Get Silent Network Authentication (SNA) status

GEThttps://demo-api.incodesmile.com/omni/sna/status/{checkId}

Returns the current state of a check started by POST /omni/sna/initiate. Use it to poll while the device is following checkUrl, or to recover the result after the client lost the response of POST /omni/sna/complete. The endpoint always answers HTTP 200; branch on status:

  • ACCEPTED or PENDING - the provider has not finished; pending is true, keep polling.
  • COMPLETED - complete is true and match carries the result.
  • EXPIRED or ERROR - the check will not complete; match is null. Fall back to SMS OTP. Note that EXPIRED without a provider error code is reported with pending: true, so do not rely on pending alone to stop polling.

Path parameters

checkIdstringrequired

`checkId` returned by `POST /omni/sna/initiate`.

Headers

api-versionstringrequiredDefaults to 1.0

Responses

Response body (application/json)

successboolean

`true` when the check is completed and the device matched the phone number.

methodstring

Verification method, always `SNA` for this endpoint.

enumSNA
checkIdstring

Identifier of the SNA check, echoed from the path.

statusstring

Provider status of the check.

enumACCEPTEDPENDINGCOMPLETEDEXPIREDERROR
matchboolean

Result of the check when `status` is `COMPLETED`; `null` otherwise.

pendingboolean

`true` while `status` is `ACCEPTED` or `PENDING`; also `true` for `EXPIRED` without a provider error code, so branch on `status` rather than on this flag.

completeboolean

`true` when `status` is `COMPLETED`; read `match` for the result. `false` on `EXPIRED` and `ERROR` even though the check will not complete.

messagestring

Human readable outcome, for logging. Not meant to be shown to the end user.