3.0.0
Search
⌃K
Links

Phone numbers

Available requests

  • GET /v1/me/phone_numbers
  • POST /v1/me/phone_numbers
  • GET /v1/me/phone_numbers/:id
  • PATCH/v1/me/phone_numbers/:id
  • POST /v1/me/phone_numbers/:id/send_verification_sms
  • POST /v1/me/phone_numbers/:id/verify
  • DEL /v1/me/phone_numbers/:id

The phone number object

{
"id": "idn_1o4qfak5AdI2qlXSXENGL05iei6",
"object": "phone_number",
"email_address": "+12015555555",
"verification": {
"status": "verified",
"strategy": "phone_code"
},
"linked_to": []
}
get
https://clerk.example.com
/v1/me/phone_numbers
List all phone numbers
get
https://clerk.example.com
/v1/me/phone_numbers/:id
Retrieve a phone number
post
https://clerk.example.com
/v1/me/phone_numbers
Create a phone number
post
https://clerk.example.com
/v1/me/phone_numbers/:id/send_verification_sms
Send a verification SMS
post
https://clerk.example.com
/v1/me/phone_numbers/:id/verify
Verify a phone number
patch
https://clerk.example.com
/v1/me/phone_number/:id
Update a phone number
delete
https://clerk.example.com
/v1/me/phone_number/:id
Delete a phone number