network > simSwap

Check SIM Swap

Check whether a phone number's SIM was changed during a recent lookback window. Use this to flag account takeover risk before sign-in, password reset, payment, or other sensitive actions.

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

Request

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

Request body

phoneNumberstring required

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

periodHoursinteger

Lookback window, in hours, for detecting a recent SIM change. Must be from 1 to 2400. Defaults to 240.

Response

Returns SIM swap risk for the requested phone number.

requestIdstring required

Unique Pinnacle ID for a Network API request.

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

Availability of the carrier-backed insight.

simSwappedboolean nullable required

Whether the SIM changed during the requested window. Null means the carrier insight was unavailable, unsupported, or failed.

latestSimSwapAtstring date-time nullable required

Timestamp of the latest SIM change in the requested window, when the carrier provides it.

Changes

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