Skip to content

Send a 6-digit code to a contact method so its owner can prove it reaches them.

POST
/user/{user_id}/contact_method/{contact_method_id}/verification
curl --request POST \
--url https://api.siteqwality.com/user/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contact_method/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/verification \
--header 'Authorization: Bearer <token>'
user_id
required
string format: uuid

User identifier

contact_method_id
required
string format: uuid

Contact method identifier

Code sent

Media type application/json

A verification code is on its way.

object
expires_in_seconds
required
integer format: int32
resend_after_seconds
required
integer format: int32
code_length
required
integer format: int32
Example generated
{
"expires_in_seconds": 1,
"resend_after_seconds": 1,
"code_length": 1
}

This type of contact method cannot be verified

Missing or invalid authentication

Only the user or an admin may change a user’s contact methods

Contact method not found

Already verified (contact_method_already_verified), or no SMS left this period (sms_quota_exhausted)

Sent less than a minute ago, or the daily limit is reached (rate_limited)

Internal server error

The code could not be sent