Verification

Request Verification

post

Request phone number or email verification

Authorizations
X-Tenant-IDstringRequired
Body

Phone and email verification request model.

Attributes: username: Username to bind with the contact information contact: Phone number or email address to verify channel: Verification channel (SMS, WhatsApp, or email)

usernamestringRequired

Username to bind with phone number

contactstringRequired

Phone number in international format (e.g., +62xxxxxxxxxx or 62xxxxxxxxxx) or email address

channelstring · enumRequired

Verification channel

Possible values:
Responses
post
/users/verification/request-verification

Verify And Bind

post

Verify OTP code and bind phone or email to user

Authorizations
X-Tenant-IDstringRequired
Path parameters
challenge_idstringRequired

Challenge ID

Body

Phone and email verification code verification model.

Attributes: code: One-time password code to verify

codestringRequired

OTP code to verify

Responses
post
/users/verification/{challenge_id}/verify-and-bind

No content

Cancel Verification

post

Cancel verification challenge

Authorizations
X-Tenant-IDstringRequired
Path parameters
challenge_idstringRequired

Challenge ID

Responses
post
/users/verification/{challenge_id}/cancel

No content

Resend Verification

post

Resend verification code

Authorizations
X-Tenant-IDstringRequired
Path parameters
challenge_idstringRequired

Challenge ID

Body

Phone and email verification resend model.

Attributes: channel: Channel to resend verification (SMS, WhatsApp, or email)

channelstring · enumRequired

Channel to resend verification

Possible values:
Responses
chevron-right
200

Successful Response

application/json
post
/users/verification/{challenge_id}/resend

Unbind Contact

post

Unbind phone number or email from user

Authorizations
X-Tenant-IDstringRequired
Body

Phone and email verification unbind model.

Attributes: username: Username to unbind from the contact information

usernamestringRequired

Username to unbind from phone number

Responses
post
/users/verification/unbind

No content

Get Username By Phone Number

get

Get username by phone number (international format; optional “+” prefix).

Authorizations
X-Tenant-IDstringRequired
Path parameters
phone_numberstringRequired

Phone number to search for (e.g., +62812345678 or 62812345678)

Responses
chevron-right
200

Successful Response

application/json
get
/users/verification/username/{phone_number}

Last updated