Jump to Content
Home
Documentation
Knowledge Hub
Support
Release Notes
Search Box
Home
Guides
Recipes
Documentation
v1.0
v3.0
Home
Documentation
Knowledge Hub
Support
Release Notes
Search Box
Documentation
OAuth API
Documentation
Modifying Hosted Workflows via Query Parameter
All
Pages
Start typing to search…
JUMP TO
DEVELOPER PORTAL
Welcome
RECIPES & EXAMPLES
Recipes and Examples - Overview
Authentication
API Handshake
HMAC
Event Dispatcher
Examples
Business Insights + Business Watchlist Screening
Person Match + Person Watchlist Screening
ID Document Verification using the Customer API
API GUIDES
API Guides - Overview
Trulioo Platform API
Uploading and Retrieving Workflow Documents
Modifying Hosted Workflows via Query Parameter
Identity Document Verification
Getting Started
Webhook
Android
IOS
Web
Web 3.0
Migration Guide
Workflow Studio
Workflow Studio (Low-Code)
Workflow Studio (API)
Web Capture with Custom UX/UI
Features
Known Faces
React Native Capture SDK (Custom UX/UI)
Normalized API
Asynchronous Requests
Multi-Region Hosting
Address Validation
Person Verification
Integration Guide
API Integration
Understanding a Verify Response
Get Country Codes
Get Fields
Customer Consent
Best Practices & Help Guide
Fraud Intelligence - Person Fraud
Person Screening
Business Verification
Step 1: Say Hello
Step 2: Test Authentication
Step 3: Retrieve Your Account Configuration
Step 4: Selecting Your Flow
Step 5: Business Search
Step 6: Verify
Step 7: Download Document
Business Verification - Best Practices
Understanding Standardized Fields
Verifying Additional Names & Addresses
Comprehensive View
Matching on Persons of Significant Control
Partial Results
Language Intelligence
Business Screening
Business (KYB) Monitoring
KYB Prefill
Normalized API 1.0 (Legacy)
v1 - Introduction
v1 - Getting Started
Sandbox vs. Live Environment - v1
v1 - Keys and Authentication
Connecting to Trulioo's API using Mutual TLS - v1
v1 - Asynchronous Requests
v1 - Multi-Region Hosting
v1 - What is Address Validation?
v1 - Identity Verification
v1 - API Integration
v1 - Understanding a Verify Response
v1 - Get Country Codes
v1 - Get Fields
v1 - Customer Consent
v1 - Best Practices & Help Guide
v1 - What Fields am I configured for?
v1 - My Previous Transactions
v1 - National IDs: Supported Types
v1 - What is Address Cleansing?
v1 - International Watchlist
v1 - Person Screening
v1 - Watchlist Screening
v1 - Identity Document Verification
v1 - Identity Document Verification Overview
v1 - Mobile SDK - iOS
v1 - Mobile SDK - Android
v1 - Document Verification
v1 - Document Verification Overview
v1 - Improving Document Capture Results
v1 - Identity Document Verification Quick Start
v1 - Step 1: Say Hello
v1 - Step 2: Test Authentication
v1 - Step 3: Get Country Codes
v1 - Step 4: SDK token request optional
v1 - Step 5: Get Document Types
v1 - Step 6: Image Capture SDK
v1 - Step 7: Async Verify
v1 - Step 8: Synch Verify
v1 - Integration Guide/Best Practices
v1 - Country Codes
v1 - Document Types
v1 - Verify
v1 - Business Verification Overview
v1 - Business Verification
v1 - Important Concepts
v1 - KYB Quick Start
v1 - Step 1: Say Hello
v1 - Step 2: Test Authentication
v1 - Step 3: Retrieve Your Account Configuration
v1 - Step 4: Selecting Your Flow
v1 - Step 5: Business Search
v1 - Step 6: Verify
v1 - Step 7: Download Document
v1 - Next Steps
v1 - Business Screening
v1 - Business Watchlist Screening
v1 - Best Practices
v1 - Using Search and Verify APIs
v1 - View Previous Transactions
v1 - Document Availability
v1 - Document Request Time
v1 - vUnderstanding Standardized Fields
v1 - Standardized Business Verification Content
v1 - Verifying Additional Names & Addresses
v1 - Comprehensive View
v1 - Matching on Persons of Significant Control
v1 - Partial Results
v1 - Language Intelligence
v1 - Errors
v1 - HTTP Errors
v1 - Trulioo Service/DataSource Level Errors
v1 - Validation Codes
v1 - Record Level Errors
v1 - Get Transaction Record Errors
API Reference
API Reference - Overview
Errors
Trulioo Platform API Endpoints
Get current step or initialize a flow
get
Submit data for the current step of a flow
post
Submit file for the current step of a flow
post
Computes a backward step in the flow execution.
get
Receiving Events
post
Retrieve workflows from organization v2
get
Retrieve profiles from your workspace v2
get
Retrieve profile data from a client v2
get
Retrieve a file from a client v2
get
Create a link between two end clients
post
Delete a link between two end clients
del
Get init data for a flow
get
Create a new user state ID or update an existing one with some initialization data
post
Delete end clients in bulk
del
Update end clients status in bulk
put
Generate Signed URL for User Session
post
Deprecated
Client Credential Flow (2-legged OAuth)
post
Retrieve workflows from organization v1
get
Retrieve a file from a client v1
get
Retrieve profiles from your workspace v1
get
Retrieve profile data from a client v1
get
Normalized API (NAPI)
Configuration
Get Country Code
get
Get Recommended Fields
get
Get Detailed Consents
get
Get Consents
get
Get Test Entities
get
Get List of packages
get
Get Country Subdivisions
get
Get Fields
get
Get Datasources
get
Connection
Say Hello
get
Test Authentication
get
Verifications
Get Transaction Record
get
Get Transaction Status
get
KYC - Person Verification
Verify
post
KYB - Business Verification
Get all Jurisdictions of Incorporation
get
Get Jurisdictions of Incorporation per country
get
Get Business Registration Numbers for all supported countries
get
Get Business Registration Numbers by Country
get
Get Business Registration Numbers by Country w/JOI
get
Business Search
post
GetBusinessSearchResult
get
Verify
post
DocumentDownload
get
Get Trulioo Business Summary Report
get
Get Partial Transaction Result
get
Normalized API 1.0 (Legacy)
Connection Endpoints (Legacy)
Say Hello
Test Authentication
Configuration Endpoints (Legacy)
Get Country Codes
Get Consents
Get Detailed Consents
Get Country Subdivisions
Get Fields
Get Recommended Fields
Get Test Entities
Get Datasources
Verification Endpoints (Legacy)
Get Transaction Record
Get Transaction Record (w/Address)
Get Transaction Record Verbose
Get Transaction Status
Identity Verification Endpoints (Legacy)
Verify
Document Verification Endpoints (Legacy)
Get Document Types
Verify
Get Transaction Record (w/Document Image)
Business Verification Endpoints - (Legacy)
Get Business Registration Numbers for all supported countries
Get Business Registration Numbers by Country
Get Business Registration Numbers by Country w/JOI
Get all Jurisdictions of Incorporation
Get Jurisdictions of Incorporation per country
Business Search
Get Business Search Result
Verify
Get Partial Transaction Result
Download Document
Identity Document Verification Reference
Identity Document Verification
Version 3.0 (Recommended)
Authorization
Transaction
Create a short code for SDK handoff
post
Create and configure a transaction
post
Upload a document or selfie image
post
Start verification for the current transaction
post
Get transaction data
get
KnownFaces
Create a new KnownFaces list
post
List all KnownFaces list
get
Get all transactions tagged to the specified list
get
Delete a KnownFaces list
del
Add transactions to a list
post
Delete a transaction from a list
del
Update list metadata
post
Enrolment
Upload a selfie
post
Upload a selfie with external unique person identifier
post
Enrol selfie from an old transaction
post
Version 2.5
Authorization
Authorize and generate access tokens
post
Transaction
Create a shortcode for handoff to a SDK
post
Create and Configure Transactions
post
Upload a document
post
Start to verify a transaction
post
Get the data of a transaction
get
Get an image
get
Version 2.4
Authorization
Authorize and generate access tokens
post
Transaction
Create a shortcode for handoff to a SDK
post
Create and Configure Transactions
post
Upload a document
post
Start to verify a transaction
post
Get the data of a transaction
get
Get an image
get
Business Monitoring
Enrollment
Enroll Business
post
Retrieve Latest Monitoring Result
get
Refresh Enrollment Date
post
Get Enrollment Details
get
Delete Enrollment
del
Modifying Hosted Workflows via Query Parameter
Ask AI
