Phone Numbers

Send a verification code to a phone number

Changed on

Sends a one-time code to the given phone number so that a backend can verify the user controls it (for example, in a custom, backend-driven sign-in flow). The code is tracked on its own verification; confirm it with attempt_verification.

post/phone_numbers/{phone_number_id}/prepare_verification

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/phone_numbers/{phone_number_id}/prepare_verification
  • Auth: HTTP bearer

Path parameters

phone_number_idstring required

The ID of the phone number to send the verification code to

Response

The verification. After prepare_verification it is pending (unverified); after attempt_verification its status reflects the attempt outcome.

objectstring

The type of the verification object.

idstring

The ID of the verification. Pass this to attempt_verification.

statusstring

The status of the verification (unverified, verified, expired, or failed).

strategystring

The verification strategy (email_code or phone_code).

attemptsinteger nullable

The number of attempts made against this verification.

expire_atinteger nullable

Unix timestamp (milliseconds) at which the code expires.

channelstring nullable

The channel the code was sent over (phone numbers only).

Changes