> 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/discovery-check/models.md). # Models ## The DiscoveryCheckCreatePayload object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheckCreatePayload":{"description":"Payload for creating a Check. All fields are optional.","type":"object","unevaluatedProperties":false,"properties":{"phone_ip":{"description":"Optional. The IP address (IPv4 or IPv6) of the mobile device whose number is being discovered.","type":"string"},"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"},"redirect_url":{"description":"Optional. URL the platform will redirect the device to after the verification step.\nStatus and (on failure) `error_code` are appended as query parameters.\n","type":"string","format":"uri"}}}}}} ``` ## The DiscoveryCheckCodeSubmission object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheckCodeSubmission":{"description":"Body used to submit the verification `code` returned at the end of the redirect chain, completing the Check.","type":"object","unevaluatedProperties":false,"required":["code"],"properties":{"code":{"description":"The verification code returned at the end of the redirect chain.","type":"string"}}}}}} ``` ## The DiscoveryCheck object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheck":{"description":"A Check resource in any of its states, selected by `status`: `ACCEPTED`/`PENDING` carry\n`ttl`; `COMPLETED` carries `network_id`; `ERROR`/`EXPIRED` carry `error_code`. The\ndiscovered `phone_number` is delivered only on the code-submission response, not on reads.\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"},"check_url":{"description":"Self-link URL for this Check resource. Present on the create response so the client\ncan drive the verification flow without composing the path itself.\n","type":"string","format":"uri"},"status":{"description":"The current state of the Check.","type":"string","enum":["ACCEPTED","PENDING","COMPLETED","ERROR","EXPIRED"]},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`.","type":"integer"},"network_id":{"description":"Network identifier resolved during the discovery.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"description":"Failure/expiry reason. `ERROR`: `not_mobile_ip`, `mno_not_supported`, `mno_timeout`,\n`mno_redirect_unsupported`. `EXPIRED`: `redirect_not_performed`, `incomplete_redirect`.\n","type":"string"},"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"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ACCEPTED"}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"PENDING"}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["network_id"],"not":{"anyOf":[{"required":["ttl"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ERROR"}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["ttl"]},{"required":["network_id"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"EXPIRED"}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["ttl"]},{"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}"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}} ``` ## The DiscoveryCheckCodeResult object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheckCodeResult":{"description":"Terminal Check returned on successful code submission. `COMPLETED` carries the discovered\n`phone_number` and `network_id`; `ERROR` carries `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"},"check_url":{"description":"Self-link URL for this Check resource. Present on the create response so the client\ncan drive the verification flow without composing the path itself.\n","type":"string","format":"uri"},"status":{"description":"The current state of the Check.","type":"string","enum":["COMPLETED","ERROR"]},"phone_number":{"description":"The phone number discovered from the device's network session, in\n[E.164 format](https://www.itu.int/rec/T-REC-E.164-201011-I/en) (leading `+`).\n","type":"string","format":"E.164"},"network_id":{"description":"Network identifier resolved during the discovery.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"description":"Failure reason when `ERROR`: `not_mobile_ip`, `mno_not_supported`, `mno_timeout`,\n`mno_redirect_unsupported`.\n","type":"string"},"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"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["phone_number","network_id"],"not":{"anyOf":[{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ERROR"}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["phone_number"]},{"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}"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}} ``` ## The DiscoveryCheckCallbackBody object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheckCallbackBody":{"description":"Terminal-state webhook body. `COMPLETED` carries `phone_number` and `network_id`;\n`ERROR`/`EXPIRED` carry `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":{"description":"The current state of the Check.","type":"string","enum":["COMPLETED","ERROR","EXPIRED"]},"phone_number":{"description":"The phone number discovered from the device's network session, in\n[E.164 format](https://www.itu.int/rec/T-REC-E.164-201011-I/en) (leading `+`).\n","type":"string","format":"E.164"},"network_id":{"description":"Network identifier resolved during the discovery.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"description":"Failure/expiry reason. `ERROR`: `not_mobile_ip`, `mno_not_supported`, `mno_timeout`,\n`mno_redirect_unsupported`. `EXPIRED`: `redirect_not_performed`, `incomplete_redirect`.\n","type":"string"},"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"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["phone_number","network_id"]}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ERROR"}}},"then":{"required":["error_code"]}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"EXPIRED"}}},"then":{"required":["error_code"]}}]},"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}"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"}}}} ``` ## The DiscoveryCheckPage object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheckPage":{"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/DiscoveryCheck"}},"page":{"description":"Pagination metadata for the collection.","$ref":"#/components/schemas/page"}}},"DiscoveryCheck":{"description":"A Check resource in any of its states, selected by `status`: `ACCEPTED`/`PENDING` carry\n`ttl`; `COMPLETED` carries `network_id`; `ERROR`/`EXPIRED` carry `error_code`. The\ndiscovered `phone_number` is delivered only on the code-submission response, not on reads.\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"},"check_url":{"description":"Self-link URL for this Check resource. Present on the create response so the client\ncan drive the verification flow without composing the path itself.\n","type":"string","format":"uri"},"status":{"description":"The current state of the Check.","type":"string","enum":["ACCEPTED","PENDING","COMPLETED","ERROR","EXPIRED"]},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`.","type":"integer"},"network_id":{"description":"Network identifier resolved during the discovery.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"description":"Failure/expiry reason. `ERROR`: `not_mobile_ip`, `mno_not_supported`, `mno_timeout`,\n`mno_redirect_unsupported`. `EXPIRED`: `redirect_not_performed`, `incomplete_redirect`.\n","type":"string"},"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"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ACCEPTED"}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"PENDING"}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["network_id"],"not":{"anyOf":[{"required":["ttl"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"ERROR"}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["ttl"]},{"required":["network_id"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"EXPIRED"}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["ttl"]},{"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}"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"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 Discovery 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 Discovery 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 Discovery 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 Discovery 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 Discovery 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 MobileNetworkOperatorNotSupported object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"MobileNetworkOperatorNotSupported":{"description":"The Mobile Network Operator (MNO) for the supplied phone number is not supported.","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 this problem type.","type":"string","const":"mno_not_supported"}}}}}} ``` ## The NotMobileIp object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"NotMobileIp":{"description":"The IP address used to drive the verification redirect is not from a mobile cellular\nnetwork and cannot be routed to a mobile network operator.\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 this problem type.","type":"string","const":"not_mobile_ip"}}}}}} ``` ## The CheckNotFound object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery 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"}}}}}} ``` ## The DiscoveryCheckCompletionBadRequest object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheckCompletionBadRequest":{"description":"The submitted `code` is invalid for this Check (does not match the value issued at the\nend of the redirect chain, or the Check is no longer accepting submissions).\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 this problem type.","type":"string","const":"bad_request"}}}}}} ``` ## The DiscoveryCheckCompletionConflict object ```json {"openapi":"3.1.0","info":{"title":"IDlayr Discovery API","version":"1.0.0"},"components":{"schemas":{"DiscoveryCheckCompletionConflict":{"description":"The Check is not in a state that allows completion. Most commonly the device has not yet\nperformed the redirect; complete the verification flow before submitting the code.\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 this problem type.","type":"string","const":"code_not_ready"}}}}}} ``` --- # 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/discovery-check/models.md?ask=&goal= ``` `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.