Production keys
Before creating your service, you will need to ensure you are logged into Yoti Hub and inside your organisation.
You will then need to create an application to obtain your API keys. You can do this as follows:
- Head to the left hand nav bar and select services > create a service.
- Or select the blue button labelled CREATE.
- Then pick which service you are integrating, in this case - Digital ID.
Each service has a different set-up, so make sure you have selected the correct one. You can create multiple services within your organisation, where in each service refers to a domain and has its own user base.
Once you have selected a service, you can create the service by filling in the following details:
| Form | Description |
|---|---|
| Service name | This will be visible to your users on the Digital ID app. |
| Internal service name | An internal project name, not visible to your users. |
| Description | Your service description, which will be shown to users if you choose to integrate the connect QR code only. |
| Domain | The website domain your service will be used on. Invalid TLDs such as .test or .local are not supported. |
| Privacy policy | You are legally required to provide information to users on your personal information collection and use practices. This could be through your privacy policy, terms and conditions or another method. |
| Background image | Your QR code background, which will be shown to users if you choose to integrate the connect QR code only. |
| Logo | Your logo will be shown in the Digital ID app and also in the receipts generated. Max 200kB file size, PNG only. |
| Callback URL | Where your clients will be forwarded after the share is completed. |
Key Generation
The next stage is to generate SDK ID and the key pair for your service.
| Key | Description |
|---|---|
| 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. |
| PEM file | 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. |
Scenario Creation
Once the keys have been generated a scenario will need to be created, this is where you can select the attributes that the user will send. When creating a scenario, you will also need to specify a callback url that a user can be redirected to after they have used their digital id.
Activate your service
Once you have completed the above steps, you will be able to activate your Yoti service by clicking the Activate button in the top right.
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.
Deleting your application
To delete your service go Services > Arrow icon > press Delete.
There is also an option to deactivate your service which will keep an archive of your users receipts and integration as a paused state. Users will not be able use your integration until it gets activated again.