Initiate phone verification
Rate limit: 60 requests per 60 seconds. This is a shared quota — the same budget is consumed by a group of related endpoints, so calling any of them reduces what is left for the others (you cannot call each at the full rate independently). Endpoints sharing this quota:
POST /api/v1/users/phone/verifications/confirmationsPOST /api/v1/users/phone/verifications/direct-confirmations
Sends a verification code to the specified phone number. Returns a referenceId to use when verifying the code.
SECURITY: This endpoint can ONLY be used to set a phone number for users who do not yet have a verified phone number. Changing an existing verified phone number is NOT permitted through this endpoint.
To change an existing phone number, users must contact Customer Support.
Authorizations
API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.
Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.
Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
Headers
Body
Country dial code in E.164 prefix format (e.g., "+1", "+44").
^\+[1-9][0-9]{0,3}$"+1"
Phone number digits without country code.
^[0-9]{6,15}$"5551234567"
Method of verification. Defaults to sms if not specified.
sms, voiceCall "sms"