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.
Identity Verification: Direct URL Integration
13.
Login JS SDK
❱
13.1.
Using the JS Login SDK
13.2.
Getting Started
13.3.
Login
13.4.
Login Response
13.5.
Login Events
13.6.
onLogin
13.7.
onLoginError
14.
Age Gate JS (Typescript) SDK
❱
14.1.
Initialize SDK
14.2.
Check Status
14.3.
Run
14.4.
onStatusChange (Response callback)
14.5.
Age Recheck
14.6.
Show Identifier
14.7.
Hide
14.8.
Age Gate Status Description
14.9.
Age Gate Flow Diagrams
15.
Age Verification JS (Typescript) SDK
❱
15.1.
Initialize SDK
15.2.
Check Status
15.3.
Run
15.4.
Hide
15.5.
Age Verification Status Description
16.
Age Estimation JS (Typescript) SDK
❱
16.1.
Initialize SDK
16.2.
Run
16.3.
onStatusChange (Response callback)
16.4.
Token Decoding and Validation
17.
Account Management
❱
17.1.
Account Settings
Attributes & Features
18.
Attributes & Features
19.
Data Attributes
❱
19.1.
Standard Attributes
19.2.
Custom Attributes
20.
Feature Types
❱
20.1.
Standard Features
20.2.
Optional Features
REST APIs
21.
REST APIs
22.
Account APIs
❱
22.1.
Registration Role Context
22.2.
Register Account
22.3.
Add Child To Adult Account
22.4.
Register Shadow Account
23.
Consent APIs
❱
23.1.
List Consent Requests
23.2.
Child Requests Feature
23.3.
Resend Consent Request
23.4.
Grant Feature Consent
23.5.
Revoke Feature Consent
Mobile SDKs
24.
Mobile Swift SDK (iOS, tvOS, watchOS, macOS)
❱
24.1.
Requirements
24.2.
Installation
24.3.
Usage
24.4.
Auth Module
24.5.
Age Gate Module
❱
24.5.1.
Flow Diagrams
24.5.2.
class PrivoAgeGate
24.5.3.
struct AgeGateEvent
24.5.4.
struct CheckAgeData
24.5.5.
enum PrivoError
24.6.
Age Verification Module
24.7.
Identity Verification Module
25.
Mobile Kotlin SDK (Android)
❱
25.1.
Requirements
25.2.
Installation
25.3.
Usage
25.4.
Auth Module
25.5.
Age Gate Module
25.6.
Age Verification Module
25.7.
Identity Verification Module
Reference
26.
Using Callbacks / Webhooks
27.
Webhook Events & Outcomes
28.
Partner Site Navigation
Light (default)
Dark
Navy
Developer Portal
Age Gate Flow Diagrams
Simple Age Gate Flow Diagram
Age Gate Flow Diagram (with Age Recheck)
