Usage
Create a OneID transaction with provider: oneID and method: auth. Three things shape what the user sees and what comes back: the product, the verification method or methods on offer, and the scopes you request.
Product
Choose the product that matches the assurance level you need:
- ID Check — basic identity verification.
- ID Proof — fuller identity verification, suited to higher-assurance onboarding.
- ID Assure — OneID's highest-assurance product, combining identity verification with fraud and watchlist checks.
The product you choose also determines which scopes you can request:
| Scope | Returns | ID Check | ID Proof | ID Assure |
|---|---|---|---|---|
openid | ID token | Yes | Yes | Yes |
profile | The user's name | Yes | Yes | Yes |
address | The user's address | – | Yes | Yes |
date_of_birth | The user's date of birth | – | Yes | Yes |
fraud | UK fraud check results | – | – | Yes |
idscan | Attributes of any document the user scanned | Available wherever document scan is used, regardless of product | ||
Verification methods
Set one or both verification methods on the request:
- Open banking — the document-free route. The user logs in via their UK bank's online or mobile banking and consents to share their verified identity data.
- Document scan (ID Scan) — the user scans an identity document instead. ID Scan supports documents from a wide range of countries; for UK and Irish citizens specifically it covers British and Irish passports and the Irish Passport Card.
If you offer both, the user picks one on OneID's provider selection screen.
Scopes
Request only the data you need. Available scopes cover the base OpenID claim, profile, address, date of birth, fraud signals and ID Scan results. See the API reference for the full list.
Fraud and watchlist signals
With the fraud scope, completion data can include anti-fraud signals alongside the identity data: activity history and identity fraud scores, a national SIRA fraud or victim marker, an Amberhill match, and a death register match. These come back as flags and scores for you to act on, not as a pass/fail verdict.
ID Scan results
When document scan is used, completion data includes the scan's overall assessment, a link to a verification PDF, and details of the document and checks performed (face match and liveness, where applicable).
Verified claims
OneID also returns its identity data wrapped in the OpenID Identity Assurance format: a verification block (trust framework, assurance level, evidence) alongside the claims themselves. Use this if you need a standards-based audit trail rather than just the flattened fields.
Errors
Alongside the standard error and description, OneID errors include a OneID-specific error code. See OneID's error code reference for what each one means.