Identity exposure

Detect a recent SIM swap or carrier port

Queries live carrier data for the number. A recent swap is a strong signal of an account-takeover attempt against SMS-based 2FA, so call this before trusting an SMS OTP from a number you have not seen before.

Billing. $0.25 per successful call. Failed calls are never billed. Charged against prepaid credits when the balance covers it, otherwise metered to your card. Threat Intelligence subscribers and AWS Marketplace bundle customers call this at no extra charge.

post/v1/metered/sim-swap

Request

  • Base URL: https://api.relayshield.net
  • URL: https://api.relayshield.net/v1/metered/sim-swap
  • Auth: one of:
    • API key in header X-RS-API-KEY
    • HTTP bearer

Request body

phonestring required

Phone number in E.164 format. Must start with '+'. Rejected without it, because national formats are ambiguous across carriers.

Example request

{
  "phone": "+14155551234"
}

Response

Success. ok is true and data holds the result.

oktrue required

Changes

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