> 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/reverse-sms/models.md).

# Models

## The ReverseSmsCheckStatus object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"ReverseSmsCheckStatus":{"description":"The status of a Check:\n- `ACCEPTED`: The Check has been authorized; the platform is awaiting the mobile-originated SMS.\n- `PENDING`: The Check is in-flight, awaiting the mobile-originated SMS.\n- `COMPLETED`: The Check has completed and `match` reflects the result.\n- `EXPIRED`: The Check expired before the mobile-originated SMS was received.\n- `ERROR`: An error prevented the Check from completing; see `error_code`.\n","type":"string","enum":["ACCEPTED","PENDING","COMPLETED","EXPIRED","ERROR"]}}}}
```

## The ReverseSmsCheckErrorCode object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"ReverseSmsCheckErrorCode":{"description":"Machine-readable error code carried on `ERROR`-status Checks.\n\nThe full Reverse SMS error catalogue (including request-level 4xx codes and\nterminal-state codes) is published at\n[docs.idlayr.com/products/number-verification/reverse-sms/error-codes](https://docs.idlayr.com/products/number-verification/reverse-sms/error-codes).\nThe terminal-state catalogue is still being finalised — this enum will grow\nadditively as new codes land in the docs.\n\n- `internal_error`: an unexpected internal failure.\n","type":"string","enum":["internal_error"]}}}}
```

## The ReverseSmsCheckCreatePayload object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"ReverseSmsCheckCreatePayload":{"description":"Payload for creating a Check.","type":"object","unevaluatedProperties":false,"required":["phone_number"],"properties":{"phone_number":{"description":"The phone number to verify, in [E.164 format](https://www.itu.int/rec/T-REC-E.164-201011-I/en) (leading `+`).","type":"string","format":"E.164"},"reference_id":{"description":"Optional. Your own internal reference for this Check; echoed back on responses and webhooks.\nDo not use Personally Identifiable Information (PII).\n","type":"string","maxLength":50},"callback_url":{"description":"Optional. URL the platform will POST the webhook payload to when the Check reaches a terminal status.","type":"string","format":"uri"}}}}}}
```

## The ReverseSmsCheck object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"ReverseSmsCheck":{"description":"A Check resource. Which optional fields are present depends on `status`:\n- `ACCEPTED` (create response): `receiver_phone_number`, `expected_sms_body` and `ttl` are present; the end-user\n  texts `expected_sms_body` to `receiver_phone_number`. These three values are returned\n  **only** on the create response and are not echoed back on subsequent reads — your\n  backend must persist them.\n- `PENDING`: in-flight; `receiver_phone_number`/`expected_sms_body`/`ttl` are not echoed back on reads.\n- `COMPLETED`: `match` reflects the verification result.\n- `ERROR`: `error_code` carries the reason.\n- `EXPIRED`: terminal state; the TTL elapsed before the mobile-originated SMS was received. No `error_code`.\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/ReverseSmsCheckStatus"},"receiver_phone_number":{"description":"The destination number the end-user must text, in E.164 format. Present on the create\nresponse (`ACCEPTED`).\n","type":"string","format":"E.164"},"expected_sms_body":{"description":"The exact SMS body the end-user must send, including the one-time verification code.\nPresent on the create response (`ACCEPTED`).\n","type":"string"},"match":{"description":"Whether the source MSISDN of the mobile-originated SMS matched the claimed\nphone number. Present when `status` is `COMPLETED`.\n","type":"boolean"},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`. Present on the create response.","type":"integer"},"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"},"reference_id":{"description":"Caller-supplied reference, echoed from the create request.","type":"string","maxLength":50},"error_code":{"description":"Machine-readable error code. Set when `status` is `ERROR`.","$ref":"#/components/schemas/ReverseSmsCheckErrorCode"}}},"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}"},"ReverseSmsCheckStatus":{"description":"The status of a Check:\n- `ACCEPTED`: The Check has been authorized; the platform is awaiting the mobile-originated SMS.\n- `PENDING`: The Check is in-flight, awaiting the mobile-originated SMS.\n- `COMPLETED`: The Check has completed and `match` reflects the result.\n- `EXPIRED`: The Check expired before the mobile-originated SMS was received.\n- `ERROR`: An error prevented the Check from completing; see `error_code`.\n","type":"string","enum":["ACCEPTED","PENDING","COMPLETED","EXPIRED","ERROR"]},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"ReverseSmsCheckErrorCode":{"description":"Machine-readable error code carried on `ERROR`-status Checks.\n\nThe full Reverse SMS error catalogue (including request-level 4xx codes and\nterminal-state codes) is published at\n[docs.idlayr.com/products/number-verification/reverse-sms/error-codes](https://docs.idlayr.com/products/number-verification/reverse-sms/error-codes).\nThe terminal-state catalogue is still being finalised — this enum will grow\nadditively as new codes land in the docs.\n\n- `internal_error`: an unexpected internal failure.\n","type":"string","enum":["internal_error"]}}}}
```

## The ReverseSmsCheckCallbackPayload object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"ReverseSmsCheckCallbackPayload":{"description":"Body POSTed to the customer-supplied `callback_url` when the Check reaches a terminal\nstatus. `status` is one of `COMPLETED`, `ERROR`, or `EXPIRED`.\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":{"description":"Terminal status. Callbacks are not fired for `ACCEPTED` or `PENDING`.","type":"string","enum":["COMPLETED","ERROR","EXPIRED"]},"match":{"description":"Whether the source MSISDN of the mobile-originated SMS matched the claimed\nphone number. Present when `status` is `COMPLETED`.\n","type":"boolean"},"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"},"reference_id":{"description":"Caller-supplied reference, echoed from the create request.","type":"string","maxLength":50},"error_code":{"description":"Machine-readable error code. Set when `status` is `ERROR`.","$ref":"#/components/schemas/ReverseSmsCheckErrorCode"}}},"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}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"ReverseSmsCheckErrorCode":{"description":"Machine-readable error code carried on `ERROR`-status Checks.\n\nThe full Reverse SMS error catalogue (including request-level 4xx codes and\nterminal-state codes) is published at\n[docs.idlayr.com/products/number-verification/reverse-sms/error-codes](https://docs.idlayr.com/products/number-verification/reverse-sms/error-codes).\nThe terminal-state catalogue is still being finalised — this enum will grow\nadditively as new codes land in the docs.\n\n- `internal_error`: an unexpected internal failure.\n","type":"string","enum":["internal_error"]}}}}
```

## The ReverseSmsCheckPage object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"ReverseSmsCheckPage":{"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/ReverseSmsCheck"}},"page":{"description":"Pagination metadata for the collection.","$ref":"#/components/schemas/page"}}},"ReverseSmsCheck":{"description":"A Check resource. Which optional fields are present depends on `status`:\n- `ACCEPTED` (create response): `receiver_phone_number`, `expected_sms_body` and `ttl` are present; the end-user\n  texts `expected_sms_body` to `receiver_phone_number`. These three values are returned\n  **only** on the create response and are not echoed back on subsequent reads — your\n  backend must persist them.\n- `PENDING`: in-flight; `receiver_phone_number`/`expected_sms_body`/`ttl` are not echoed back on reads.\n- `COMPLETED`: `match` reflects the verification result.\n- `ERROR`: `error_code` carries the reason.\n- `EXPIRED`: terminal state; the TTL elapsed before the mobile-originated SMS was received. No `error_code`.\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/ReverseSmsCheckStatus"},"receiver_phone_number":{"description":"The destination number the end-user must text, in E.164 format. Present on the create\nresponse (`ACCEPTED`).\n","type":"string","format":"E.164"},"expected_sms_body":{"description":"The exact SMS body the end-user must send, including the one-time verification code.\nPresent on the create response (`ACCEPTED`).\n","type":"string"},"match":{"description":"Whether the source MSISDN of the mobile-originated SMS matched the claimed\nphone number. Present when `status` is `COMPLETED`.\n","type":"boolean"},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`. Present on the create response.","type":"integer"},"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"},"reference_id":{"description":"Caller-supplied reference, echoed from the create request.","type":"string","maxLength":50},"error_code":{"description":"Machine-readable error code. Set when `status` is `ERROR`.","$ref":"#/components/schemas/ReverseSmsCheckErrorCode"}}},"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}"},"ReverseSmsCheckStatus":{"description":"The status of a Check:\n- `ACCEPTED`: The Check has been authorized; the platform is awaiting the mobile-originated SMS.\n- `PENDING`: The Check is in-flight, awaiting the mobile-originated SMS.\n- `COMPLETED`: The Check has completed and `match` reflects the result.\n- `EXPIRED`: The Check expired before the mobile-originated SMS was received.\n- `ERROR`: An error prevented the Check from completing; see `error_code`.\n","type":"string","enum":["ACCEPTED","PENDING","COMPLETED","EXPIRED","ERROR"]},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"ReverseSmsCheckErrorCode":{"description":"Machine-readable error code carried on `ERROR`-status Checks.\n\nThe full Reverse SMS error catalogue (including request-level 4xx codes and\nterminal-state codes) is published at\n[docs.idlayr.com/products/number-verification/reverse-sms/error-codes](https://docs.idlayr.com/products/number-verification/reverse-sms/error-codes).\nThe terminal-state catalogue is still being finalised — this enum will grow\nadditively as new codes land in the docs.\n\n- `internal_error`: an unexpected internal failure.\n","type":"string","enum":["internal_error"]},"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 Reverse SMS 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 ISODateTime object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS 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 Reverse SMS 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 RsqlBadRequest object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"RsqlBadRequest":{"description":"The `search` query parameter is not a syntactically valid\n[RSQL](https://github.com/jirutka/rsql-parser) expression, or references a field that\nis not filterable on this resource.\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 Unauthenticated object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"Unauthenticated":{"description":"The request lacks a valid Access Token, or the token has expired. Mint a new token via\nthe OAuth2 token endpoint and 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 Forbidden object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS API","version":"1.0.0"},"components":{"schemas":{"Forbidden":{"description":"The Access Token is valid but does not grant access to the requested resource. Common\ncauses: the token does not carry the required product scope, the token's Project is\nnot enabled for this product, or the resource belongs to a different Project.\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 RateLimitReached object

```json
{"openapi":"3.1.0","info":{"title":"IDlayr Reverse SMS 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 Reverse SMS 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 Reverse SMS 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/reverse-sms/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.