Getting Started with Veriff

Welcome to Veriff!

Here are the introductions for the Developer's Documentation that will help you to integrate Veriff into your application. To read the full Developer's Documentation and get a more detailed look into how to integrate Veriff, head over to developers.veriff.me.

1

Create an account on Veriff

Sign up here.

2

Receive an email

You will be receiving an email that contains a log in link.

3

Follow the link to Veriff's back office and authenticate using Google Authenticator.

Download Google Authentication app from app store (iOS or Android). Scan the QR-code using the Google Authenticator.

4

Log in to Veriff's back office (go to back office)

Use the 6-digit code from Google Authenticator to finalize your account.

Get 'API_KEY' (Management -> Vendor -> General -> API Key) from Veriff's back office.

5

Integrate Veriff Javascript SDK into your front-end application

Install using npm:

$ npm install --save @veriff/js-sdk

import Veriff from '@veriff/js-sdk';

or download from CDN:

<script src="https://cdn.veriff.me/sdk/js/veriff.min.js"></script>

<link rel="stylesheet" href="https://cdn.veriff.me/sdk/js/styles.css"/>

Finally, integrate:

<div id="veriff-root"></div>

const veriff = Veriff({
  env: 'production',
  apiKey: '24748e88-a299-42c9-a2f2-2d44807e7e88',
  parentId: 'veriff-root',
  onSession: function(err, response) {
    // Access verification ID through 'response.verification.id'
    location.replace(response.verification.url);
  }
});
veriff.mount();
6

Integrate Veriff Javascript SDK into your back-end application

Go to Veriff's back office and set 'Notification url' webhook endpoint (Management -> Vendors -> Edit) to which Veriff will post decision notifications of verification results. NB! Only https will be allowed.

On your side, open an endpoint and set it to the same 'Notification url'. Once the verification for a user has been completed, a POST request webhook with application/json media type will be heading to your way.

Show JSON response
{
  "status": "success",
  "verification": {
    "id": "f04bdb47-d3be-4b28-b028-a652feb060b5",
    "status": "approved",
    "code": 9001,
    "reason": null,
    "acceptanceTime": "2017-01-18T12:22:50.239Z",
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "idNumber": null,
      "citizenship": null,
      "dateOfBirth": "1990-01-01",
      "gender": "M",
      "nationality": null
    },
    "document": {
      "number": "B01234567",
      "type": "PASSPORT",
      "country": "DE",
      "validFrom": "2015-11-11",
      "validUntil": "2021-12-09"
    },
    "comments": [],
    "additionalVerifiedData": {}
  },
  "technicalData": {
    "ip": "186.153.67.122"
  }
}

You are now ready to use Veriff's back office on office.veriff.me.

Create an account