network > subscriberMatch

Check Subscriber Match

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.

<Note> Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access. </Note>
post/network/subscriber-match

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/network/subscriber-match
  • Auth: API key in header PINNACLE-API-KEY

Request body

phoneNumberstring required

Phone number in E.164 format, including country code.

Response

Returns match strength for each evaluated subscriber attribute.

requestIdstring required

Unique Pinnacle ID for a Network API request.

status'available' | 'unavailable' | 'unsupported' | 'failed' required

Availability of the carrier-backed insight.

Changes

No recorded changes to this operation across all 1 revision of this API.