Is there an API I can query to check the availability status of an ID type?

If you have received a result code of 1015 during an ID Validation request, you may wish to re-submit that request later once the ID authority has come back online. While we can't say for certain whether a provider is up or down at any given moment because we don't control their system, we can provide you with our most up to date information about them. In addition to the ID API Status page in your Smile ID dashboard you can access that information programmatically.

We check the status of ID authorities every 10 minutes. We calculate the availability status based on the aggregate result of all queries for that ID authority in a 10 minute window. There are three possible availability statuses for each ID authority:

• Online: 91% or more of IDs looked up in the specific ID authority had a successful response

• Interruption: More than 50% but less than 91% of IDs looked up in the specific ID authority had a successful response

• Offline: Less than 50% of IDs looked up in the specific ID authority had a successful response.

Request

POST https://[env].smileidentity.com/api/v2/partner/id_status

The value you pass for [env] changes depending on the api key you are using to authenticate the request.

Production api key: Set value of [env] variable as prod

Sandbox api key: Set value of [env] variable as portal

Request Body

Name	Type	Description
partner_id*	String	Your Smile ID partner ID
signature*	String	The timestamp you used to generate the signature
timestamp*	String	The signature you generated using your API Key
country*	String	2-letter country code of the id type you want to check its availability
id_type*	String	The id type you want to check its availability
environment*	String	'sandbox' or 'production' depending on which environment's API key you're using

200: OK

{
    "last_checked": "2023-06-13T09:50:04.596Z",
    "last_check_status": "failure",
    "last_hour_success_rate": "16%",
    "last_known_status": "offline",
    "last_check_success_rate": "0%"
}

Response

Key	Description	Value
last_checked	The last 10-minute window we calculated the availability status for the ID authority	timestamp
last_check_status (deprecated)	The overall status of the ID authority in the last 10-minute window	success: >50% of checks were successful failure: <= 50% of checks were successful
last_hour_success_rate	The % success rate of the ID authority in the last 1 hour	x%
last_known_status	The status of the ID authority in the last 10-minute window	Online: >91% of checks were successful Interruption: >50% but <=91% of checks were successful Offline: <=50% of checks were successful
last_check_success_rate	The % success rate of the ID authority in the last 10-minute window	x%