For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Help Center OpenAPI Spec Status

Overview Inquiries Transactions Relay API Reference Changelog

Getting Started
- Introduction
- Quickstart Tutorial
API Overview
Versioning
- API Changelog
- Versioning
Troubleshooting
- Error Handling
API Reference
Webhooks

Introduction
Quickstart Tutorial
API Keys
Key Inflection
API Attribute Blocklists
Payload Filters
Authentication
Protocol
Response Body
Idempotence
Pagination
Rate Limiting
Downloading Files
API Logs
Request IDs
API Changelog
June 22, 2026
June 15, 2026
June 9, 2026
June 1, 2026
May 4, 2026
April 27, 2026
April 13, 2026
March 30, 2026
January 28, 2026
January 18, 2026
January 12, 2026
December 16, 2025
December 8, 2025
October 27, 2025
October 20, 2025
September 29, 2025
September 15, 2025
August 18, 2025
July 30, 2025
July 7, 2025
June 30, 2025
June 23, 2025
June 16, 2025
June 9, 2025
May 27, 2025
May 19, 2025
April 28, 2025
April 1, 2025
March 3, 2025
February 24, 2025
February 18, 2025
February 4, 2025
January 13, 2025
November 4, 2024
October 29, 2024
October 7, 2024
September 30, 2024
September 16, 2024
September 9, 2024
September 3, 2024
August 26, 2024
August 13, 2024
July 30, 2024
July 23, 2024
July 1, 2024
June 17, 2024
May 14, 2024
April 29, 2024
April 15, 2024
April 8, 2024
April 1, 2024
March 25, 2024
March 4, 2024
February 26, 2024
February 5, 2024
January 29, 2024
January 22, 2024
January 8, 2024
December 18, 2023
November 27, 2023
November 13, 2023
October 23, 2023
October 16, 2023
October 10, 2023
October 2, 2023
September 18, 2023
August 28, 2023
August 21, 2023
August 7, 2023
July 17, 2023
July 10, 2023
July 3, 2023
June 26, 2023
June 12, 2023
June 5, 2023
May 29, 2023
May 15, 2023
May 8, 2023
May 1, 2023
April 24, 2023
April 17, 2023
April 10, 2023
April 3, 2023
March 27, 2023
March 20, 2023
January 5, 2023
August 18, 2021
July 15, 2021
May 14, 2021
February 21, 2021
Versioning
Error Handling
List all Accounts
Create an Account
Retrieve an Account
Redact an Account
Update an Account
Add a relation to an Account
Add tag to an Account
Consolidate Accounts
Get all relations for an Account
Remove a relation from an Account
Remove tag from an Account
Set tags on an Account
Run an account action
Retrieve an Account Type
List all API keys
Create an API key
Retrieve an API key
Update an API key
Expire an API key
Clone an API key
List all API Logs
Retrieve an API Log
Cases
List all Cases
Create a Case
Retrieve a Case
Redact a Case
Update a Case
Add Persona objects to a Case
Remove Persona objects from a Case
Assign a Case
Set status on a Case
Add tag to a Case
Remove tag from a Case
Set tags on a Case
Search Cases
Retrieve a Case Template
Connect
List all Connections
Retrieve a Connection
Create a Connection
Deactivate a Connection
Reactivate a Connection
List all Share Tokens
Retrieve a Share Token
Create a Share Token
Expire a Share Token
Redeem a Share Token
List all Devices
Retrieve a Device
Documents
Retrieve a Generic Document
Retrieve a Government Id Document
Retrieve a Document
List all Events
Retrieve an Event
Create a Graph Query
Retrieve a Graph Query
Inquiries
List all Inquiries
Create an Inquiry
Retrieve an Inquiry
Redact an Inquiry
Update an Inquiry
Add tag to an Inquiry
Approve an Inquiry
Decline an Inquiry
Mark an Inquiry for manual review
Expire an Inquiry
Generate a one-time link for an Inquiry
Print Inquiry PDF
Remove tag from an Inquiry
Resume an Inquiry
Set tags on an Inquiry
Perform Simulate Actions
Set Simulated Data
Search Inquiries
List all Inquiry Sessions
Create an Inquiry Session
Expire Inquiry Sessions
Retrieve an Inquiry Session
Expire an Inquiry Session
Generate a one-time link for Inquiry Session
List all Inquiry Templates
Retrieve an Inquiry Template
List Items
Create a Browser Fingerprint List Item
Retrieve a Browser Fingerprint List Item
Archive a Browser Fingerprint List Item
Create a Country List Item
Retrieve a Country List Item
Archive a Country List Item
Create a Device Fingerprint List Item
Retrieve a Device Fingerprint List Item
Archive a Device Fingerprint List Item
Create an Email Address List Item
Retrieve an Email Address List Item
Archive an Email Address List Item
Create a Field List Item
Retrieve a Field List Item
Archive a Field List Item
Create a Geolocation List Item
Retrieve a Geolocation List Item
Archive a Geolocation List Item
Create a Government ID Number List Item
Retrieve a Government ID Number List Item
Archive a Government ID Number List Item
Create an IP Address List Item
Retrieve an IP Address List Item
Archive an IP Address List Item
Create a Name List Item
Retrieve a Name List Item
Archive a Name List Item
Create a Phone Number List Item
Retrieve a Phone Number List Item
Archive a Phone Number List Item
Create a String List Item
Retrieve a String List Item
Archive a String List Item
Lists
Create a Browser Fingerprint List
Create a Country List
Create an Email Address List
Create a Geolocation List
Create a Government ID Number List
Create an IP Address List
Create a Name List
Create a Phone Number List
Create a Strings List
List all Lists
Retrieve a List
Archive a List
OAuth
Create Authorization
Create Access Token
List all Rate Limits
Create a Privacy Pass
Create a Relay
Request a Relay challenge
Generate a Relay claim
Reports
List all Reports
Create a Report
Retrieve a Report
Redact a Report
Add tag to a Report
Report Action: Dismiss Matches
List Report history
Report Action: Pause Continuous Monitoring
Print Report PDF
Remove tag from a Report
Report Action: Resume Continuous Monitoring
Report Action: Re-run Report
Set tags on a Report
Transactions
List all Transactions
Create a Transaction
Retrieve a Transaction
Redact a Transaction
Update a Transaction
Add relation to Transaction
Add tag to Transaction
Create a Transaction label
Remove relation from Transaction
Remove tag from a Transaction
Sets tags on a Transaction
Redact Transaction biometrics
Retrieve a Transaction Type
List all User Audit Logs
Retrieve a User Audit Log
Verifications
Retrieve a Verification
Redact a Verification
Print Verification PDF
AAMVA Verifications
Retrieve an AAMVA Verification
eCBSV Database Verifications
Retrieve an eCBSV Database Verification
Phone Carrier Database Verifications
Retrieve a Phone Carrier Database Verification
Serpro Database Verifications
Retrieve a Serpro Database Verification
Tin Database Verifications
Retrieve a TIN Database Verification
Database Verifications
Retrieve a Database Business Verification
Retrieve a Database Verification
Database Standard Verifications
Retrieve a Database Standard Verification
Document Verifications
Retrieve a Document Verification
Email Address Verifications
Retrieve an Email Address Verification
Government ID Verifications
Retrieve a Government ID Verification
Government ID NFC Verifications
Retrieve a Government ID NFC Verification
Phone Number Verifications
Retrieve a Phone Number Verification
Selfie Verifications
Retrieve a Selfie Verification
List all Webhooks
Create a Webhook
Retrieve a Webhook
Update a Webhook
Archive a Webhook
Enable a Webhook
Disable a Webhook
Rotate a Webhook's secret
Clone a Webhook
Workflows
Create a Workflow Run
Retrieve a Workflow Run
List all Workflow Runs
Account created
Account redacted
Account archived
Account restored
Account consolidated
Account consolidated with
Account tag added
Account tag removed
Account added relation
Account removed relation
Account status updated
Account updated fields
Account updated tags
Case assigned
Case created
Case exported
Case queue updated
Case redacted
Case reopened
Case resolved
Case SLA expired
Case status updated
Case updated fields
Case updated tags
Document created
Document submitted
Document processed
Document errored
Document extracted
Document pending
Graph Query cancelled
Graph Query completed
Graph Query errored
Graph Query reran
Graph Query timed out
Importer pipeline run canceled
Importer pipeline run completed
Importer pipeline run errored
Importer pipeline run paused
Importer pipeline run resumed
Importer pipeline run started
Inquiry created
Inquiry started
Inquiry expired
Inquiry completed
Inquiry failed
Inquiry marked for review
Inquiry approved
Inquiry declined
Inquiry transitioned
Inquiry redacted
Inquiry reusable-persona created
Inquiry reusable-persona used
Inquiry tags updated
Inquiry session started
Inquiry session expired
Inquiry session canceled
Address lookup report ready
Address lookup report errored
Address lookup report submitted
Adverse media report ready
Adverse media report errored
Adverse media report matched
Adverse media report match dismissed
Business adverse media report ready
Business adverse media report errored
Business adverse media report matched
Business adverse media report match dismissed
Business associated persons report ready
Business associated persons report errored
Business lookup report ready
Business lookup report errored
Business registrations lookup report ready
Business registrations lookup report errored
Business watchlist report ready
Business watchlist report errored
Business watchlist report matched
Business watchlist report match dismissed
Crypto address watchlist report ready
Crypto address watchlist report errored
Crypto address watchlist report matched
Email address report ready
Email address report errored
Phone number report ready
Phone number report errored
Politically exposed person (PEP) report ready
Politically exposed person (PEP) report errored
Politically exposed person (PEP) report matched
Politically exposed person (PEP) report match dismissed
Profile report ready
Profile report errored
Profile (non-authoritative) report ready
Profile (non-authoritative) report errored
SentiLink scores report ready
SentiLink scores report errored
Social media report ready
Social media report errored
Synthetic report ready
Synthetic report errored
Watchlist report ready
Watchlist report errored
Watchlist report matched
Watchlist report match dismissed
Selfie created
Selfie submitted
Selfie processed
Selfie errored
Transaction created
Transaction status updated
Transaction updated fields
Transaction labeled
Transaction redacted
Transaction added relation
Transaction removed relation
Transaction sentinel session processed
Transaction type deleted field
Verification canceled
Verification created
Verification escalated
Verification failed
Verification passed
Verification requires retry
Verification skipped
Verification submitted
Verification tentatively failed
Verification tentatively passed
Verification tags updated
Workflow run created
Workflow run errored
Workflow run resumed

Help Center OpenAPI Spec Status

API Reference Verifications

Government ID NFC Verifications

Something went wrong!

Was this page helpful?