> This page is for version v2 (default). > For other versions, use one of these documentation indexes: > - v2 (default): https://docs.pinnacle.sh/v-2/llms.txt > - v1: https://docs.pinnacle.sh/v1/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.pinnacle.sh/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server. # Get Network Request GET https://api.pinnacle.sh/network/requests/{requestId} Retrieve one Network API request by ID. The response includes lifecycle timestamps, request status, your `clientRef`, and result fields from the original check. Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access. Reference: https://docs.pinnacle.sh/api-reference/network/get-network-request ## Authentication - `PINNACLE-API-KEY` header (required) — API Key authentication via header ## Request ### Path parameters - `requestId` (string, required) — Network API request ID returned by a Network API endpoint. ## Response ### 200 Returns the Network API request summary. - `requestId` (string, required) — Unique Pinnacle ID for a Network API request. - `type` (enum, required) — Type of Network API check. - Allowed values: `silent-auth`, `sim-swap`, `subscriber-match` - `status` (enum, required) — Lifecycle status of a Network API request. `started` and `challenge-issued` are in-progress states; `completed`, `failed`, and `expired` are terminal states. - Allowed values: `started`, `challenge-issued`, `completed`, `failed`, `expired` - `clientRef` (string, required, nullable) — Your correlation ID from the original request. - `createdAt` (string, required) — Timestamp when the request record was created. - `updatedAt` (string, required) — Timestamp when the request record was last updated. - `completedAt` (string, required, nullable) — Timestamp when the request reached a terminal state. - `expiresAt` (string, required, nullable) — Expiration timestamp for short-lived request flows, when applicable. - `errorMessage` (string, required, nullable) — Error message for failed requests. - `result` (NetworkRequestResult, required) — Result from the original check, or null while the request is still pending or no result is available. ## Errors ### 400 Bad Request Error The request was unacceptable, often due to providing an invalid update. Errors may originate from invalid payload or from Pinnacle's additional validation checks. For example, providing an URL that cannot be accessed, updating a campaign that is currently being reviewed, updating data that you cannot access, sending a malformed message, and so on. For `Pinnacle Validation Error` inspect the `error` payload to determine the source of the failure. These errors are likely due to additional validation and business logic checks. For `Request Validation Error` inspect the `description` and `errors` payload to determine the source of failure. These errors are likely due to invalid payload inside the request. - `GetNetworkRequestRequestBadRequestError` ### 401 Unauthorized Error The request lacks valid authentication credentials or the provided credentials are invalid. Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint. - `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code. ### 403 Forbidden Error Your subscription does not include access to this feature. This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature. - `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code. ### 404 Not Found Error The requested resource could not be found. This may occur if the identifier is incorrect, the resource has been deleted, or you don't have permission to access it. - `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code. ### 500 Internal Server Error An unexpected error occurred on Pinnacle's servers while processing your request. If this error persists, please contact support with the request details. - `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code. ## Types ### NetworkRequestResult Result from the original check, or null while the request is still pending or no result is available. ### ZodError - `description` (string, required) — Human-readable summary of validation failures. - `errors` (ZodErrorErrors, required) — Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array ### Error Standard error response returned when a request cannot be processed successfully. - `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code. ### SimSwapResponse - `requestId` (string, required) — Unique Pinnacle ID for a Network API request. - `status` (enum, required) — Availability of the carrier-backed insight. - Allowed values: `available`, `unavailable`, `unsupported`, `failed` - `simSwapped` (boolean, required, nullable) — Whether the SIM changed during the requested window. Null means the carrier insight was unavailable, unsupported, or failed. - `latestSimSwapAt` (string, required, nullable) — Timestamp of the latest SIM change in the requested window, when the carrier provides it. ### SubscriberMatchResponse - `requestId` (string, required) — Unique Pinnacle ID for a Network API request. - `status` (enum, required) — Availability of the carrier-backed insight. - Allowed values: `available`, `unavailable`, `unsupported`, `failed` - `matches` (SubscriberMatchResponseMatches, required) — Match strength for each evaluated subscriber attribute. - `exact`: Carrier record matches the submitted value exactly. - `high`: Strong match with minor formatting or normalization differences. - `partial`: Some parts match, but the value is not a strong match. - `low`: Weak match. - `none`: Carrier record does not match the submitted value. - `unavailable`: Carrier could not evaluate this attribute. - `included-with-address-match`: Attribute was evaluated as part of the overall address match. - `unknown`: Carrier returned a match value Pinnacle does not recognize yet. ### SilentAuthCheckResponse - `requestId` (string, required) — Unique Pinnacle ID for a Network API request. - `status` (enum, required) — Terminal verification result after exchanging a device flow code. `completed` means the phone number was verified; `failed` means the verification did not complete successfully. To inspect pending lifecycle states, use [Get Network Request](/api-reference/network/get-network-request). - Allowed values: `completed`, `failed` ### ZodErrorErrors Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array ### SubscriberMatchResponseMatches Match strength for each evaluated subscriber attribute. - `exact`: Carrier record matches the submitted value exactly. - `high`: Strong match with minor formatting or normalization differences. - `partial`: Some parts match, but the value is not a strong match. - `low`: Weak match. - `none`: Carrier record does not match the submitted value. - `unavailable`: Carrier could not evaluate this attribute. - `included-with-address-match`: Attribute was evaluated as part of the overall address match. - `unknown`: Carrier returned a match value Pinnacle does not recognize yet. - `idDocument` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `givenName` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `familyName` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `address` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `streetName` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `streetNumber` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `postalCode` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `locality` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `region` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `country` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `streetNumberSuffix` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` - `birthdate` (enum, optional) — Carrier match strength for one submitted subscriber attribute. - Allowed values: `exact`, `high`, `partial`, `low`, `none`, `unavailable`, `included-with-address-match`, `unknown` ## Examples **Response** ```json { "requestId": "nar_1234567890ABCDEF", "type": "sim-swap", "status": "completed", "clientRef": null, "createdAt": "2026-06-12T18:25:00Z", "updatedAt": "2026-06-12T18:25:01Z", "completedAt": "2026-06-12T18:25:01Z", "expiresAt": null, "errorMessage": null, "result": { "requestId": "nar_1234567890ABCDEF", "status": "available", "simSwapped": false, "latestSimSwapAt": null } } ``` **SDK Code** ```python Network Request import requests url = "https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF" headers = {"PINNACLE-API-KEY": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Network Request const url = 'https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF'; const options = {method: 'GET', headers: {'PINNACLE-API-KEY': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Network Request package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("PINNACLE-API-KEY", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Network Request require 'uri' require 'net/http' url = URI("https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["PINNACLE-API-KEY"] = '' response = http.request(request) puts response.read_body ``` ```java Network Request import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF") .header("PINNACLE-API-KEY", "") .asString(); ``` ```php Network Request request('GET', 'https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF', [ 'headers' => [ 'PINNACLE-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp Network Request using RestSharp; var client = new RestClient("https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF"); var request = new RestRequest(Method.GET); request.AddHeader("PINNACLE-API-KEY", ""); IRestResponse response = client.Execute(request); ``` ```swift Network Request import Foundation let headers = ["PINNACLE-API-KEY": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/network/requests/nar_1234567890ABCDEF")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```