Skip to main content

Service Configuration - API Keys tab

API keys for extracting Identities​

From your Services List, click a service's name, then select the API Keys tab.

On this tab you can create and modify API keys to extract and archive candidate information.

Configure API access​

Create an API key​

  1. Go to the API Keys tab and click the Create API key button.
  2. Add a short description
  3. Choose the scope
    • Return only metadata:
      only return status and ID of the users
    • Return Metadata and identity attributes except pictures:
      If you wish to include text-only Identity attributes in the API responses.
      You can auto archive the profile in the dashboard once API returned the data (see below) Leave the checkbox unselected if you want to retain candidates' personal info in the dashboard.
    • Return metadata and identity attributes including pictures:
      If you wish to include all Identity attributes in the API responses including images of document, selfie, proof of address.
      You can auto archive the profile in the dashboard once API returned the data (see below) Leave the checkbox unselected if you want to retain candidates' personal info in the dashboard.
  4. Click CREATE KEY
  5. Copy the API key and store it somewhere safe
caution

The API key is displayed only upon creation, dont forget to copy it before closing the popup

Adjust an existing API key​

Click on a highlighted row to edit the settings for a key:

  • Edit description
  • Exclude or include Identity attribute data
  • Set a delay after API extract to automatically archive the candidate
  • Enable or disable the API key

Click Update after making any needed changes, or close the dialog to leave settings unchanged.

Archived candidate Identities​

When a candidate is archived in the KYC Connect Dashboard all raw KYC personal info (i.e. Identity attributes) will be deleted. Only metadata (e.g. status, history) and any Identity certificates provided will remain.

If the Identity attribute data has been extracted using the API, candidate Identities can be automatically archived.

Extract and Archive. Best practice.​

Personal KYC data should not sit in your KYC Connect database forever. Using the API with the archive option will allow you to securely meet your data retention requirements.

After creating an API key, you can use the Dashboard API to extract individuals personal info and store it in a secure environment.

tip

If you wish to use AES encryption as an additional security layer on the extracted data, contact Blockpass directly for more information about the protocols and keys you will require.