Generate API keys

Yoti provides you with an on-boarding tool to get you up and running with Yoti services.

This is where you will obtain your API keys, add your billing information and more.

You will learn to how to:

1. Create an application
2. Create your scenario
3. Collect keys
4. Activate your application

1. Create a Yoti application

To create your application, click the applications tab in the side menu.

Here you can choose which product you would like to integrate with:

Creating an application

After pressing Proceed, fill in the Details tab - including your application name and logo, then click Create.

Yoti App application creation example

Example of Yoti App application creation

Yoti Doc Scan & Yoti Age Scan application creation example

Example of Yoti Doc Scan or Yoti Age Scan application details

2. Create your scenario

Scenarios tab

You will then need to fill out your scenarios. Scenarios allow you to define different sets of attributes to request from your users, while still using one application.

Creating a scenario

Give your scenario a useful name, describing your use case and click Proceed. You will then be asked to select which attributes (personal details) you want to receive from your users.

3. Collect Keys

The next stage is to collect various IDs and the key pair for your application.

Yoti Client SDK ID:- You will need this on your backend to initialise the SDK and it is passed in each call to our servers.

Scenario ID:- This is used to associate the button generator with the appropriate scenario that you wish to use. *only applicable to Yoti app integration.

Generating keys and PEM file Yoti Doc Scan or Yoti Age Scan

You need to download a PEM file containing your private key in order for your app to connect with Yoti.

• Click the Generate key pair button in the Keys tab to download.

• Please keep this safe as this PEM file is essential to a Yoti integration.

If you lose or corrupt your PEM file you will be able to generate a new one. Regenerating your key pair will break your current application by invalidating your current PEM file and generated keys. This means you will be unable to decrypt new tokens until these are replaced by the newly generated ones.

4. Activate your application

Once you have completed the above steps, you will be able to activate your Yoti application by clicking the Activate button in the top right.

Activating your application

Continue integration

Once you've onboarded your organisation in Yoti Hub and have generated your API keys, you can continue with integrating your chosen Yoti products or services: