Documentation
1.
Introduction
2.
API Reference
3.
Environments
API Conventions
4.
OAuth 2.0
❱
4.1.
Intro to OAuth 2.0
4.2.
Required Parameters
5.
OpenID Connect (OIDC)
❱
5.1.
About OIDC
5.2.
OIDC Code Flows
6.
Authorization Grant
❱
6.1.
About Grant Types
6.2.
Implicit
6.3.
Authorization Code
6.4.
Client Credentials
7.
Endpoint Information
❱
7.1.
Authorization Endpoint
7.2.
Token Endpoint
7.3.
Userinfo Endpoint
7.4.
Logout Endpoint
8.
About Tokens
❱
8.1.
Scopes
8.2.
ID Token
8.3.
Access Token
8.4.
Refresh Token
9.
Requests and Responses
❱
9.1.
Request Information
9.2.
Error Codes
9.3.
Error Handling
UI Widgets
10.
Registration Widget
❱
10.1.
Invoke Registration Widget
11.
Identity Verification JS SDK
❱
11.1.
Using the Identity Verification JS SDK
11.2.
Making Calls
11.3.
Verification Request
11.4.
Config Members
11.5.
Profile Members
11.6.
Verification Response
11.7.
Verification Events
11.8.
onVerifyCancel
11.9.
onVerifyComplete
11.10.
onVerifyDone
11.11.
onVerifyError
11.12.
Verification Webhooks
11.13.
Polling
11.14.
Verification Widget Working Example
12.
Login JS SDK
❱
12.1.
Using the JS Login SDK
12.2.
Getting Started
12.3.
Login
12.4.
Login Response
12.5.
Login Events
12.6.
onLogin
12.7.
onLoginError
13.
Age Gate JS (Typescript) SDK
❱
13.1.
Initialize SDK
13.2.
Check Status
13.3.
Run
13.4.
onStatusChange (Response callback)
13.5.
Age Recheck
13.6.
Show Identifier
13.7.
Hide
13.8.
Age Gate Status Description
13.9.
Age Gate Flow Diagrams
14.
Age Verification JS (Typescript) SDK
❱
14.1.
Initialize SDK
14.2.
Check Status
14.3.
Run
14.4.
Hide
14.5.
Age Verification Status Description
15.
Account Management
❱
15.1.
Account Settings
Attributes & Features
16.
Attributes & Features
17.
Data Attributes
❱
17.1.
Standard Attributes
17.2.
Custom Attributes
18.
Feature Types
❱
18.1.
Standard Features
18.2.
Optional Features
REST APIs
19.
REST APIs
20.
Account APIs
❱
20.1.
Registration Role Context
20.2.
Register Account
20.3.
Add Child To Adult Account
20.4.
Register Shadow Account
21.
Consent APIs
❱
21.1.
List Consent Requests
21.2.
Child Requests Feature
21.3.
Resend Consent Request
21.4.
Grant Feature Consent
21.5.
Revoke Feature Consent
Mobile SDKs
22.
Mobile Swift SDK (iOS, tvOS, watchOS, macOS)
❱
22.1.
Requirements
22.2.
Installation
22.3.
Usage
22.4.
Auth Module
22.5.
Age Gate Module
22.6.
Age Verification Module
22.7.
Identity Verification Module
23.
Mobile Kotlin SDK (Android)
❱
23.1.
Requirements
23.2.
Installation
23.3.
Usage
23.4.
Auth Module
23.5.
Age Gate Module
23.6.
Age Verification Module
23.7.
Identity Verification Module
Reference
24.
Using Callbacks / Webhooks
25.
Webhook Events & Outcomes
26.
Partner Site Navigation
Light (default)
Dark
Navy
Developer Portal
onVerifyCancel
The user has canceled the verification process and the widget has closed.