# Explain a failed sign-in

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-get">GET</span> <code>/v1/sign_ins/&#123;sign_in&#125;/explanation</code></p>

A plain-language explanation of why the sign-in failed. When a language-model provider is configured for the deployment, the explanation is written from redacted catalog data only (the error code, the names of the checks that ran and the IdP type; never an email, assertion, token or address) and cached per failure signature. Otherwise, or when the provider fails, `source` is `doctor` and the text is the Doctor's deterministic cause and steps. A sign-in that did not fail has `error_code: null`. When the environment's monthly explanation cost cap is reached, or too many explanations are asked for in a short window, the Doctor text is served and `unavailable_reason` says why (`explanation_budget_exhausted`, `explanation_rate_limited`; the same codes as the error catalogue). Explanations are opt-in per account: until an account admin turns them on (`explain_enabled` on the account), the provider is never called and the Doctor text is served with `explain_enabled` false.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>workbench:read</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Path parameters

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">sign_in</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
</li>
</ul>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">SignInExplanation</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">404</span> <span>Code: <a href="/errors/resource_not_found/">resource_not_found</a> (also returned for other tenants' IDs); a path no endpoint serves answers <a href="/errors/route_not_found/">route_not_found</a>. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X GET \
  "https://api.ohauthcat.com/v1/sign_ins/sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/explanation" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY"
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/v1/sign_ins/sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/explanation",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    },
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.get(
    "https://api.ohauthcat.com/v1/sign_ins/sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/explanation",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
)
data = response.json()
```

```json title="Response 200" wrap
{
  "sign_in_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "error_code": "saml_signature_invalid",
  "source": "doctor",
  "provider": "okta",
  "model": "example_model",
  "unavailable_reason": "explanation_budget_exhausted",
  "explain_enabled": true,
  "text": "example_text"
}
```

</div>
</div>
