/yoti

Patches for https://www.drupal.org/project/yoti

Primary LanguagePHP

Yoti Drupal 7 SDK

Welcome to the Yoti Drupal 7 SDK. This repo contains the tools you need to quickly integrate your Drupal 7 back-end with Yoti, so that your users can share their identity details with your application in a secure and trusted way.

Table of Contents

  1. An Architectural view - High level overview of integration

  2. References- Guides before you start

  3. Installing the SDK- How to install our SDK

  4. Plugin Setup- How to set up the plugin in Drupal

  5. Linking existing accounts to use Yoti authentication

  6. API Coverage- Attributes defined

  7. Support- Please feel free to reach out

An Architectural view

Before you start your integration, here is a bit of background on how the integration works. To integrate your application with Yoti, your back-end must expose a GET endpoint that Yoti will use to forward tokens. The endpoint can be configured in the Yoti Dashboard when you create/update your application. For more information on how to create an application please check our developer page.

The image below shows how your application back-end and Yoti integrate into the context of a Login flow. Yoti SDK carries out for you steps 6, 7 and the profile decryption in step 8.

alt text

Yoti also allows you to enable user details verification from your mobile app by means of the Android (TBA) and iOS (TBA) SDKs. In that scenario, your Yoti-enabled mobile app is playing both the role of the browser and the Yoti app. Your back-end doesn't need to handle these cases in a significantly different way. You might just decide to handle the User-Agent header in order to provide different responses for desktop and mobile clients.

References

Installing the SDK

To import the Yoti SDK inside your project:

  1. Log on to the admin console of your Drupal website. e.g. Https://www.drupalurl.org.uk/admin
  2. Navigate to at `Modules' and Search for Yoti - you can also download the package from here.
  3. Install and enable the module.

Plugin Setup

To set things up, navigate on Drupal to the module

Here you will be asked to add the following information:

Yoti App ID

Yoti SDK ID

Yoti PEM File

Where:

  • Yoti SDK ID is the SDK identifier generated by Yoti Dashboard in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code.

  • Yoti PEM File is the application pem file. It can be downloaded only once from the Keys tab in your Yoti Dashboard.

  • Yoti App ID is unique identifier for your specific application.

Please do not open the pem file as this might corrupt the key and you will need to create a new application.

Linking existing accounts to use Yoti authentication

To allow your existing users to log in using Yoti instead of entering thier username/password combination, there is a tick box when installing the module which allows Yoti accounts to link to email addresses.

API Coverage

  • Activity Details
    • User ID user_id
    • Profile
      • Photo selfie
      • Given Names given_names
      • Family Name family_name
      • Mobile Number phone_number
      • Email address email_address
      • Date of Birth date_of_birth
      • Address postal_address
      • Gender gender
      • Nationality nationality

Support

For any questions or support please email sdksupport@yoti.com. Please provide the following the get you up and working as quick as possible:

  • Computer Type
  • OS Version
  • Screenshot