Verify

This endpoint handles the customer's access code verification. It sends the entered access code to the backend and waits for the response. In the case of receiving a positive response, it helps by directing the customer to the store's home page. Otherwise, if the verification process fails, it informs the customer to re-send the correct access code.

TIP

The verify endpoint has been implemented in the Login Web Component, and It's all setup to save developer's time and effort.

Payload

VerifyByMobilePayload

Response

Success

Error

auth.verify.success

Usage

The verify() passes the customer access code to the backend in order to proceed with the verification process. In the case of using the phone number method to receive the access code, this method will pass the received access code along with the customer's phone number and the country code.

Mobile

Events

This endpoint may trigger two events, the onVerified and onVerificationFailed events.

onVerified

This event is triggered when the verification process is done without having any errors back from the backend.

onVerificationFailed

This event may happen when there is an issue with setting the verification type, by phone or email. Additionally, this event will be triggered when the verification process fails and the backend sends error codes. In other words, the received response status is not 200.

Payload#

Response#

Usage#

Events#

onVerified#

onVerificationFailed#

Payload

Response

Usage

Events

onVerified

onVerificationFailed