> 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. # Check Subscriber Match POST https://api.pinnacle.sh/network/subscriber-match Content-Type: application/json Compare user-provided identity details against the carrier's subscriber record. Results return match strength per attribute, so you can use partial signals without receiving carrier PII. Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access. Reference: https://docs.pinnacle.sh/api-reference/network/check-subscriber-match ## Authentication - `PINNACLE-API-KEY` header (required) — API Key authentication via header ## Request ### Body (application/json) This endpoint expects a SubscriberMatchRequest. - `phoneNumber` (string, required) — Phone number in E.164 format, including country code. - `attributes` (SubscriberMatchAttributes, required) — User-provided subscriber details to compare with the carrier record. Provide at least one non-empty field. ## Response ### 200 Returns match strength for each evaluated subscriber attribute. - `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. ## 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. - `CheckSubscriberMatchRequestBadRequestError` ### 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. ### 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 ### SubscriberMatchAttributes User-provided subscriber details to compare with the carrier record. Provide at least one non-empty field. - `idDocument` (string, optional) — Government-issued ID number, such as a national ID, passport number, or driver's license number when supported by the carrier. Do not send an image or file. - `givenName` (string, optional) — Subscriber's first or given name. - `familyName` (string, optional) — Subscriber's last or family name. - `streetName` (string, optional) — Street name from the subscriber's address. - `streetNumber` (string, optional) — Street number from the subscriber's address. - `postalCode` (string, optional) — Postal or ZIP code from the subscriber's address. - `locality` (string, optional) — City or locality from the subscriber's address. - `region` (string, optional) — State, province, or region from the subscriber's address. - `country` (string, optional) — Country from the subscriber's address. - `streetNumberSuffix` (string, optional) — Suffix attached to the street number, such as the A in 123A Main Street. - `birthdate` (string, optional) — Subscriber's date of birth in YYYY-MM-DD format. ### 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` ### 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. ### 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 ## Examples ### Subscriber Match **Response** ```json { "requestId": "nar_1234567890ABCDEF", "status": "available", "matches": { "givenName": "exact", "familyName": "high", "streetName": "high", "streetNumber": "exact", "postalCode": "exact", "locality": "exact", "region": "exact", "country": "exact", "birthdate": "exact" } } ``` **SDK Code** ```python Subscriber Match import requests url = "https://api.pinnacle.sh/network/subscriber-match" headers = {"PINNACLE-API-KEY": ""} response = requests.post(url, headers=headers) print(response.json()) ``` ```javascript Subscriber Match const url = 'https://api.pinnacle.sh/network/subscriber-match'; const options = {method: 'POST', 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 Subscriber Match package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.pinnacle.sh/network/subscriber-match" req, _ := http.NewRequest("POST", 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 Subscriber Match require 'uri' require 'net/http' url = URI("https://api.pinnacle.sh/network/subscriber-match") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["PINNACLE-API-KEY"] = '' response = http.request(request) puts response.read_body ``` ```java Subscriber Match import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.pinnacle.sh/network/subscriber-match") .header("PINNACLE-API-KEY", "") .asString(); ``` ```php Subscriber Match request('POST', 'https://api.pinnacle.sh/network/subscriber-match', [ 'headers' => [ 'PINNACLE-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp Subscriber Match using RestSharp; var client = new RestClient("https://api.pinnacle.sh/network/subscriber-match"); var request = new RestRequest(Method.POST); request.AddHeader("PINNACLE-API-KEY", ""); IRestResponse response = client.Execute(request); ``` ```swift Subscriber Match import Foundation let headers = ["PINNACLE-API-KEY": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/network/subscriber-match")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" 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() ``` ### Account Verification **Request** ```json { "phoneNumber": "+14155550123", "attributes": { "givenName": "Jane", "familyName": "Doe", "streetName": "Market Street", "streetNumber": "123", "postalCode": "94105", "locality": "San Francisco", "region": "CA", "country": "US", "birthdate": "1990-01-31" } } ``` **Response** ```json { "requestId": "nar_1234567890ABCDEF", "status": "available", "matches": { "givenName": "exact", "familyName": "high", "streetName": "high", "streetNumber": "exact", "postalCode": "exact", "locality": "exact", "region": "exact", "country": "exact", "birthdate": "exact" } } ``` **SDK Code** ```python Account Verification import requests url = "https://api.pinnacle.sh/network/subscriber-match" payload = { "phoneNumber": "+14155550123", "attributes": { "givenName": "Jane", "familyName": "Doe", "streetName": "Market Street", "streetNumber": "123", "postalCode": "94105", "locality": "San Francisco", "region": "CA", "country": "US", "birthdate": "1990-01-31" } } headers = { "PINNACLE-API-KEY": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Account Verification const url = 'https://api.pinnacle.sh/network/subscriber-match'; const options = { method: 'POST', headers: {'PINNACLE-API-KEY': '', 'Content-Type': 'application/json'}, body: '{"phoneNumber":"+14155550123","attributes":{"givenName":"Jane","familyName":"Doe","streetName":"Market Street","streetNumber":"123","postalCode":"94105","locality":"San Francisco","region":"CA","country":"US","birthdate":"1990-01-31"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Account Verification package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.pinnacle.sh/network/subscriber-match" payload := strings.NewReader("{\n \"phoneNumber\": \"+14155550123\",\n \"attributes\": {\n \"givenName\": \"Jane\",\n \"familyName\": \"Doe\",\n \"streetName\": \"Market Street\",\n \"streetNumber\": \"123\",\n \"postalCode\": \"94105\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"birthdate\": \"1990-01-31\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("PINNACLE-API-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Account Verification require 'uri' require 'net/http' url = URI("https://api.pinnacle.sh/network/subscriber-match") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["PINNACLE-API-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"phoneNumber\": \"+14155550123\",\n \"attributes\": {\n \"givenName\": \"Jane\",\n \"familyName\": \"Doe\",\n \"streetName\": \"Market Street\",\n \"streetNumber\": \"123\",\n \"postalCode\": \"94105\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"birthdate\": \"1990-01-31\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java Account Verification import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.pinnacle.sh/network/subscriber-match") .header("PINNACLE-API-KEY", "") .header("Content-Type", "application/json") .body("{\n \"phoneNumber\": \"+14155550123\",\n \"attributes\": {\n \"givenName\": \"Jane\",\n \"familyName\": \"Doe\",\n \"streetName\": \"Market Street\",\n \"streetNumber\": \"123\",\n \"postalCode\": \"94105\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"birthdate\": \"1990-01-31\"\n }\n}") .asString(); ``` ```php Account Verification request('POST', 'https://api.pinnacle.sh/network/subscriber-match', [ 'body' => '{ "phoneNumber": "+14155550123", "attributes": { "givenName": "Jane", "familyName": "Doe", "streetName": "Market Street", "streetNumber": "123", "postalCode": "94105", "locality": "San Francisco", "region": "CA", "country": "US", "birthdate": "1990-01-31" } }', 'headers' => [ 'Content-Type' => 'application/json', 'PINNACLE-API-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp Account Verification using RestSharp; var client = new RestClient("https://api.pinnacle.sh/network/subscriber-match"); var request = new RestRequest(Method.POST); request.AddHeader("PINNACLE-API-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"phoneNumber\": \"+14155550123\",\n \"attributes\": {\n \"givenName\": \"Jane\",\n \"familyName\": \"Doe\",\n \"streetName\": \"Market Street\",\n \"streetNumber\": \"123\",\n \"postalCode\": \"94105\",\n \"locality\": \"San Francisco\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"birthdate\": \"1990-01-31\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Account Verification import Foundation let headers = [ "PINNACLE-API-KEY": "", "Content-Type": "application/json" ] let parameters = [ "phoneNumber": "+14155550123", "attributes": [ "givenName": "Jane", "familyName": "Doe", "streetName": "Market Street", "streetNumber": "123", "postalCode": "94105", "locality": "San Francisco", "region": "CA", "country": "US", "birthdate": "1990-01-31" ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/network/subscriber-match")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```