Get a Token - Onboarding

Onboarding Token

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.

POST {API_URL}/flow/onboarding/auth/business
{
  "business_hash": "",
  "api_key": "",
  "callback": "",
  "callback_with_document_capture": false,
  "customer_data": {},
  "advanced_verification": false,
  "methods": []
}

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

Content-Type: application/json

Here's the description of the json input document:

Parameter
Mandatory
Type / default
Note

business_hash*

yes

string

This is a string provided by your contact @ShareID

api_key*

yes

string

This is a string provided by your contact @ShareID

customer_data

yes

object / {}

This data is for your own usage. You can set here any data related to your users or your CRM for example.

methods

no

array of string

Your business may use doc and/or face methods to onboard a user.

callback

no

url / null

callback_with_document_capture

no

boolean / false

advanced_verification

no

boolean / false

By default, ShareID uses one challenge. To require more, set advanced_verification to true. Note that this will also extend the onboarding and analysis time.

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

Example

POST {API_URL}/flow/onboarding/auth_business
{
  "business_hash": "2915ac99",
  "api_key": "fl-00ea000defabc",
  "callback": "https://mycompany.com/api/shareid_result.php",
  "callback_with_document_capture": false,
  "customer_data": {
    "internal_id": "2c2-2c8a-4a19"
  },
  "methods": ["face"]
}

Response

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

{
  "token": "...",
  "applicant_id": "ap-..."
}

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).

Last updated