How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Clerk Phone Numbers API

A user can be associated with one or more phone numbers, which allows them to be contacted via SMS.

Clerk Phone Numbers API is one of 104 APIs that Clerk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Phone Numbers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 11 operations across 6 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.clerk.com/v1, https://{domain}.clerk.accounts.dev.

11 operations 6 paths 49 schemas 2 DELETE3 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.clerk.com/v1
Authentication
HTTP Bearer, API Key, API Key, HTTP Bearer, API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 6

Clerk Phone Numbers API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (sk__) (bearerAuth). An API key is passed in the cookie as __client (ProductionBrowser). An API key is passed in the query as __dev_session (DevBrowser). It accepts HTTP bearer tokens (ProductionNativeApp). An API key is passed in the query as _is_native (ProductionNativeFlag). It accepts HTTP basic authentication (ClientCredentials).

  • bearerAuth — Secret key, obtained under "API Keys" in the Clerk Dashboard.
  • ProductionBrowser — The Client API token sent in the form of a browser cookie. Used to authenticate production browser applications.
  • DevBrowser — A Dev Browser API token sent as a query parameter. Used to authenticate only dev instances. To generate a dev instance API token you must first make a request…
  • ProductionNativeApp — The Client API token sent in the Authorization header. Used to authenticate native applications.
  • ProductionNativeFlag — If sent and the value is true, it instructs the server to parse the API token from the Authorization header. It should always be set to true when using the Aut…
  • ClientCredentials — HTTP Basic Authentication using Client ID as username and Client Secret as password.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 3 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Phone Numbers 11

A user can be associated with one or more phone numbers, which allows them to be contacted via SMS.

POST
/phone_numbers
Create a Phone Number
CreatePhoneNumber body → 200400401403404422
GET
/phone_numbers/{phone_number_id}
Retrieve a Phone Number
GetPhoneNumber 1 param → 200400401403404
DELETE
/phone_numbers/{phone_number_id}
Delete a Phone Number
DeletePhoneNumber 1 param → 200400401403404
PATCH
/phone_numbers/{phone_number_id}
Update a Phone Number
UpdatePhoneNumber 1 param body → 200400401403404
GET
/v1/me/phone_numbers
Get Phone Numbers
getPhoneNumbers 1 param → 200401403404
POST
/v1/me/phone_numbers
Create Phone Number
postPhoneNumbers 1 param body → 200400401403404422
POST
/v1/me/phone_numbers/{phone_number_id}/attempt_verification
Attempt Phone Number Verification
verifyPhoneNumber 2 params body → 200400401403404422429
POST
/v1/me/phone_numbers/{phone_number_id}/prepare_verification
Prepare Phone Number Verification
sendVerificationSMS 2 params body → 200400401403404429
GET
/v1/me/phone_numbers/{phone_number_id}
Retrieve Phone Number
ReadPhoneNumber 2 params → 200401403404
PATCH
/v1/me/phone_numbers/{phone_number_id}
Update Phone Number
UpdatePhoneNumber 2 params body → 200400401403404
DELETE
/v1/me/phone_numbers/{phone_number_id}
Delete Phone Number
DeletePhoneNumber 2 params → 200400401403404

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are Client.User (42 properties), Client.SignUp (23 properties), ExternalAccountWithVerification (19 properties), Client.Organization (14 properties). Each schema is shown below with its type and property counts.

DeletedObject
object
5 properties 2 required
ClerkError
object
4 properties 3 required
ClerkErrors
object
3 properties 1 required
PhoneNumber
object
11 properties 7 required
verification_otp
object
6 properties 4 required
verification_admin
object
6 properties 4 required
IdentificationLink
object
2 properties 2 required
Stubs.Verification.SAML
object
7 properties 2 required
Stubs.Verification.Link
object
6 properties 3 required
Client.Passkey
object
7 properties 4 required
Stubs.SignInFactor
object
11 properties 1 required
Stubs.Verification.BackupCode
object
5 properties 2 required
Stubs.Verification.FromOauth
object
5 properties 2 required
Token
object
2 properties 2 required
Stubs.Verification.Admin
object
5 properties 2 required
Client.EmailAddress
object
9 properties 8 required
ExternalAccountWithVerification
object
19 properties 13 required
Client.OrganizationMembership
object
10 properties 9 required
Client.PublicUserData
object
9 properties 4 required
verification_oauth
object
8 properties 4 required
Stubs.Verification.Ticket
object
5 properties 2 required
schemas-Client.Session
Stubs.Verification.Passkey
object
6 properties 3 required
Stubs.Verification.Web3Signature
object
7 properties 2 required
Client.SessionTask
object
1 property 1 required
schemas-Client.Client
objectnull
11 properties 11 required
Client.User
object
42 properties 35 required
Server.UserPhoneNumbers
array
Stubs.Verification.Oauth
object
7 properties 3 required
Client.Organization
object
14 properties 10 required
Client.ClientWrappedDeletedObject
object
2 properties 2 required
Stubs.SAMLConnection.SAMLAccount
object
13 properties 7 required
Client.SignUp
object
23 properties 21 required
Client.Web3Wallet
object
6 properties 6 required
schemas-Client.SignIn
object
13 properties 12 required
schemas-Client.SessionBase
object
9 properties 6 required
Client.PhoneNumber
object
11 properties 8 required
Client.SignUp.Verifications
object
4 properties 4 required
Client.DeletedObject
object
4 properties 2 required
Stubs.Identification.Link
object
2 properties 2 required
Stubs.Verification.Invitation
object
5 properties 2 required
verification_google_one_tap
object
7 properties 4 required
Stubs.Verification.TOTP
object
5 properties 2 required
Stubs.Verification.OTP
object
5 properties 3 required
Client.ClientWrappedPhoneNumber
object
2 properties 2 required
Stubs.Verification.GoogleOneTap
object
5 properties 2 required
Stubs.SignUpVerification.AdditionalFields
object
2 properties 2 required
Stubs.Verification.Password
object
5 properties 2 required
Client.SAMLAccount
object
13 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clerk-com-phone-numbers-api-openapi.yml Raw ↑

Other APIs Clerk publishes across the network.

Clerk Account Portal API
Clerk Active Sessions API
Clerk Actor Tokens API
Clerk Agent Tasks API
Clerk Allow-list / Block-list API
Clerk API Keys API
Clerk Application Transfers API
Clerk Applications API
Clerk Backup Codes API
Clerk Beta Features API
Clerk Billing API
Clerk Checkouts API
Where this information came from

This is an independent, third-party profile of Clerk Phone Numbers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.