Skip to main content
POST
Call Forwarding Check
Active call forwarding can divert incoming calls — including voice OTP calls — to a device the legitimate user does not control. A number with call forwarding enabled during a sensitive flow (login, password reset, large transaction) is a common account-takeover signal.Use this check as a pre-authentication risk layer: if forwarding is active, apply stricter verification or fall back to a non-voice channel.
When success is false, callForwarding and callForwardingType are omitted.
phoneDetail contains enriched metadata about the phone number returned alongside the forwarding result — including operator, country, line type, and time zones. All fields are omitted when not available for the given number or operator.

Authorizations

clientId
string
header
required

OTPless API Client ID

clientSecret
string
header
required

OTPless API Client Secret

Body

application/json
phoneNumber
string
required

Phone number including country code, without plus sign. Example: 917020141726 for +91 70201 41726.

Example:

"917020141726"

Response

HTTP 200 — Request accepted. Inspect success in the body:

  • success: true — Check completed. Use callForwarding to determine result.
  • success: false — Check could not be completed. Inspect error for details.
success
boolean
required

true if the check completed successfully. false if the check could not be completed — inspect the error object for details.

callForwarding
boolean

true if call forwarding is currently active on the number. false if it is not. Omitted when success is false.

callForwardingType
string

Human-readable forwarding state: active when call forwarding is on, inactive when off. Omitted when success is false.

Example:

"inactive"

phoneDetail
object

Enriched phone metadata. Fields are omitted when not available for the given number or operator.

error
object

Error object returned inside a 200 response when success is false.