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.
post
https://[env].smileidentity.com/api/v2/partner/id_status
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% |