TrustID API Logo
  • Getting Started with the API
  • Fundamentals
    • Introducing the Raw API
      • Supported Platforms
      • TrustID Cloud Endpoint Address
      • Testing the Raw API
      • Request Message
      • Response Message
      • Error Response
      • Unique Identifiers
      • JSON Date Format
    • Introducing the JavaScript API
      • Supported Platforms
      • API Object
      • Promises
      • Error Response
      • Node.js
      • React Native
    • Applications, Documents and Images
      • Working with Applications
        • Accessing Documents (Javascript only)
        • Application-level Custom Fields
        • Document Container Validation List
      • Working with Documents
        • Document Fields
        • Document Properties
        • Document Type
        • Document Name
        • Issuing Country and Nationality
        • Machine-Readable Zone (MRZ)
        • Document Feedback Properties
        • Document-level Custom Fields
      • Working with Images
        • Image Metadata
        • Image Types
    • Webhook Fundamentals
      • Supported Webhook events
      • Specifying your Webhook address
      • Webhook Payload
      • Understanding Callback Context
      • Webhook Retries
  • Using the API to Submit Applications and Receive Results
    • Workflow Overview
    • Submitting a New Application
      • Flow Diagram
      • Creating a New (Empty) Application
      • Application-level Custom Fields
      • Adding an IDV / Address Check
      • Checking a Physical Document
        • Creating a New Document
        • Creating a New Document With Person Matches Result
        • Creating a New Document With Custom Fields
        • Creating a New Supporting Document
        • Uploading Document Image Data
        • Uploading Document Image Data Re-Tries
      • Checking an Online Check Document
        • Creating a New (Empty) Application with a Custom Company Name
        • Creating a New Online Check Document
        • Triggering the Remote Download of Online Check
        • Download Photo From Online Check
      • Checking an Online Right To Rent Check Document
        • Creating a New (Empty) Application including RTR Agent Name
        • Creating a New Online RTR Check Document
        • Triggering the Remote Download of Online RTR Check
        • Download Photo From Online RTR Check
      • Uploading an Applicant Photo
      • Publishing an Application
    • Result Notification Webhook Callback
    • Authentication
      • Device Identifier (Raw API only)
      • Session Identifier (Raw API only)
      • Login
      • Login Response
        • User Information
        • Configuration
        • API Versions
        • VpeName
      • Password Reset
      • Change Password
      • Logout
      • Image Resources
      • Cross Origin Resource Sharing (CORS)
    • Retrieving Content
      • Retrieving Applications
      • Retrieving Documents
      • Retrieving Image Data
      • PDF Report
      • Retrieving Branches
    • Interpreting Results
      • Application-level Data
        • Ownership (Raw API Only)
        • Timestamps (Raw API Only)
        • Overall Status
        • Liveness Test Result
        • Right to Work - Full Check
        • Right to Work - Conditional
        • Republic of Ireland Right to Work
        • KycAml Result
        • Digital Identification Scheme Result
        • DBS Result
      • Interpreting DBS Status Results
      • Document Level Data
        • Document Type
        • Document Validation Status
        • Document Operator Status
        • Document Auditor Status
        • Document Assessment Feedback Messages
        • Machine-Readable Zone (MRZ)
        • Document Fraud Analysis
    • Container Modified Post Result Webhook Callback
  • Using the API to Receive Results
    • Workflow Overview
    • Container Submitted Webhook Callback
    • Result Notification Webhook Callback
    • Authentication
      • Device Identifier (Raw API only)
      • Session Identifier (Raw API only)
      • Login
      • Login Response
        • User Information
        • Configuration
        • API Versions
        • VpeName
      • Password Reset
      • Change Password
      • Logout
      • Image Resources
      • Cross Origin Resource Sharing (CORS)
    • Retrieving Content
      • Retrieving Applications
      • Retrieving Documents
      • Retrieving Image Data
      • PDF Report
      • Retrieving Branches
    • Interpreting Results
      • Application-level Data
        • Ownership (Raw API Only)
        • Timestamps (Raw API Only)
        • Overall Status
        • Liveness Test Result
        • Right to Work - Full Check
        • Right to Work - Conditional
        • Republic of Ireland Right to Work
        • KycAml Result
        • Digital Identification Scheme Result
        • DBS Result
      • Interpreting DBS Status Results
      • Document Level Data
        • Document Type
        • Document Validation Status
        • Document Operator Status
        • Document Auditor Status
        • Document Assessment Feedback Messages
        • Machine-Readable Zone (MRZ)
        • Document Fraud Analysis
    • Container Modified Post Result Webhook Callback
  • Using the API to Create Queued Applications and Receive Results
    • Workflow Overview
    • Queued Applications
      • Creating a New Queued Application
      • Using Application-level Custom Fields
      • Using Callback Properties Creating a Queued Application
    • Container Submitted Webhook Callback
    • Result Notification Webhook Callback
    • Authentication
      • Device Identifier (Raw API only)
      • Session Identifier (Raw API only)
      • Login
      • Login Response
        • User Information
        • Configuration
        • API Versions
        • VpeName
      • Password Reset
      • Change Password
      • Logout
      • Image Resources
      • Cross Origin Resource Sharing (CORS)
    • Retrieving Content
      • Retrieving Applications
      • Retrieving Documents
      • Retrieving Image Data
      • PDF Report
      • Retrieving Branches
    • Interpreting Results
      • Application-level Data
        • Ownership (Raw API Only)
        • Timestamps (Raw API Only)
        • Overall Status
        • Liveness Test Result
        • Right to Work - Full Check
        • Right to Work - Conditional
        • Republic of Ireland Right to Work
        • KycAml Result
        • Digital Identification Scheme Result
        • DBS Result
      • Interpreting DBS Status Results
      • Document Level Data
        • Document Type
        • Document Validation Status
        • Document Operator Status
        • Document Auditor Status
        • Document Assessment Feedback Messages
        • Machine-Readable Zone (MRZ)
        • Document Fraud Analysis
    • Container Modified Post Result Webhook Callback
  • Using the API to Create Guest Links and Receive Results
    • Workflow Overview
    • Guest Links
      • Creating a Guest Link
      • Using Application-level Custom Fields
      • Using Callback Properties Creating a Guest Link
      • Using Digital Identity Property
      • Using Right To Rent Digital Identity with RTR Share Code
      • Using a Custom Company Name with RTW Share Code
    • Container Submitted Webhook Callback
    • Result Notification Webhook Callback
    • Authentication
      • Device Identifier (Raw API only)
      • Session Identifier (Raw API only)
      • Login
      • Login Response
        • User Information
        • Configuration
        • API Versions
        • VpeName
      • Password Reset
      • Change Password
      • Logout
      • Image Resources
      • Cross Origin Resource Sharing (CORS)
    • Retrieving Content
      • Retrieving Applications
      • Retrieving Documents
      • Retrieving Image Data
      • PDF Report
      • Retrieving Branches
    • Interpreting Results
      • Application-level Data
        • Ownership (Raw API Only)
        • Timestamps (Raw API Only)
        • Overall Status
        • Liveness Test Result
        • Right to Work - Full Check
        • Right to Work - Conditional
        • Republic of Ireland Right to Work
        • KycAml Result
        • Digital Identification Scheme Result
        • DBS Result
      • Interpreting DBS Status Results
      • Document Level Data
        • Document Type
        • Document Validation Status
        • Document Operator Status
        • Document Auditor Status
        • Document Assessment Feedback Messages
        • Machine-Readable Zone (MRZ)
        • Document Fraud Analysis
    • Container Modified Post Result Webhook Callback
  • Using the API to Initiate DBS check
    • Workflow Overview
    • Retrieving the DBS Form
    • Editing the DBS Application
    • Initiating the DBS Application
      • Initiating the Basic DBS Application
      • Initiating the Standard or Enhanced DBS Application
      • DBS Result
      • Interpreting DBS Status Results
  • Archive
    • Quick Query Filter
    • Date Range Filter
    • Operator Filter
    • Additional Filters
    • Result Sorting
    • Query Pagination
    • Pagination Support
    • Querying Containers
    • Querying using application-level custom fields
  • Reference
    • Raw API Reference
      • Endpoint Reference
        • /dataAccess/advancedQuery/
        • /dataAccess/applicationFlexibleFieldAttributes/
        • /dataAccess/archiveContainerQuery/
        • /dataAccess/archiveDocumentContainer/
        • /dataAccess/createDocumentContainer/
        • /dataAccess/createQueuedDocumentContainer/
        • /dataAccess/createDocument/
        • /guestLink/createGuestLink/
        • /dataAccess/customFields/
        • /dataAccess/deleteDocumentContainerSet/
        • /dataAccess/downloadOnlineCheck/
        • /dataAccess/downloadPDF/
        • /dataAccess/exportPDF/
        • /dataAccess/getDocumentTypeChargeStatuses/
        • /dataAccess/image/
        • /dataAccess/initiateBasicDbsCheck/
        • /dataAccess/initiateStandardOrEnhancedDbsCheck/
        • /dataAccess/retrieveDBSForm/
        • /dataAccess/updateDBSForm/
        • /dataAccess/publishDocumentContainer/
        • /dataAccess/queryBranchesX/
        • /dataAccess/retrieveDocumentContainer/
        • /dataAccess/retrieveDocument/
        • /dataAccess/retrieveImage/
        • /dataAccess/updateDocumentContainer/
        • /dataAccess/uploadApplicantPhoto/
        • /dataAccess/uploadImage/
        • /kdb/getCountries/
        • /session/testConnection/
        • /session/login/
        • /session/logout/
        • /session/changePassword/
      • Model Reference
        • AccessLock
        • AdvancedQueryArguments
        • ApplicationFlexibleField
        • ApplicationFlexibleFieldAttribute
        • ApplicationFlexibleFieldList
        • ApplicationFlexibleFieldValue
        • Branch
        • CallbackInfo
        • CallbackState
        • ChargeableStatus
        • Configuration
        • Container
        • CustomField
        • CustomFieldDataType
        • Document
        • DocumentConfiguration
        • DocumentContainerValidation
        • DocumentContainerField
        • DocumentContainerValidationOutcome
        • DbsForm
        • DigitalIdentificationScheme
        • DocumentFeatureFeedback
        • DocumentFeedback
        • DocumentField
        • DocumentFieldDataType
        • DocumentFieldSource
        • DocumentSource
        • DocumentSortingColumn
        • DocumentStatus
        • DocumentStorageType
        • DocumentType
        • DocumentTypeChargeStatus
        • DocumentValidation
        • DocumentValidationResult
        • EstablishedDocumentData
        • ExternalServiceData
        • FilterDateOption
        • FlexibleFieldDataType
        • FlexibleFieldSearchSpecification
        • FlexibleFieldSpecificationSearchOperator
        • Gender
        • Image
        • ImageType
        • ImageOrientation
        • KDBCountry
        • KDBDocumentNumber
        • KDBDocumentSubType
        • KDBFeatureType
        • LivenessResultType
        • MrzQueryOption
        • OcrCoordinates
        • OcrField
        • OcrFieldData
        • Organisation
        • OverallStatus
        • ReferralHistoryRecord
        • ReferralType
        • ReviewApplicationState
        • RemainingCredits
        • SortingDirection
        • User
        • UserArchiveVisibility
        • UserReference
        • WebhookResponse
        • WorkflowType
    • Javascript API Reference
      • Class Api
        • Error Responses
        • Methods
      • Class ApplicationFlexibleField
      • Class ApplicationFlexibleFieldValue
      • Class Branch
      • Class Config
      • Class Container
      • Class CustomField
      • Class Document
      • Class DocumentSortingColumn
      • Class DocumentTypeChargeStatus
      • Class FeedbackProperty
      • Class Image
      • Class ModelBase
      • Class Organisation
      • Class RemainingCredits
      • Class SortingDirection
      • Class User
TrustID API
  • Reference
  • Raw API Reference
  • Endpoint Reference

Endpoint Reference

This section provides a reference documentation for all major endpoints by describing all details around the request and response message format.

  • /dataAccess/advancedQuery/
  • /dataAccess/applicationFlexibleFieldAttributes/
  • /dataAccess/archiveContainerQuery/
  • /dataAccess/archiveDocumentContainer/
  • /dataAccess/createDocumentContainer/
  • /dataAccess/createQueuedDocumentContainer/
  • /dataAccess/createDocument/
  • /guestLink/createGuestLink/
  • /dataAccess/customFields/
  • /dataAccess/deleteDocumentContainerSet/
  • /dataAccess/downloadOnlineCheck/
  • /dataAccess/downloadPDF/
  • /dataAccess/exportPDF/
  • /dataAccess/getDocumentTypeChargeStatuses/
  • /dataAccess/image/
  • /dataAccess/initiateBasicDbsCheck/
  • /dataAccess/initiateStandardOrEnhancedDbsCheck/
  • /dataAccess/retrieveDBSForm/
  • /dataAccess/updateDBSForm/
  • /dataAccess/publishDocumentContainer/
  • /dataAccess/queryBranchesX/
  • /dataAccess/retrieveDocumentContainer/
  • /dataAccess/retrieveDocument/
  • /dataAccess/retrieveImage/
  • /dataAccess/updateDocumentContainer/
  • /dataAccess/uploadApplicantPhoto/
  • /dataAccess/uploadImage/
  • /kdb/getCountries/
  • /session/testConnection/
  • /session/login/
  • /session/logout/
  • /session/changePassword/
Previous Next

© Copyright 2026, TrustID.

Built with Sphinx using a theme provided by Read the Docs.