Integration guides
One self-contained guide per product. Each has the same sections (summary, when to use it, before you start, steps, request and response, decision logic, errors, code, test, a "Done when" checklist), so a coding agent can read one page and finish the integration. Every guide is also served as Markdown: add .md to its URL.
I want to…#
| I want to… | Guide |
|---|---|
| Verify a user's ID document and selfie in my mobile app | Identity verification (mobile) |
| Verify a user's ID document and selfie in my web app | Identity verification (web) |
| Check a card's country, type and prepaid status at checkout | BIN lookup |
| Validate phone numbers at sign-up | Phone validation |
| Catch typos and fake or disposable emails, or verify a mailbox exists | Email validation and verification |
| Check and standardise postal addresses | Address verification |
| Spot VPNs, proxies, blocklisted IPs and device type | Device and IP intelligence |
| Verify a person against data sources, without a document (1x1 or 2x2) | Electronic identity verification |
| Screen a person or company against sanctions and PEP lists | AML screening |
| Run several of these checks for one customer, with one decision | Run several checks in one session |
How every guide starts#
Every flow starts with the Instance API (POST /api/v1/instance/create), listing the product codes you need, and every later call sends your x-api-key and the returned CorrelationId as x-correlation-id. Product codes: idv, aml, eidv1, eidv2 in GlobalScreening; bin, phv, emv, adv, ipv in CustomerIntelligence. Keep the API key on your server.
Reference only#
The direct identity verification endpoints (enrolment, document, face, liveness, face match, data/{sessionId}/... and the document image endpoints) are reference only. Do not integrate them. Document and selfie identity verification always goes through the Instance API and the hosted flow in the two identity verification guides above. This applies only to those endpoints: BIN, phone, email, address, device and IP, eIDV and AML screening can each be used on their own or stacked.
Using a coding agent? Give it the AI quickstart prompt, or install the agent skill.