Phone numbers

Search…

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
1
{
2
    "id": "idn_1o4qfak5AdI2qlXSXENGL05iei6",
3
    "object": "phone_number",
4
    "email_address": "+12015555555",
5
    "verification": {
6
        "status": "verified",
7
        "strategy": "phone_code"
8
    },
9
    "linked_to": []
10
}
Copied!
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