> For the complete documentation index, see [llms.txt](https://docs.idlayr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.idlayr.com/products/risk/sim-swap/endpoints.md).

# Endpoints

{% hint style="info" %}
**Backend API** · GA
{% endhint %}

Summary of the SIM Swap endpoints. Full request and response schemas live in the API Reference.

| Method | Path                             | Purpose                                                          |
| ------ | -------------------------------- | ---------------------------------------------------------------- |
| `POST` | `/v1/sim-swap-checks`            | Create a check (synchronous; returns the result on the response) |
| `GET`  | `/v1/sim-swap-checks/{check_id}` | Get an existing check by ID (for retrieval and audit)            |
| `GET`  | `/v1/sim-swap-checks`            | List checks (paginated; supports RSQL filtering)                 |

There is no PATCH endpoint — SIM Swap is fully synchronous. The result is on the POST response; subsequent GETs are for retrieval and audit, not completion.

## Common requirements

All endpoints require:

* HTTPS.
* An OAuth2 Bearer token with the `sim_swap` scope on the `Authorization` header.
* The `{data_residency}` host prefix matching your workspace region (`eu.api.idlayr.com` or `us.api.idlayr.com`). See [Data residency](/get-started/concepts/data-residency.md).

## Common response headers

* `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` — see Rate limits in the API Reference.
* On `429`, a `Retry-After` header indicates seconds before retrying.

## Common error responses

`400` invalid phone number or `mno_not_supported`, `401` unauthorized, `404` check not found or number not found, `412` precondition failed, `429` rate limit reached, `500` internal server error, `504` MNO not responding. See [Error codes](/products/risk/sim-swap/error-codes.md) for the full taxonomy.

## See also

* The [Integration page](/products/risk/sim-swap/integration.md) walks through a full create-check flow with cURL.
* The full API Reference will carry the complete request/response schemas for each endpoint (linked from here once published).


---

# 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://docs.idlayr.com/products/risk/sim-swap/endpoints.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.