Authorizations
Path Parameters
Body
application/json
Authentication
Session
User Management
- GETGet Current User Profile
- PATCHUpdate User Profile
- GETGet User's Organization Memberships
- GETGet User's Workspace Memberships
- GETGet User's Email Addresses
- POSTAdd Email Address
- DELRemove Email Address
- POSTPrepare Email Verification
- POSTVerify Email Address
- POSTMake Email Primary
- GETGet User's Phone Numbers
- POSTAdd Phone Number
- DELRemove Phone Number
- POSTSend Phone Verification SMS
- POSTVerify Phone Number with OTP
- POSTSet Phone Number as Primary
- POSTGenerate New TOTP Authenticator
- POSTVerify TOTP Authenticator Setup
- DELDelete TOTP Authenticator
- POSTGenerate Backup Codes
- POSTRegenerate Backup Codes
- POSTUpload Profile Picture
- POSTUpdate Password
- DELRemove Password
- GETGet Active Sessions
- PATCHSign Out from Specific Session
- DELDisconnect Social Connection
- DELDelete User Account
Organizations
- POSTCreate Organization
- DELDelete Organization
- PATCHUpdate Organization
- DELLeave Organization
- GETGet Organization Members
- DELRemove Organization Member
- PUTAdd Member Role
- DELRemove Member Role
- GETGet Organization Invitations
- POSTInvite Member to Organization
- DELCancel Organization Invitation
- GETGet Organization Roles
- POSTCreate Organization Role
- DELDelete Organization Role
- GETGet Organization Domains
- POSTAdd Organization Domain
- POSTVerify Organization Domain
- DELDelete Organization Domain
- GETGet Organization Billing Addresses
- POSTAdd Organization Billing Address
- PUTUpdate Organization Billing Address
- DELDelete Organization Billing Address
User Management
Verify Phone Number with OTP
Verify a phone number using the OTP code sent via SMS. The code expires after 5 minutes.
POST
/
me
/
phone-numbers
/
{id}
/
attempt-verification
Verify Phone Number with OTP
Copy
curl --request POST \
--url https://{deploymentHost}/me/phone-numbers/{id}/attempt-verification \
--header 'Content-Type: application/json' \
--data '{
"code": "123456"
}'Copy
{
"status": 200,
"message": "",
"data": {
"verified": true,
"phone_number": {
"id": "phone_987654321",
"phone_number": "+1234567890",
"verified": true,
"primary": false,
"created_at": "2024-01-10T12:00:00Z",
"verified_at": "2024-01-10T12:05:00Z"
}
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}Previous
Set Phone Number as PrimarySet a verified phone number as the user's primary phone number. Only verified phone numbers can be set as primary.
Next
⌘I
Verify Phone Number with OTP
Copy
curl --request POST \
--url https://{deploymentHost}/me/phone-numbers/{id}/attempt-verification \
--header 'Content-Type: application/json' \
--data '{
"code": "123456"
}'Copy
{
"status": 200,
"message": "",
"data": {
"verified": true,
"phone_number": {
"id": "phone_987654321",
"phone_number": "+1234567890",
"verified": true,
"primary": false,
"created_at": "2024-01-10T12:00:00Z",
"verified_at": "2024-01-10T12:05:00Z"
}
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}