Get a Token - Onboarding

To start the SDK, whatever is the platform, you will need a token.

It will be delivered by the ShareID API service and will be available for one and only one onboarding process.

You'll note that ShareID API is always waiting for your parameters as JSON using the http header:

Content-Type: application/json

Warning

Your credentials are your responsibility. You must never enter them in hard copy in your application.

How to use the security levels

The main difference between levels is the security analysis used by our engine. The onbording level may also requires different assets (photo/video) and/or challenges.

Levels and Mode

3 levels are available: - Basic - Substantial - Advanced

By default the "normal" mode is used. But for some combination we propose a "plus" mode which enriches the onboarding process to increase the security.

FaceIDV

	Basic	Substantial	Advanced
What is used by the onboarding	photo	video	video

DocIDV

	Basic	Basic+	Substantial	Advanced	Advanced+
What is used by the onboarding	photo	photo+antispoof	video	video/ NFC (with fallback)	NFC (no fallback)

Some onboarding examples

Here are some examples with the minimum parameters to achieve the onboarding

A basic FaceIDV

{
  "credentials": {
    "business_hash": "***",
    "api_key": "***"
  },
  "levels": {
    "face_idv": {
      "idv_level": "basic"
    }
  }
}

A Full substantial IDV with callback

{
  "credentials": {
    "business_hash": "***",
    "api_key": "***"
  },
  "levels": {
    "face_idv": {
      "idv_level": "substantial"
    },
    "doc_idv": {
      "idv_level": "substantial"
    }
  },
  "options": {
    "callback": {
      "urls": ["https://happycustomer.ai/shareidcallback/hook"]
    }
  }
}

An NFC based onboarding

using plus mode will force NFC to be used

{
  "credentials": {
    "business_hash": "***",
    "api_key": "***"
  },
  "levels": {
    "doc_idv": {
      "idv_level": "advanced",
      "idv_level_mode": "plus"
    }
  }
}

Response

In response, you'll also get a json document:

{
  "token": "...",
  "applicant_id": "ap-...",
  "flow-id": "f-..."
}

The applicant_id uniquely identifies the user in our system. You should keep track of this value in order to fetch the result later. If you're using a callback, the applicant_id will also be send to your server (check here result on the callback).

The flow-id is a unique identifier for the onboarding. It's not mandatory to keep track of it but it's a reference often used at ShareID.