Skip to main content
Verification endpoints use the /v2/ namespace. /v1/ endpoints are deprecated and will be removed without notice to new integrators.
Updates the details of an existing verification. This endpoint can only be used while the verification’s status is sent. Only properties included in the request body will be updated. Any properties not supplied will retain their existing values. name and email cannot be cleared. mobile and mobile_otp can be removed by sending null. When a verification is updated:
  • All active verification sessions are immediately expired. If the individual is currently completing the verification, their session will be forcibly closed.
  • If the email address is changed, previously issued email tokens are invalidated, and a new verification email is sent automatically (unless the verification is muted).
  • If the mobile number is changed to a new value, a new SMS is sent automatically (unless the verification is muted).

​
Parameters

​
string
required
The unique identifier of the verification to update.
​
string
The full name of the individual being verified.
​
string
The individual’s email address, used for identification and correspondence.
​
string
The individual’s mobile number, supplied in E.164 format. This number is used to send an SMS with a link to open the verification.Send null to remove the mobile number.While it is technically possible to use both mobile and mobile_otp, we strongly recommend using only one. Sending both the verification link and the OTP to the same device does not meet the requirements for two-factor authentication.
​
string
Enables SMS-based two-factor authentication by specifying the individual’s mobile number, formatted in E.164.Send null to remove two-factor authentication.While it is technically possible to use both mobile_otp and mobile, we strongly recommend using only one. Sending both the verification link and the OTP to the same device does not meet the requirements for two-factor authentication.