> 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/api-reference/sim-check/models.md).

# Models

## The SimSwapCheckStatus object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"SimSwapCheckStatus":{"description":"The status of a Check:\n- `COMPLETED`: The Check resolved and `no_sim_change` reflects the SIM Swap result.\n- `ERROR`: An error prevented the Check from resolving; see `error_code`.\n","type":"string","enum":["COMPLETED","ERROR"]}}}}
```

## The SimSwapCheckErrorCode object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"SimSwapCheckErrorCode":{"description":"Set when `status` is `ERROR`:\n- `mno_not_supported`: The MNO is not supported.\n- `mno_timeout`: The request timed out with the MNO.\n- `mno_user_not_found`: The supplied phone number is not recognized by the MNO; it may be associated with an unsupported MVNO.\n- `mno_response_error`: The MNO responded with an invalid response.\n- `mno_server_error`: An error occurred with the MNO.\n- `mno_no_data_available`: The MNO is not allowed to share this information.\n","type":"string","enum":["mno_not_supported","mno_timeout","mno_user_not_found","mno_response_error","mno_server_error","mno_no_data_available"]}}}}
```

## The SimChangeWithin object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"SimChangeWithin":{"description":"Time bucket containing the most recent SIM change, in minutes. Only returned when the\nMNO provides this information and `status` is `COMPLETED`.\n","type":"integer"}}}}
```

## The SimSwapCheckCreatePayload object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"SimSwapCheckCreatePayload":{"description":"Payload for creating a SIM Swap Check.","type":"object","unevaluatedProperties":false,"required":["phone_number"],"properties":{"phone_number":{"description":"The phone number to check, in [E.164 format](https://www.itu.int/rec/T-REC-E.164-201011-I/en) (leading `+`).","type":"string","format":"E.164"},"phone_ip":{"description":"Optional. The IP address (IPv4 or IPv6) of the mobile device associated with the phone number.","type":"string"},"reference_id":{"description":"Optional. Your own internal reference for this Check; echoed back on responses.\nDo not use Personally Identifiable Information (PII).\n","type":"string","maxLength":50},"period":{"description":"Optional. Time window for `no_sim_change` evaluation, in minutes. The Check returns\n`no_sim_change=true` iff the SIM has *not* been changed within this window.\n\nAllowed range: 60 (1 hour) to 540000 (375 days). Default: 10080 (7 days).\n","type":"integer","minimum":60,"maximum":540000,"default":10080}}}}}}
```

## The SimSwapCheck object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"SimSwapCheck":{"description":"A Check resource. The presence of `no_sim_change`, `sim_change_within`, `network_id`\nand `error_code` is determined by `status`:\n- `COMPLETED`: `no_sim_change`, `no_sim_change_period` and `network_id` required;\n  `sim_change_within` optional (only when the MNO supplies it); `error_code` absent.\n- `ERROR`: `error_code` required; `no_sim_change` / `no_sim_change_period` /\n  `sim_change_within` / `network_id` absent.\n","type":"object","unevaluatedProperties":false,"required":["check_id","status","created_at"],"properties":{"check_id":{"description":"The unique ID of the Check resource.","$ref":"#/components/schemas/UUID"},"status":{"$ref":"#/components/schemas/SimSwapCheckStatus"},"no_sim_change":{"description":"`true` if the SIM card has *not* been changed within `no_sim_change_period`.\n`false` if a change was detected within the window.\n","type":"boolean"},"no_sim_change_period":{"description":"The evaluation window applied for `no_sim_change`, in minutes. Echoes the\n`period` from the create payload (or the default 10080).\n","type":"integer"},"sim_change_within":{"$ref":"#/components/schemas/SimChangeWithin"},"network_id":{"description":"Network identifier resolved during the verification.","$ref":"#/components/schemas/NetworkIDResponse"},"reference_id":{"description":"Caller-supplied reference, echoed from the create request.","type":"string"},"error_code":{"$ref":"#/components/schemas/SimSwapCheckErrorCode"},"created_at":{"description":"When the Check was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the Check was last updated.","$ref":"#/components/schemas/ISODateTime"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["no_sim_change","no_sim_change_period","network_id"],"not":{"required":["error_code"]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ERROR"}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["no_sim_change"]},{"required":["no_sim_change_period"]},{"required":["sim_change_within"]},{"required":["network_id"]}]}}}]},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"SimSwapCheckStatus":{"description":"The status of a Check:\n- `COMPLETED`: The Check resolved and `no_sim_change` reflects the SIM Swap result.\n- `ERROR`: An error prevented the Check from resolving; see `error_code`.\n","type":"string","enum":["COMPLETED","ERROR"]},"SimChangeWithin":{"description":"Time bucket containing the most recent SIM change, in minutes. Only returned when the\nMNO provides this information and `status` is `COMPLETED`.\n","type":"integer"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"SimSwapCheckErrorCode":{"description":"Set when `status` is `ERROR`:\n- `mno_not_supported`: The MNO is not supported.\n- `mno_timeout`: The request timed out with the MNO.\n- `mno_user_not_found`: The supplied phone number is not recognized by the MNO; it may be associated with an unsupported MVNO.\n- `mno_response_error`: The MNO responded with an invalid response.\n- `mno_server_error`: An error occurred with the MNO.\n- `mno_no_data_available`: The MNO is not allowed to share this information.\n","type":"string","enum":["mno_not_supported","mno_timeout","mno_user_not_found","mno_response_error","mno_server_error","mno_no_data_available"]},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}}
```

## The SimSwapCheckPage object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"SimSwapCheckPage":{"description":"Page wrapper for a list of Checks: a `content` array plus a `page` block\nwith `size` / `number` / `total_pages` / `total_elements` metadata.\n","type":"object","unevaluatedProperties":false,"required":["content","page"],"properties":{"content":{"description":"Checks in the current page.","type":"array","items":{"$ref":"#/components/schemas/SimSwapCheck"}},"page":{"description":"Pagination metadata for the collection.","$ref":"#/components/schemas/page"}}},"SimSwapCheck":{"description":"A Check resource. The presence of `no_sim_change`, `sim_change_within`, `network_id`\nand `error_code` is determined by `status`:\n- `COMPLETED`: `no_sim_change`, `no_sim_change_period` and `network_id` required;\n  `sim_change_within` optional (only when the MNO supplies it); `error_code` absent.\n- `ERROR`: `error_code` required; `no_sim_change` / `no_sim_change_period` /\n  `sim_change_within` / `network_id` absent.\n","type":"object","unevaluatedProperties":false,"required":["check_id","status","created_at"],"properties":{"check_id":{"description":"The unique ID of the Check resource.","$ref":"#/components/schemas/UUID"},"status":{"$ref":"#/components/schemas/SimSwapCheckStatus"},"no_sim_change":{"description":"`true` if the SIM card has *not* been changed within `no_sim_change_period`.\n`false` if a change was detected within the window.\n","type":"boolean"},"no_sim_change_period":{"description":"The evaluation window applied for `no_sim_change`, in minutes. Echoes the\n`period` from the create payload (or the default 10080).\n","type":"integer"},"sim_change_within":{"$ref":"#/components/schemas/SimChangeWithin"},"network_id":{"description":"Network identifier resolved during the verification.","$ref":"#/components/schemas/NetworkIDResponse"},"reference_id":{"description":"Caller-supplied reference, echoed from the create request.","type":"string"},"error_code":{"$ref":"#/components/schemas/SimSwapCheckErrorCode"},"created_at":{"description":"When the Check was created.","$ref":"#/components/schemas/ISODateTime"},"updated_at":{"description":"When the Check was last updated.","$ref":"#/components/schemas/ISODateTime"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["no_sim_change","no_sim_change_period","network_id"],"not":{"required":["error_code"]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ERROR"}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["no_sim_change"]},{"required":["no_sim_change_period"]},{"required":["sim_change_within"]},{"required":["network_id"]}]}}}]},"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"},"SimSwapCheckStatus":{"description":"The status of a Check:\n- `COMPLETED`: The Check resolved and `no_sim_change` reflects the SIM Swap result.\n- `ERROR`: An error prevented the Check from resolving; see `error_code`.\n","type":"string","enum":["COMPLETED","ERROR"]},"SimChangeWithin":{"description":"Time bucket containing the most recent SIM change, in minutes. Only returned when the\nMNO provides this information and `status` is `COMPLETED`.\n","type":"integer"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"SimSwapCheckErrorCode":{"description":"Set when `status` is `ERROR`:\n- `mno_not_supported`: The MNO is not supported.\n- `mno_timeout`: The request timed out with the MNO.\n- `mno_user_not_found`: The supplied phone number is not recognized by the MNO; it may be associated with an unsupported MVNO.\n- `mno_response_error`: The MNO responded with an invalid response.\n- `mno_server_error`: An error occurred with the MNO.\n- `mno_no_data_available`: The MNO is not allowed to share this information.\n","type":"string","enum":["mno_not_supported","mno_timeout","mno_user_not_found","mno_response_error","mno_server_error","mno_no_data_available"]},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"page":{"description":"Pagination metadata.","type":"object","unevaluatedProperties":false,"required":["size","number","total_pages","total_elements"],"properties":{"size":{"description":"The number of records per page.","type":"integer"},"number":{"description":"The current page number.","type":"integer"},"total_pages":{"description":"The total number of pages available.","type":"integer"},"total_elements":{"description":"The total number of records across all pages.","type":"integer"}}}}}}
```

## The UUID object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"UUID":{"description":"A Universally Unique IDentifier.","type":"string","format":"uuid","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"}}}}
```

## The NetworkIDResponse object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"}}}}
```

## The ISODateTime object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}}
```

## The page object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"page":{"description":"Pagination metadata.","type":"object","unevaluatedProperties":false,"required":["size","number","total_pages","total_elements"],"properties":{"size":{"description":"The number of records per page.","type":"integer"},"number":{"description":"The current page number.","type":"integer"},"total_pages":{"description":"The total number of pages available.","type":"integer"},"total_elements":{"description":"The total number of records across all pages.","type":"integer"}}}}}}
```

## The RateLimitReached object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"RateLimitReached":{"description":"The API rate limit for the workspace has been exceeded. The `Retry-After` header carries\nthe number of seconds after which the caller can retry.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}}}}
```

## The PhoneNumberBadRequest object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"PhoneNumberBadRequest":{"description":"The request could not be processed for the supplied phone number. `error_code`\ndistinguishes the cause:\n- `phone_number_invalid`: the supplied phone number is not valid E.164.\n- `mno_not_supported`: the Mobile Network Operator for the supplied number is not supported.\n","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the cause of the bad request.","type":"string","enum":["phone_number_invalid","mno_not_supported"]}}}}}}
```

## The CheckNotFound object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr SIM Swap API","version":"1.0.0"},"components":{"schemas":{"CheckNotFound":{"description":"The Check identified by `check_id` does not exist or is no longer retrievable.","type":"object","unevaluatedProperties":false,"required":["type","title","status","detail","error_code"],"properties":{"type":{"description":"A URI reference [RFC 3986] that identifies the problem type.","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"error_code":{"description":"Machine-readable error code identifying the problem type.","type":"string"}}}}}}
```


---

# 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/api-reference/sim-check/models.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.