> For the complete documentation index, see [llms.txt](https://legacy-docs.usesmileid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy-docs.usesmileid.com/further-reading/faqs/is-there-an-api-i-can-check-to-check-the-status-of-an-id-authority.md).

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

{% hint style="info" %}
If you use Slack in your organization, you can [install our Slackbot](/further-reading/faqs/slack-integration.md) to receive notifications about the availability status of an ID type.
{% endhint %}

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.

{% hint style="info" %}
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.
  {% endhint %}

### Request

<mark style="color:green;">`POST`</mark> `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 `test`

#### Request Body

| Name                                          | Type   | Description                                                                        |
| --------------------------------------------- | ------ | ---------------------------------------------------------------------------------- |
| partner\_id<mark style="color:red;">\*</mark> | String | Your Smile ID partner ID                                                           |
| signature<mark style="color:red;">\*</mark>   | String | The signature you generated using your API Key                                     |
| timestamp<mark style="color:red;">\*</mark>   | String | The timestamp that was used to calculate your signature (in ISO date/time format). |
| country<mark style="color:red;">\*</mark>     | String | 2-letter country code of the id type you want to check its availability            |
| id\_type<mark style="color:red;">\*</mark>    | String | The id type you want to check its availability                                     |
| environment<mark style="color:red;">\*</mark> | String | 'sandbox' or 'production' depending on which environment's API key you're using    |

{% tabs %}
{% tab title="200: OK " %}

```json
{
  "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%"
}
```

{% endtab %}
{% endtabs %}

### Response

<table><thead><tr><th width="242.33333333333331">Key</th><th width="337">Description</th><th>Value</th></tr></thead><tbody><tr><td><code>last_checked</code></td><td>The last 10-minute window we calculated the availability status for the ID authority</td><td><em>timestamp</em></td></tr><tr><td><code>last_check_status</code> (<em>deprecated</em>)</td><td>The overall status of the ID authority in the last 10-minute window</td><td><em>success</em>: >50% of checks were successful<br><br><em>failure</em>: &#x3C;= 50% of checks were successful</td></tr><tr><td><code>last_hour_success_rate</code></td><td>The % success rate of the ID authority in the last 1 hour</td><td>x%</td></tr><tr><td><code>last_known_status</code></td><td>The status of the ID authority in the last 10-minute window</td><td>Online: >91% of checks were successful<br><br>Interruption: >50% but &#x3C;=91% of checks were successful<br><br>Offline: &#x3C;=50% of checks were successful</td></tr><tr><td><code>last_check_success_rate</code></td><td>The % success rate of the ID authority in the last 10-minute window</td><td>x%</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://legacy-docs.usesmileid.com/further-reading/faqs/is-there-an-api-i-can-check-to-check-the-status-of-an-id-authority.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.