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.
LGS JS (Typescript) SDK
❱
17.1.
Initialize SDK
17.2.
onStatusChange (Response callback)
17.3.
Run
18.
Account Management
❱
18.1.
Account Settings
Attributes & Features
19.
Attributes & Features
20.
Data Attributes
❱
20.1.
Standard Attributes
20.2.
Custom Attributes
21.
Feature Types
❱
21.1.
Standard Features
21.2.
Optional Features
REST APIs
22.
REST APIs
23.
Account APIs
❱
23.1.
Registration Role Context
23.2.
Register Account
23.3.
Add Child To Adult Account
23.4.
Register Shadow Account
24.
Consent APIs
❱
24.1.
List Consent Requests
24.2.
Child Requests Feature
24.3.
Resend Consent Request
24.4.
Grant Feature Consent
24.5.
Revoke Feature Consent
Mobile SDKs
25.
Mobile Swift SDK (iOS, tvOS, watchOS, macOS)
❱
25.1.
Requirements
25.2.
Installation
25.3.
Usage
25.4.
Auth Module
25.5.
Age Gate Module
❱
25.5.1.
Flow Diagrams
25.5.2.
class PrivoAgeGate
25.5.3.
struct AgeGateEvent
25.5.4.
struct CheckAgeData
25.5.5.
enum PrivoError
25.6.
Age Verification Module
25.7.
Identity Verification Module
26.
Mobile Kotlin SDK (Android)
❱
26.1.
Requirements
26.2.
Installation
26.3.
Usage
26.4.
Auth Module
26.5.
Age Gate Module
26.6.
Age Verification Module
26.7.
Identity Verification Module
PRIVO Protect Partner API
27.
Intro
28.
API
❱
28.1.
Auth
28.2.
Lookup principles
Reference
29.
Using Callbacks / Webhooks
30.
Webhook Events & Outcomes
31.
Partner Site Navigation
Light (default)
Dark
Navy
Developer Portal
Hide
privo.ageGate.hide()
The method allows a partner to hide the Age Gate widget.