Get Started with SubscriberCheck on iOS

This guide walks you through what is required on your iOS app in order to perform a SubscriberCheck using the IDlayr iOS SDK. It covers:

1. Before You Begin

To fully understand the functionality required to create a SubscriberCheck in this guide, you will need to carry out some initial steps, such as creating an account, a project, and retrieving your workspace credentials. You'll also need to have an understanding of the workflow for a SubscriberCheck to be successfully carried out.

The first step is to Setup Your Environment. This page walks you through what parts are required, such as installing the IDlayr CLI, creating a project, and if needed, running the demo development server.

The second step is to gain more of an understanding of how the SubscriberCheck works. The Integration Guide provides a step by step guide on the workflow of a SubscriberCheck, and which devices need to act at what points of the workflow.

2. Install IDlayr iOS SDK

The IDlayr iOS SDK requires a minimum iOS version 13+.

Note: Consult with Apple documentation on the required iOS SDK and Xcode versions that should be used for application development.

The IDlayr iOS SDK is distributed privately. To get access:

Contact us at [email protected]
We will qualify your use case and issue an entitlement token
You will receive setup instructions along with your entitlement token

By using the SDK, you agree to the SDK Licence Terms.

3. How to implement into my app?

Importing and Initializing the SDK

Before proceeding, be sure to sync your project for these new dependencies to be installed.

Import IDlayr SDK

import IDlayrKit

Define an instance of the IDlayr SDK:

let sdk: IDlayrSDK = IDlayrSDK()

Reachability

The Reachability API is a feature that enables applications to check whether the SIM card within a user's device is on a network that IDlayr has connectivity to.

The IDlayr iOS SDK has functionality built in to call the reachability API, to call this you would need to run the following code:

sdk.openWithDataCellularAndAccessToken(url: reachabilityURL, accessToken: token, debug: false) { result in
  ...
}

If the mobile network operator is supported by IDlayr then a JSON object is returned similar to the example below:

{
  "network_id": "23410",
  "network_name": "O2 UK",
  "country_code": "GB",
  "products": [
    {
      "product_id": "SCK",
      "product_name": "SubscriberCheck"
    }
  ]
}

However, if it isn't supported, then an error is returned in JSON format.

Call your backend server to create SubscriberCheck

As described in the Integration guide step 1 is to create a SubscriberCheck. This is a step where your mobile application needs to call your backend server with the mobile devices telephone number. Your backend server then makes a POST request to IDlayr's SubscriberCheck API. If successful, the SubscriberCheck API will return a response with the check_id and a unique check_url. Your backend server needs to return this check_url to the mobile device.

Open Check URL to process SubscriberCheck

Step 2 of the integration guide is to process the SubscriberCheck. This is a step where the mobile application makes a GET request to the check_url provided in the previous step. The mobile device application then needs to follow all redirects, then on the last redirect, the JSON response will contain a code. This code will be used next.

sdk.openWithDataCellular(url: checkURL, debug: false) { result in
  ...
}

Call Backend server to complete SubscriberCheck

Step 3 of the integration guide is to complete the SubscriberCheck. This is a step where the mobile application makes a POST request to your backend server with the check_id and the code. Your backend server then makes a PATCH request to /subscriber_check/v0.2/checks/{check_id} with the JSON body below to complete the SubscriberCheck process:

[
  {
    "op": "add",
    "path": "/code",
    "value": "{check_code}"
  }
]

info

Within the response of this PATCH request, there will be a field no_sim_change, this is the field used to show if the SIM card has been changed recently, which could be an indication whether the owner of the SIM card may be a victim of SIM swap fraud. If the value is true, then proceed with the SubscriberCheck.

Finally, your backend server would need to return a success or failure response to your mobile application to allow the user of this application to proceed.

4. Perform a SubscriberCheck

Enter your phone number including the country code and click "Verify my phone number". The application will look similar to the following:

With that, you've completed your first IDlayr SubscriberCheck from an iOS application.