Add a sandbox phone number
Register a phone number as a sandbox number and associate it with a fixed attempt code. Subsequent verification attempts against this number will not trigger a real SMS/call and will validate against the configured attempt code.
This operation is idempotent - re-adding the same phone number will overwrite the existing attempt code.
In order to get access to this endpoint, contact our support team.
Authorizations
Body
What the API answers for a verification against this sandbox number.
valid: Create returnssuccess; Check accepts the attempt code.challenged: Create returnschallengedwith channels that contain no SMS and no voice.blocked_*: Create returnsblockedwith the matchingreason; no code is checked.shadow_blocked_*: Create returnsshadow_blockedwith the matchingreason.silent_verified: Create returns thesilentmethod; the silent flow returns the attempt code.silent_mismatch: Create returns thesilentmethod; the silent flow fails, and the next Create returnsretrywith themessagemethod.expired: Create returnssuccess; Check returnsexpired_or_not_foundwhatever the code.
attempt_code is required unless the response is blocked_* or expired, which never check a code.
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 "silent_verified"
Response
OK
What the API answers for a verification against this sandbox number.
valid: Create returnssuccess; Check accepts the attempt code.challenged: Create returnschallengedwith channels that contain no SMS and no voice.blocked_*: Create returnsblockedwith the matchingreason; no code is checked.shadow_blocked_*: Create returnsshadow_blockedwith the matchingreason.silent_verified: Create returns thesilentmethod; the silent flow returns the attempt code.silent_mismatch: Create returns thesilentmethod; the silent flow fails, and the next Create returnsretrywith themessagemethod.expired: Create returnssuccess; Check returnsexpired_or_not_foundwhatever the code.
attempt_code is required unless the response is blocked_* or expired, which never check a code.
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 "silent_verified"