Verify a mobile number

post

https://api.prtmb.com/api/v2/accounts/verify-mobile-number

This is the second step for authentication with a mobile number.

Verify your mobile number with the code that was just sent to authenticate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Verify mobile number params

Verify mobile number parameters

api_keys

boolean

Defaults to false

When true user API keys are returned after successful authentication.

big_commerce_auth_link_token_id

string

The UUID of a valid BigCommerceAuthLinkToken.

When provided after completing OAuth for a BigCommerce store, a RoleMembership
will be created for the User if one does not already exist. Additionally, if
the user does not already have the email address from BigCommerce associated a new
UserEmail will be created.

This field will be ignored if shopify_auth_link_token_id is included.

mobile_number

string

required

Mobile number (preferably in E.164 format)

shopify_auth_link_token_id

string

The UUID of a valid ShopifyAuthLinkToken.

When provided after completing OAuth for a Shopify store, a RoleMembership
will be created for the User if one does not already exist.

totp_code

string

required

Time-based-One-Time-Password (TOTP) code

Responses

Callback

200Register response

400Bad Request

422Unprocessible Entity