Get a Token - Authenticate

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 authentication process.

POST {API_URL}/flow/authenticate/auth/business
{
  "business_hash": "",
  "api_key": "",
  "applicant_id": "",
  "callback": ""
}

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
applicant_id	yes	string	The applicant_id you got when opening a new onboarding.
callback	no	url / null	This url will be called with the authenticate result

Warning

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

Example

POST {API_URL}/flow/authenticate/auth/business
{
  "business_hash": "2915ac99",
  "api_key": "fl-00ea000defabc",
  "callback": "https://mycompany.com/api/shareid_result.php",
  "applicant_id": "ap-20231029101303909-dev0-24fa8d9e36"
}

Response

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

{
  "token": "...",
  "flow_id": "..."
}

The token is the one you will use for api interaction through the SDK.

The flow_id describes the unique identifier for this authenticate process. It will be useful to get the result from the API.