> 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/prerequisites.md).

# Prerequisites

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

What you need in place before writing the first line of integration code. SIM Swap is backend-only — no SDK, no device-side requirements.

## On the IDlayr side

* **An approved IDlayr project** with the `sim_swap` scope on its OAuth2 credentials. See [Projects](/get-started/concepts/projects.md). Each use case is approved separately; allow time for the approval flow.
* **The project's `client_id` and `client_secret`.** See [Credentials](/get-started/concepts/credentials.md).
* **Production or sandbox mode** decided. Sandbox lets you test without real MNO queries.

## On your backend

* A way to mint OAuth2 access tokens against `POST /oauth2/token`. See [Authentication](/get-started/authentication.md).
* A way to POST `/v1/sim-swap-checks` over HTTPS and read the synchronous response.
* A safe place to store the `client_secret` (e.g. a secrets manager).
* A risk-policy logic layer that decides what to do with the result — SIM Swap is a signal, not a verdict.

## Network requirements

None on the device side (SIM Swap is server-to-server). Your backend needs egress to `{data_residency}.api.idlayr.com` over HTTPS.

## Optional but recommended

* A **Eligibility pre-check** to determine in advance whether SIM Swap is supported for the number, before incurring the SIM Swap call.
* A **paired Secure SNA check** when the use case warrants high-assurance verification (e.g. fraud-sensitive transactions or authentication step-up).
* A **fallback path** for numbers where SIM Swap returns `mno_not_supported` or other terminal errors.


---

# 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/prerequisites.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.