MOCheck Integration Guide

The IDlayr MOCheck API verifies a user as the owner of their mobile phone and number with minimal user interaction. It is ideal for when SNA is not available.

MOCheck API works by generating the OTP code for provided phone number for the purpose of mobile phone and number verification. The generated OTP then should be sent by the user to the phone number owned by IDlayr and IDlayr verifies the received OTP and the sender phone number.

This guide will walk you through a common approach to integrating MOCheck workflow into a client/server architecture to achieve a verified result.

This guide will be using four different entities. These are:

Customer's device, the mobile device of the person attempting to verify they're the owner of that phone number.
Your Backend Server is the server the customer's device communicates with for the application to run.
IDlayr API is the API your integration needs to communicate with for the MOCheck to succeed.
Mobile Network Operator (MNO) is the mobile provider that receives the MO SMS for IDlayr.

MOCheck Workflow Integration

The MOCheck workflow consists of 2 sections.

Create the MOCheck - Initializing the MOCheck process.
Process the MOCheck - Sending the MO SMS from the customer device and verifying the response.

1) Create a MOCheck

Creating a MOCheck workflow is as follows:

Customer’s device application sends phone number to Backend Server.
Backend server sends a POST request to IDlayr MOCheck API.
IDlayr MOCheck API returns a response with the check_id, mo_receiver indicating where to send the MO SMS, and a mo_body with the OTP, to be used as MO SMS body.
Backend server returns the mo_receiver and mo_body to the application on the customer’s device.

sequenceDiagram participant Device participant Server as Your Backend Server participant API as IDlayr participant MNO as Mobile Network Operator note over Device, MNO: Create the MOCheck. activate Device Device->>Server: Send phone number activate Server rect rgb(232, 231, 231) Server->>API: POST /checks note left of Server: Create MOCheck note right of API: Create MOCheck<br/>"ACCEPTED" API-->>Server: MOCheck with OTP and destination number end Server-->>Device: Return MOCheck OTP<br /> and destination number to Device deactivate Server deactivate Device

Device sends Phone Number to your Backend Server

Backend Server creates a MOCheck with IDlayr's API

Backend Server returns the MO SMS body and destination number to the Device

2) Process the MOCheck

Processing a MOCheck workflow is as follows:

Customer Device with Customer consent sends the MO SMS with mo_body to the mo_receiver phone number
IDlayr receives webhook response from MNO with MO SMS data and performs verification. MOCheck is now complete.
If callback_url is configured or provided in the MOCheck API request, IDlayr sends a callback with verification result(true/false) to the Backend Server
Alternatively, Backend Server can get verification result by making GET request to IDlayr with check_id

sequenceDiagram participant Device participant Server as Your Backend Server participant API as IDlayr participant MNO as Mobile Network Operator note over Device, MNO: Process the MOCheck. activate Device Device->>MNO: Send mo_body to mo_receiver phone number MNO->>API: Forward received MO SMS API->>API: Verification of received MO SMS data alt Is callback_url provided/configured API->>Server: Send callback with<br /> result of MOCheck verification from API else Server->>API: GET MOCheck /checks/{id} API->>Server: Return MOCheck verification result from API end Server->>Device: Verification complete, continue <br /> user's journey or display error deactivate Device

Device sends the MO SMS

Get result of IDlayr MOCheck API verification

Get Started with development

There are multiple SDKs created by IDlayr to help developers integrate the APIs into their mobile application and backend server with minimal effort.