Endpoints
Create or retry a verification
Create a new verification for a specific phone number. If another non-expired verification exists (the request is performed within the verification window), this endpoint will perform a retry instead.
POST
/
v2
/
verification
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
target
object
requiredThe target. Currently this can only be an E.164 formatted phone number.
signals
object
The signals used for anti-fraud.
options
object
Verification options
metadata
object
The metadata for this verification. This object will be returned with every response or webhook sent that refers to this verification.
Response
200 - application/json
id
string
The verification identifier.
status
enum<string>
The status of the verification.
Available options:
success
, retry
, blocked
method
enum<string>
The method used for verifying this phone number.
Available options:
message
metadata
object
The metadata for this verification.
request_id
string
Was this page helpful?