Skip to main content
PUT
Add a sandbox phone number

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
phone_number
string<phone_number>
required

An E.164 formatted phone number to add to the sandbox list.

Example:

"+30123456789"

attempt_code
string
required

The fixed attempt code that will validate verification attempts for this phone number.

Example:

"123456"

response
enum<string>
default:valid

What the API answers for a verification against this sandbox number.

  • valid: Create returns success; Check accepts the attempt code.
  • challenged: Create returns challenged with channels that contain no SMS and no voice.
  • blocked_*: Create returns blocked with the matching reason; no code is checked.
  • shadow_blocked_*: Create returns shadow_blocked with the matching reason.
  • silent_verified: Create returns the silent method; the silent flow returns the attempt code.
  • silent_mismatch: Create returns the silent method; the silent flow fails, and the next Create returns retry with the message method.
  • expired: Create returns success; Check returns expired_or_not_found whatever the code.

attempt_code is required unless the response is blocked_* or expired, which never check a code.

Available options:
valid,
challenged,
blocked_suspicious,
blocked_repeated_attempts,
blocked_invalid_phone_line,
blocked_invalid_phone_number,
blocked_in_block_list,
blocked_invalid_signature,
blocked_expired_signature,
shadow_blocked_suspicious,
shadow_blocked_repeated_attempts,
shadow_blocked_invalid_phone_line,
shadow_blocked_invalid_phone_number,
shadow_blocked_in_block_list,
shadow_blocked_invalid_signature,
shadow_blocked_expired_signature,
silent_verified,
silent_mismatch,
expired
Example:

"silent_verified"

description
string

A note of at most 80 characters, shown under the number in the dashboard.

Maximum string length: 80
Example:

"Silent success on Android"

Response

OK

phone_number
string<phone_number>
required

The E.164 formatted phone number that was added to the sandbox list.

Example:

"+30123456789"

attempt_code
string
required

The fixed attempt code associated with the sandbox phone number.

Example:

"123456"

response
enum<string>
default:valid

What the API answers for a verification against this sandbox number.

  • valid: Create returns success; Check accepts the attempt code.
  • challenged: Create returns challenged with channels that contain no SMS and no voice.
  • blocked_*: Create returns blocked with the matching reason; no code is checked.
  • shadow_blocked_*: Create returns shadow_blocked with the matching reason.
  • silent_verified: Create returns the silent method; the silent flow returns the attempt code.
  • silent_mismatch: Create returns the silent method; the silent flow fails, and the next Create returns retry with the message method.
  • expired: Create returns success; Check returns expired_or_not_found whatever the code.

attempt_code is required unless the response is blocked_* or expired, which never check a code.

Available options:
valid,
challenged,
blocked_suspicious,
blocked_repeated_attempts,
blocked_invalid_phone_line,
blocked_invalid_phone_number,
blocked_in_block_list,
blocked_invalid_signature,
blocked_expired_signature,
shadow_blocked_suspicious,
shadow_blocked_repeated_attempts,
shadow_blocked_invalid_phone_line,
shadow_blocked_invalid_phone_number,
shadow_blocked_in_block_list,
shadow_blocked_invalid_signature,
shadow_blocked_expired_signature,
silent_verified,
silent_mismatch,
expired
Example:

"silent_verified"

description
string

A note of at most 80 characters, shown under the number in the dashboard.

Maximum string length: 80
Example:

"Silent success on Android"