Docs › API reference
API reference
The ScreenlyyID API is organised around REST. It has predictable, resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication and verbs.
Base URL#
https://api.screenlyyid.comAuthentication#
Every request needs your API key in the x-api-key header. Most endpoints also need the x-correlation-id header from the Instance API. See Authentication.
Endpoint groups#
Identity verificationDocument authentication, liveness and face match.
Sanctions and AMLScreen people and entities against PEP, sanctions and watchlists.
Electronic identity verification1x1 and 2x2 data source matches.
Address verificationVerify and standardise addresses worldwide.
Phone verificationValidate numbers and look up live network status.
Email verificationReal-time SMTP-based email checks.
Device verificationIP probe, blocklist, host reputation and user agent.
BIN lookupCard BIN details in real time.
Code samples#
Each endpoint shows cURL, JavaScript, Python and C# samples. More examples live in the ScreenlyyID GitHub organisation.