Authentication
The ScreenlyyID API uses API keys, created in the dashboard, and a session key to authenticate requests. You can view and manage your API keys in the ScreenlyyID dashboard.
Your API keys carry many privileges. Keep them secure and never share them in publicly accessible places such as GitHub or client-side code.
Pass your API key in the x-api-key header. All API requests must be made over HTTPS. Calls made over plain HTTP will fail, and so will requests without authentication.
Session keys#
As well as your x-api-key, you must pass a temporary token in the x-correlation-id header. Create the correlation ID at the start of each request flow with the Instance API.
Think of the correlation ID as a session token. Use it for one set of API calls for a single customer, until that sequence is finished.
Product codes#
When you create an instance you also supply the product codes that session can access. A product must be activated on your account for its code to work.
| Product | Code | Class |
|---|---|---|
| Identity verification | idv | Global screening |
| Sanctions, PEP and watchlist screening | aml | Global screening |
| Electronic identity verification 1x1 | eidv1 | Global screening |
| Electronic identity verification 2x2 | eidv2 | Global screening |
| Address verification | adv | Customer intelligence |
| Email validation and enrichment | emv | Customer intelligence |
| Phone validation and enrichment | phv | Customer intelligence |
| IP and device analysis | ipv | Customer intelligence |
| BIN lookup | bin | Customer intelligence |
Codes for the Global screening class go in the GlobalScreening array of the instance request. Codes for Customer intelligence go in the CustomerIntelligence array.