Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Protocol
Search
All
Pages
Start typing to search…
JUMP TO
Getting Started
Introduction✓
Quickstart Tutorial✓
Persona API Concepts
API Key
Key Inflection
Attribute Blocklists
Authentication
Protocol
Idempotence
Data Model
include
Sparsefield sets
Examples
Rate Limiting
Downloading Files
API Logs
Request IDs
Versioning
Versioning
API Changelog
Troubleshooting
Error Handling
Persona API Reference
Accounts
List all Accounts
get
Create an Account
post
Redact an Account
delete
Retrieve an Account
get
Update an Account
patch
Add tag to an Account
post
Consolidate Accounts
post
Remove tag from an Account
post
Set tags on an Account
post
API Keys
List all API keys
get
Create an API key
post
Retrieve an API key
get
Update an API key
patch
Expire an API key
post
API Logs
List all API Logs
get
Retrieve an API Log
get
Cases
List all Cases
get
Create a Case
post
Redact a Case
delete
Retrieve a Case
get
Update a Case
patch
Add Persona objects to a Case
post
Assign a Case
post
Set status on a Case
post
Add tag to a Case
post
Remove tag from a Case
post
Set tags on a Case
post
Devices
List all Devices
get
Retrieve a Device
get
Documents
Create a Generic Document
post
Retrieve a Generic Document
get
Update a Generic Document
patch
Submit a Generic Document
post
Create a Government ID Document
post
Retrieve a Government Id Document
get
Update a Government ID Document
patch
Submit a Government ID Document
post
Retrieve a Document
get
Events
List all Events
get
Retrieve an Event
get
Importers
List all Importers
get
Retrieve an Importer
get
Import Accounts
post
Import Email Address Lists
post
Import Geolocation Lists
post
Import Government ID Number Lists
post
Import IP Address Lists
post
Import Name Lists
post
Import Phone Number Lists
post
Inquiries
List all Inquiries
get
Create an Inquiry
post
Redact an Inquiry
delete
Retrieve an Inquiry
get
Update an Inquiry
patch
Add tag to an Inquiry
post
Approve an Inquiry
post
Decline an Inquiry
post
Mark an Inquiry for manual review
post
Expire an Inquiry
post
Generate a one-time link for an Inquiry
post
Print Inquiry PDF
get
Remove tag from an Inquiry
post
Resume an Inquiry
post
Set tags on an Inquiry
post
Perform Simulate Actions
post
Inquiry Sessions
List all Inquiry Sessions
get
Create an Inquiry Session
post
Expire Inquiry Sessions
post
Retrieve an Inquiry Session
get
Expire an Inquiry Session
post
Generate a one-time link for Inquiry Session
post
Inquiry Templates
List all Inquiry Templates
get
Retrieve an Inquiry Template
get
List Items
Create a Browser Fingerprint List Item
post
Retrieve a Browser Fingerprint List Item
get
Archive a Browser Fingerprint List Item
delete
Create a Country List Item
post
Retrieve a Country List Item
get
Archive a Country List Item
delete
Create a Device Fingerprint List Item
post
Retrieve a Device Fingerprint List Item
get
Archive a Device Fingerprint List Item
delete
Create an Email Address List Item
post
Retrieve an Email Address List Item
get
Archive an Email Address List Item
delete
Create a Field List Item
post
Retrieve a Field List Item
get
Archive a Field List Item
delete
Create a Geolocation List Item
post
Retrieve a Geolocation List Item
get
Archive a Geolocation List Item
delete
Create a Government ID Number List Item
post
Retrieve a Government ID Number List Item
get
Archive a Government ID Number List Item
delete
Create an IP Address List Item
post
Retrieve an IP Address List Item
get
Archive an IP Address List Item
delete
Create a Name List Item
post
Retrieve a Name List Item
get
Archive a Name List Item
delete
Create a Phone Number List Item
post
Retrieve a Phone Number List Item
get
Archive a Phone Number List Item
delete
Create a String List Item
post
Retrieve a String List Item
get
Archive a String List Item
delete
Lists
Create a Browser Fingerprint List
post
Create a Country List
post
Create an Email Address List
post
Create a Geolocation List
post
Create a Government ID Number List
post
Create an IP Address List
post
Create a Name List
post
Create a Phone Number List
post
List all Lists
get
Archive a List
delete
Retrieve a List
get
OAuth
Create Authorization
post
Create Access Token
post
Reports
List all Reports
get
Create a Report
post
Redact a Report
delete
Retrieve a Report
get
Add tag to a Report
post
Report Action: Dismiss Matches
post
Report Action: Pause Continuous Monitoring
post
Print Report PDF
get
Remove tag from a Report
post
Report Action: Resume Continuous Monitoring
post
Report Action: Re-run Report
post
Set tags on a Report
post
Transactions
Create a Transaction
post
List all Transactions
get
Redact a Transaction
delete
Retrieve a Transaction
get
Update a Transaction
patch
Add tag to Transaction
post
Create a Transaction label
post
Remove tag from a Transaction
post
Sets tags on a Transaction
post
Redact Transaction biometrics
post
User Audit Logs
List all User Audit Logs
get
Retrieve an User Audit Log
get
AAMVA Verifications
Retrieve an AAMVA Verification
get
eCBSV Database Verifications
Retrieve an eCBSV Database Verification
get
Phone Carrier Database Verifications
Retrieve a Phone Carrier Database Verification
get
Serpro Database Verifications
Retrieve a Serpro Database Verification
get
Database Standard Verifications
Retrieve a Database Standard Verification
get
TIN Database Verifications
Retrieve a TIN Database Verification
get
Database Verifications
Retrieve a Database Verification
get
Document Verifications
Retrieve a Document Verification
get
Email Address Verifications
Retrieve a Email Address Verification
get
Government ID Verifications
Retrieve a Government Id Verification
get
Government ID NFC Verifications
Retrieve a Government Id NFC Verification
get
Phone Number Verifications
Retrieve a Phone Number Verification
get
Selfie Verifications
Retrieve a Selfie Verification
get
Verifications
Retrieve a Verification
get
Redact a Verification
delete
Print Verification PDF
get
Webhooks
List all Webhooks
get
Create a Webhook
post
Retrieve a Webhook
get
Update a Webhook
patch
Archive a Webhook
post
Enable a Webhook
post
Disable a Webhook
post
Rotate a Webhook's secret
post
Workflows
Create a Workflow Run
post
Retrieve a Workflow Run
get
List all Workflow Runs
get
Webhooks: Account events
Account created
post
Account redacted
post
Account archived
post
Account restored
post
Account consolidated
post
Account tag added
post
Account tag removed
post
Webhooks: Inquiry events
Inquiry created
post
Inquiry expired
post
Inquiry completed
post
Inquiry failed
post
Inquiry marked for review
post
Inquiry approved
post
Inquiry declined
post
Inquiry transitioned
post
Powered by
Protocol
