> 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/readme-1/v1.md).
# v1
Silent network authentication. Create a Check, drive the device through the verification URL, POST the resulting code to resolve whether the phone number matches the active SIM on the device.
## List Checks
> Get a page of Checks scoped to the calling project.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Secure SNA API","version":"1.0.0"},"tags":[{"name":"secure_sna_check_v1","description":"Silent network authentication. Create a Check, drive the device through the verification\nURL, POST the resulting code to resolve whether the phone number matches the active SIM\non the device.\n"}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"ProjectBearerAuth":[]}],"components":{"securitySchemes":{"ProjectBearerAuth":{"description":"The IDlayr APIs expect the bearer token to be an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4).\nThe access token should be in the `Authorization` HTTP header,\ne.g. `Authorization: Bearer {access_token}`. See [Create an Access Token](/docs/reference/basics#operation/oauth2-token).\n\nThe token should be associated with an **IDlayr** Project. These are created using a Project's `client_id` and `client_secret`.\n","type":"http","scheme":"bearer"}},"parameters":{"pageSize":{"name":"size","description":"The number of items returned per page.","in":"query","schema":{"type":"integer","default":10,"minimum":1,"maximum":100}},"pageNumber":{"name":"page","description":"The page number being requested.","in":"query","schema":{"type":"integer","default":1,"minimum":1}}},"headers":{"X-RateLimit-Limit":{"description":"Request limit per second.","schema":{"type":"integer"},"required":true},"X-RateLimit-Remaining":{"description":"Remaining requests for the rate limit period.","schema":{"type":"integer"},"required":true},"X-RateLimit-Reset":{"description":"Time left, in seconds, for `X-RateLimit-Remaining` to be reset.","schema":{"type":"integer"},"required":true}},"schemas":{"SecureSnaCheckPage":{"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/SecureSnaCheck"}},"page":{"description":"Pagination metadata for the collection.","$ref":"#/components/schemas/page"}}},"SecureSnaCheck":{"description":"A Check resource. The presence of `match`, `network_id`, `error_code` and `ttl` is\ndetermined by `status`:\n- `ACCEPTED` / `PENDING`: `ttl` required; `match` / `network_id` / `error_code` absent.\n- `COMPLETED`: `match` and `network_id` required; `ttl` / `error_code` absent.\n- `ERROR` / `EXPIRED`: `error_code` required; `match` / `network_id` / `ttl` 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"},"url":{"description":"Self-link URL for this Check resource. Present on the create response so the client can\ndrive the verification flow without composing the path itself.\n","type":"string","format":"uri"},"status":{"$ref":"#/components/schemas/SecureSnaCheckStatus"},"match":{"description":"Whether the verified phone number matched the network-attached number.","type":"boolean"},"created_at":{"description":"When the Check was created.","$ref":"#/components/schemas/ISODateTime"},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`.","type":"integer"},"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"},"network_id":{"description":"Network identifier resolved during the verification.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"$ref":"#/components/schemas/SecureSnaCheckErrorCode"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ACCEPTED","PENDING"]}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["match","network_id"],"not":{"anyOf":[{"required":["ttl"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ERROR","EXPIRED"]}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["ttl"]}]}}}]},"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}"},"SecureSnaCheckStatus":{"description":"The status of a Check:\n- `ACCEPTED`: The Check has been authorized; the device has not yet performed the redirect.\n- `PENDING`: The redirect has been performed; awaiting completion via PATCH.\n- `COMPLETED`: The Check has completed and `match` reflects the verification result.\n- `EXPIRED`: The Check expired before a terminal state was reached.\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"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"SecureSnaCheckErrorCode":{"description":"Set when `status` is `ERROR` or `EXPIRED`.\n\nERROR codes:\n- `not_mobile_ip`: The IP address associated with the request is not from a mobile cellular network.\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- `ip_mismatch`: The IP address used for create and redirect did not match.\n- `ip_msisdn_mismatch`: The IP address and phone number do not belong to the same MNO.\n\nEXPIRED codes:\n- `redirect_not_performed`: The verification redirect was never executed by the device before the Check expired.\n- `incomplete_redirect`: The verification redirect started but did not complete before the Check expired.\n","type":"string","enum":["not_mobile_ip","mno_not_supported","mno_timeout","mno_user_not_found","mno_response_error","mno_server_error","mno_no_data_available","ip_mismatch","ip_msisdn_mismatch","redirect_not_performed","incomplete_redirect"]},"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"}}},"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"}}}}},"paths":{"/v1/number-verification/secure-sna-checks":{"get":{"summary":"List Checks","description":"Get a page of Checks scoped to the calling project.","operationId":"get-secure-sna-checks-v1","tags":["secure_sna_check_v1"],"parameters":[{"$ref":"#/components/parameters/pageSize"},{"$ref":"#/components/parameters/pageNumber"},{"name":"search","in":"query","description":"Optional RSQL filter applied on top of the implicit project scope. Filterable fields: status, match, network_id, error_code, reference_id, created_at, updated_at.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A page of Checks.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheckPage"}}}},"429":{"description":"Rate Limit Reached","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}}}}}
```
## Create a Check
> Starts a Secure SNA verification flow. The response includes the Check \`status\`\
> (initially \`ACCEPTED\`) and the \`url\` for the device to perform the verification.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Secure SNA API","version":"1.0.0"},"tags":[{"name":"secure_sna_check_v1","description":"Silent network authentication. Create a Check, drive the device through the verification\nURL, POST the resulting code to resolve whether the phone number matches the active SIM\non the device.\n"}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"ProjectBearerAuth":[]}],"components":{"securitySchemes":{"ProjectBearerAuth":{"description":"The IDlayr APIs expect the bearer token to be an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4).\nThe access token should be in the `Authorization` HTTP header,\ne.g. `Authorization: Bearer {access_token}`. See [Create an Access Token](/docs/reference/basics#operation/oauth2-token).\n\nThe token should be associated with an **IDlayr** Project. These are created using a Project's `client_id` and `client_secret`.\n","type":"http","scheme":"bearer"}},"schemas":{"SecureSnaCheckCreatePayload":{"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"},"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 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"}}},"SecureSnaCheckCallbackPayload":{"description":"Body POSTed to the customer-supplied `callback_url` when the Check reaches a terminal\nstatus. `status` is one of `COMPLETED`, `ERROR`, or `EXPIRED`; field shape mirrors\n`SecureSnaCheck` for that subset of states.\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 verified phone number matched the network-attached number.","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"},"network_id":{"description":"Network identifier resolved during the verification.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"$ref":"#/components/schemas/SecureSnaCheckErrorCode"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["match","network_id"],"not":{"required":["error_code"]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ERROR","EXPIRED"]}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["match"]},{"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}"},"ISODateTime":{"description":"A DateTime conforming to ISO 8601 specifications.","type":"string","format":"date-time"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"SecureSnaCheckErrorCode":{"description":"Set when `status` is `ERROR` or `EXPIRED`.\n\nERROR codes:\n- `not_mobile_ip`: The IP address associated with the request is not from a mobile cellular network.\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- `ip_mismatch`: The IP address used for create and redirect did not match.\n- `ip_msisdn_mismatch`: The IP address and phone number do not belong to the same MNO.\n\nEXPIRED codes:\n- `redirect_not_performed`: The verification redirect was never executed by the device before the Check expired.\n- `incomplete_redirect`: The verification redirect started but did not complete before the Check expired.\n","type":"string","enum":["not_mobile_ip","mno_not_supported","mno_timeout","mno_user_not_found","mno_response_error","mno_server_error","mno_no_data_available","ip_mismatch","ip_msisdn_mismatch","redirect_not_performed","incomplete_redirect"]},"SecureSnaCheck":{"description":"A Check resource. The presence of `match`, `network_id`, `error_code` and `ttl` is\ndetermined by `status`:\n- `ACCEPTED` / `PENDING`: `ttl` required; `match` / `network_id` / `error_code` absent.\n- `COMPLETED`: `match` and `network_id` required; `ttl` / `error_code` absent.\n- `ERROR` / `EXPIRED`: `error_code` required; `match` / `network_id` / `ttl` 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"},"url":{"description":"Self-link URL for this Check resource. Present on the create response so the client can\ndrive the verification flow without composing the path itself.\n","type":"string","format":"uri"},"status":{"$ref":"#/components/schemas/SecureSnaCheckStatus"},"match":{"description":"Whether the verified phone number matched the network-attached number.","type":"boolean"},"created_at":{"description":"When the Check was created.","$ref":"#/components/schemas/ISODateTime"},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`.","type":"integer"},"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"},"network_id":{"description":"Network identifier resolved during the verification.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"$ref":"#/components/schemas/SecureSnaCheckErrorCode"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ACCEPTED","PENDING"]}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["match","network_id"],"not":{"anyOf":[{"required":["ttl"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ERROR","EXPIRED"]}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["ttl"]}]}}}]},"SecureSnaCheckStatus":{"description":"The status of a Check:\n- `ACCEPTED`: The Check has been authorized; the device has not yet performed the redirect.\n- `PENDING`: The redirect has been performed; awaiting completion via PATCH.\n- `COMPLETED`: The Check has completed and `match` reflects the verification result.\n- `EXPIRED`: The Check expired before a terminal state was reached.\n- `ERROR`: An error prevented the Check from completing; see `error_code`.\n","type":"string","enum":["ACCEPTED","PENDING","COMPLETED","EXPIRED","ERROR"]},"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"]}}},"IPMSISDNMismatch":{"description":"The IP address and the phone number (MSISDN) are not associated with the same mobile\nnetwork 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":"ip_msisdn_mismatch"}}},"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"}}},"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"}}}},"parameters":{"digest":{"name":"digest","in":"header","description":"The body contents hashed with the algorithm identified in the `Authorization` header\nand then Base64 encoded (e.g. `SHA-256=base64(SHA256(body))`).\n","schema":{"type":"string"}},"date":{"name":"date","in":"header","description":"The date and time at which the message was originated.","schema":{"type":"string"}},"host":{"name":"host","in":"header","description":"The host and port number of the server to which the request is being sent.","schema":{"type":"string"}}},"headers":{"X-RateLimit-Limit":{"description":"Request limit per second.","schema":{"type":"integer"},"required":true},"X-RateLimit-Remaining":{"description":"Remaining requests for the rate limit period.","schema":{"type":"integer"},"required":true},"X-RateLimit-Reset":{"description":"Time left, in seconds, for `X-RateLimit-Remaining` to be reset.","schema":{"type":"integer"},"required":true}}},"paths":{"/v1/number-verification/secure-sna-checks":{"post":{"summary":"Create a Check","description":"Starts a Secure SNA verification flow. The response includes the Check `status`\n(initially `ACCEPTED`) and the `url` for the device to perform the verification.\n","operationId":"create-secure-sna-check-v1","tags":["secure_sna_check_v1"],"requestBody":{"description":"JSON payload to create a Check.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheckCreatePayload"}}}},"callbacks":{"secureSnaCheckEndStatus":{"{$request.body#/callback_url}":{"post":{"summary":"Check has reached a terminal status","description":"Sent once when the Check transitions to a terminal status (`COMPLETED`,\n`EXPIRED`, or `ERROR`).\n","parameters":[{"name":"x-idlayr-callback","in":"header","description":"Identifies the webhook source. Value is `secure_sna`.","required":true,"schema":{"type":"string","enum":["secure_sna"]}},{"name":"Authorization","in":"header","description":"HTTP message signature. Format:\n`Signature keyId=\"\",algorithm=\"rsa-sha256\",headers=\"(request-target) host date x-idlayr-callback digest\",signature=\"\"`.\n\n- `keyId` identifies the public key (fetch from the IDlayr JWKS endpoint).\n- `algorithm` is `rsa-sha256`.\n- `headers` lists the canonical components included in the signature\n input: `(request-target)`, `host`, `date`, `x-idlayr-callback`,\n `digest`.\n- `signature` is the base64-encoded RSA-SHA256 signature.\n\nSee [Signed HTTP Messages](/docs/authentication#signed).\n","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/digest"},{"$ref":"#/components/parameters/date"},{"$ref":"#/components/parameters/host"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheckCallbackPayload"}}}},"responses":{"200":{"description":"The receiving server should return a 200 response to indicate it has\nprocessed the callback. Upon receipt of a non-200 response a retry process\nwill begin (1 immediate attempt + up to 6 retries at 10/20/30/40/50/60s\ngaps, ~3.5 min total).\n"}}}}}},"responses":{"201":{"description":"Check created.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheck"}}}},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/PhoneNumberBadRequest"}}}},"409":{"description":"IP/MSISDN Mismatch.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/IPMSISDNMismatch"}}}},"412":{"description":"Not a mobile IP","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotMobileIp"}}}},"429":{"description":"Rate Limit Reached","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}}}}}
```
## Get a Check
> Get the Check identified by \`check\_id\`.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Secure SNA API","version":"1.0.0"},"tags":[{"name":"secure_sna_check_v1","description":"Silent network authentication. Create a Check, drive the device through the verification\nURL, POST the resulting code to resolve whether the phone number matches the active SIM\non the device.\n"}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"ProjectBearerAuth":[]}],"components":{"securitySchemes":{"ProjectBearerAuth":{"description":"The IDlayr APIs expect the bearer token to be an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4).\nThe access token should be in the `Authorization` HTTP header,\ne.g. `Authorization: Bearer {access_token}`. See [Create an Access Token](/docs/reference/basics#operation/oauth2-token).\n\nThe token should be associated with an **IDlayr** Project. These are created using a Project's `client_id` and `client_secret`.\n","type":"http","scheme":"bearer"}},"headers":{"X-RateLimit-Limit":{"description":"Request limit per second.","schema":{"type":"integer"},"required":true},"X-RateLimit-Remaining":{"description":"Remaining requests for the rate limit period.","schema":{"type":"integer"},"required":true},"X-RateLimit-Reset":{"description":"Time left, in seconds, for `X-RateLimit-Remaining` to be reset.","schema":{"type":"integer"},"required":true}},"schemas":{"SecureSnaCheck":{"description":"A Check resource. The presence of `match`, `network_id`, `error_code` and `ttl` is\ndetermined by `status`:\n- `ACCEPTED` / `PENDING`: `ttl` required; `match` / `network_id` / `error_code` absent.\n- `COMPLETED`: `match` and `network_id` required; `ttl` / `error_code` absent.\n- `ERROR` / `EXPIRED`: `error_code` required; `match` / `network_id` / `ttl` 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"},"url":{"description":"Self-link URL for this Check resource. Present on the create response so the client can\ndrive the verification flow without composing the path itself.\n","type":"string","format":"uri"},"status":{"$ref":"#/components/schemas/SecureSnaCheckStatus"},"match":{"description":"Whether the verified phone number matched the network-attached number.","type":"boolean"},"created_at":{"description":"When the Check was created.","$ref":"#/components/schemas/ISODateTime"},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`.","type":"integer"},"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"},"network_id":{"description":"Network identifier resolved during the verification.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"$ref":"#/components/schemas/SecureSnaCheckErrorCode"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ACCEPTED","PENDING"]}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["match","network_id"],"not":{"anyOf":[{"required":["ttl"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ERROR","EXPIRED"]}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["ttl"]}]}}}]},"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}"},"SecureSnaCheckStatus":{"description":"The status of a Check:\n- `ACCEPTED`: The Check has been authorized; the device has not yet performed the redirect.\n- `PENDING`: The redirect has been performed; awaiting completion via PATCH.\n- `COMPLETED`: The Check has completed and `match` reflects the verification result.\n- `EXPIRED`: The Check expired before a terminal state was reached.\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"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"SecureSnaCheckErrorCode":{"description":"Set when `status` is `ERROR` or `EXPIRED`.\n\nERROR codes:\n- `not_mobile_ip`: The IP address associated with the request is not from a mobile cellular network.\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- `ip_mismatch`: The IP address used for create and redirect did not match.\n- `ip_msisdn_mismatch`: The IP address and phone number do not belong to the same MNO.\n\nEXPIRED codes:\n- `redirect_not_performed`: The verification redirect was never executed by the device before the Check expired.\n- `incomplete_redirect`: The verification redirect started but did not complete before the Check expired.\n","type":"string","enum":["not_mobile_ip","mno_not_supported","mno_timeout","mno_user_not_found","mno_response_error","mno_server_error","mno_no_data_available","ip_mismatch","ip_msisdn_mismatch","redirect_not_performed","incomplete_redirect"]},"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"}}},"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"}}}}},"paths":{"/v1/number-verification/secure-sna-checks/{check_id}":{"get":{"summary":"Get a Check","description":"Get the Check identified by `check_id`.","operationId":"get-secure-sna-check-v1","tags":["secure_sna_check_v1"],"responses":{"200":{"description":"The Check.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheck"}}}},"404":{"description":"Check Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/CheckNotFound"}}}},"429":{"description":"Rate Limit Reached","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}}}}}
```
## Submit the verification code
> Completes the Check identified by \`check\_id\` by submitting the \`code\` returned at the\
> end of the redirect chain. Until the code is submitted the Check stays \`PENDING\` and is\
> eligible to transition to \`EXPIRED\` after its TTL.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Secure SNA API","version":"1.0.0"},"tags":[{"name":"secure_sna_check_v1","description":"Silent network authentication. Create a Check, drive the device through the verification\nURL, POST the resulting code to resolve whether the phone number matches the active SIM\non the device.\n"}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"security":[{"ProjectBearerAuth":[]}],"components":{"securitySchemes":{"ProjectBearerAuth":{"description":"The IDlayr APIs expect the bearer token to be an [OAuth2 Access Token](https://tools.ietf.org/html/rfc6749#section-1.4).\nThe access token should be in the `Authorization` HTTP header,\ne.g. `Authorization: Bearer {access_token}`. See [Create an Access Token](/docs/reference/basics#operation/oauth2-token).\n\nThe token should be associated with an **IDlayr** Project. These are created using a Project's `client_id` and `client_secret`.\n","type":"http","scheme":"bearer"}},"schemas":{"SecureSnaCheckCodeSubmission":{"description":"Body used to submit the verification `code` returned at the end of the redirect chain,\ncompleting the Check.\n","type":"object","unevaluatedProperties":false,"required":["code"],"properties":{"code":{"description":"The verification code returned at the end of the redirect chain.","type":"string"}}},"SecureSnaCheck":{"description":"A Check resource. The presence of `match`, `network_id`, `error_code` and `ttl` is\ndetermined by `status`:\n- `ACCEPTED` / `PENDING`: `ttl` required; `match` / `network_id` / `error_code` absent.\n- `COMPLETED`: `match` and `network_id` required; `ttl` / `error_code` absent.\n- `ERROR` / `EXPIRED`: `error_code` required; `match` / `network_id` / `ttl` 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"},"url":{"description":"Self-link URL for this Check resource. Present on the create response so the client can\ndrive the verification flow without composing the path itself.\n","type":"string","format":"uri"},"status":{"$ref":"#/components/schemas/SecureSnaCheckStatus"},"match":{"description":"Whether the verified phone number matched the network-attached number.","type":"boolean"},"created_at":{"description":"When the Check was created.","$ref":"#/components/schemas/ISODateTime"},"ttl":{"description":"Time-to-live, in seconds, before the Check transitions to `EXPIRED`.","type":"integer"},"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"},"network_id":{"description":"Network identifier resolved during the verification.","$ref":"#/components/schemas/NetworkIDResponse"},"error_code":{"$ref":"#/components/schemas/SecureSnaCheckErrorCode"}},"allOf":[{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ACCEPTED","PENDING"]}}},"then":{"required":["ttl"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","const":"COMPLETED"}}},"then":{"required":["match","network_id"],"not":{"anyOf":[{"required":["ttl"]},{"required":["error_code"]}]}}},{"if":{"required":["status"],"properties":{"status":{"description":"Discriminator for the conditional state shape.","enum":["ERROR","EXPIRED"]}}},"then":{"required":["error_code"],"not":{"anyOf":[{"required":["match"]},{"required":["network_id"]},{"required":["ttl"]}]}}}]},"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}"},"SecureSnaCheckStatus":{"description":"The status of a Check:\n- `ACCEPTED`: The Check has been authorized; the device has not yet performed the redirect.\n- `PENDING`: The redirect has been performed; awaiting completion via PATCH.\n- `COMPLETED`: The Check has completed and `match` reflects the verification result.\n- `EXPIRED`: The Check expired before a terminal state was reached.\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"},"NetworkIDResponse":{"description":"The ID of the Network resolved during the verification flow.","type":"string"},"SecureSnaCheckErrorCode":{"description":"Set when `status` is `ERROR` or `EXPIRED`.\n\nERROR codes:\n- `not_mobile_ip`: The IP address associated with the request is not from a mobile cellular network.\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- `ip_mismatch`: The IP address used for create and redirect did not match.\n- `ip_msisdn_mismatch`: The IP address and phone number do not belong to the same MNO.\n\nEXPIRED codes:\n- `redirect_not_performed`: The verification redirect was never executed by the device before the Check expired.\n- `incomplete_redirect`: The verification redirect started but did not complete before the Check expired.\n","type":"string","enum":["not_mobile_ip","mno_not_supported","mno_timeout","mno_user_not_found","mno_response_error","mno_server_error","mno_no_data_available","ip_mismatch","ip_msisdn_mismatch","redirect_not_performed","incomplete_redirect"]},"SecureSnaCheckCodeBadRequest":{"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"}}},"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"}}},"SecureSnaCheckCodeConflict":{"description":"The Check is not in a state that allows code submission. Most commonly the device has not\nyet performed 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"}}},"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"}}}},"headers":{"X-RateLimit-Limit":{"description":"Request limit per second.","schema":{"type":"integer"},"required":true},"X-RateLimit-Remaining":{"description":"Remaining requests for the rate limit period.","schema":{"type":"integer"},"required":true},"X-RateLimit-Reset":{"description":"Time left, in seconds, for `X-RateLimit-Remaining` to be reset.","schema":{"type":"integer"},"required":true}}},"paths":{"/v1/number-verification/secure-sna-checks/{check_id}/code":{"post":{"summary":"Submit the verification code","description":"Completes the Check identified by `check_id` by submitting the `code` returned at the\nend of the redirect chain. Until the code is submitted the Check stays `PENDING` and is\neligible to transition to `EXPIRED` after its TTL.\n","operationId":"submit-secure-sna-check-code-v1","tags":["secure_sna_check_v1"],"requestBody":{"description":"Body carrying the verification code returned at the end of the redirect chain.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheckCodeSubmission"}}}},"responses":{"200":{"description":"Check completed; response carries the terminal state.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheck"}}}},"400":{"description":"Invalid Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheckCodeBadRequest"}}}},"404":{"description":"Check Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/CheckNotFound"}}}},"409":{"description":"The Check is not in a state that allows code submission (e.g. the device has not yet\nperformed the redirect).\n","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/SecureSnaCheckCodeConflict"}}}},"429":{"description":"Rate Limit Reached","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}}}}}
```
## Perform the verification step
> Performs the verification step for the Check identified by \`check\_id\`. The device must drive this request\
> over a cellular data connection so the network operator can attribute the session to a\
> phone number. Returns a 302 redirect; success/error info travels in the \`Location\`\
> query string when the customer supplied a \`redirect\_url\`.
```json
{"openapi":"3.1.0","info":{"title":"IDlayr Secure SNA API","version":"1.0.0"},"tags":[{"name":"secure_sna_check_v1","description":"Silent network authentication. Create a Check, drive the device through the verification\nURL, POST the resulting code to resolve whether the phone number matches the active SIM\non the device.\n"}],"servers":[{"url":"https://{data_residency}.api.idlayr.com","description":"For accounts with data residency in the EU or US.","variables":{"data_residency":{"default":"eu","enum":["eu","us"]}}}],"paths":{"/v1/number-verification/secure-sna-checks/{check_id}/redirect":{"get":{"summary":"Perform the verification step","description":"Performs the verification step for the Check identified by `check_id`. The device must drive this request\nover a cellular data connection so the network operator can attribute the session to a\nphone number. Returns a 302 redirect; success/error info travels in the `Location`\nquery string when the customer supplied a `redirect_url`.\n","operationId":"get-secure-sna-check-redirect-v1","tags":["secure_sna_check_v1"],"responses":{"302":{"description":"Redirects to the customer-supplied `redirect_url`; error info travels in the `Location` query string when applicable.","headers":{"Location":{"$ref":"#/components/headers/Location"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"404":{"description":"Check Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/CheckNotFound"}}}},"429":{"description":"Rate Limit Reached","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/RateLimitReached"}}}}}}}},"components":{"headers":{"Location":{"description":"Used in 3xx redirect responses to point at the next URL.","schema":{"type":"string","format":"uri"}},"X-RateLimit-Limit":{"description":"Request limit per second.","schema":{"type":"integer"},"required":true},"X-RateLimit-Remaining":{"description":"Remaining requests for the rate limit period.","schema":{"type":"integer"},"required":true},"X-RateLimit-Reset":{"description":"Time left, in seconds, for `X-RateLimit-Remaining` to be reset.","schema":{"type":"integer"},"required":true}},"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"}}},"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"}}}}}}
```
---
# 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/readme-1/v1.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.