TrustID API
Getting Started with the API
Fundamentals
Using the API to Submit Applications and Receive Results
Using the API to Receive Results
Using the API to Create Queued Applications and Receive Results
Using the API to Create Guest Links and Receive Results
Archive
Reference
TrustID API
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
U
|
V
|
W
A
AccessLock.AnonymousSessionId (built-in variable)
AccessLock.Locked (built-in variable)
AccessLock.Timestamp (built-in variable)
AccessLock.UserDisplay (built-in variable)
AccessLock.UserId (built-in variable)
AdvancedQueryArguments.Audited (built-in variable)
AdvancedQueryArguments.AuditedBy (built-in variable)
AdvancedQueryArguments.BranchName (built-in variable)
AdvancedQueryArguments.CustomFields (built-in variable)
AdvancedQueryArguments.DateOfBirth (built-in variable)
AdvancedQueryArguments.DocumentNumber (built-in variable)
AdvancedQueryArguments.DocumentType (built-in variable)
AdvancedQueryArguments.DrivingLicenseNumber (built-in variable)
AdvancedQueryArguments.ExpiryDate (built-in variable)
AdvancedQueryArguments.FilterDateOfBirthDateOption (built-in variable)
AdvancedQueryArguments.FilterExpiryDateOption (built-in variable)
AdvancedQueryArguments.Firstname (built-in variable)
AdvancedQueryArguments.Gender (built-in variable)
AdvancedQueryArguments.IdentityCardNumber (built-in variable)
AdvancedQueryArguments.IssuingCountryCode (built-in variable)
AdvancedQueryArguments.Lastname (built-in variable)
AdvancedQueryArguments.MaxAgeFailed (built-in variable)
AdvancedQueryArguments.MinAgeFailed (built-in variable)
AdvancedQueryArguments.MRZCorrected (built-in variable)
AdvancedQueryArguments.MrzQueryOption (built-in variable)
AdvancedQueryArguments.NationalityCode (built-in variable)
AdvancedQueryArguments.PassportNumber (built-in variable)
AdvancedQueryArguments.PersonalNumber (built-in variable)
AdvancedQueryArguments.QuickQuery (built-in variable)
AdvancedQueryArguments.ScannedBy (built-in variable)
AdvancedQueryArguments.Status (built-in variable)
AdvancedQueryArguments.VisaNumber (built-in variable)
Api() (class)
Api.Branch (Api attribute)
Api.Config (Api attribute)
Api.Organisation (Api attribute)
Api.RemainingCredits (Api attribute)
Api.User (Api attribute)
ApplicationFlexibleField() (class)
ApplicationFlexibleField.DATETIME (global variable or constant)
ApplicationFlexibleField.DECIMAL (global variable or constant)
ApplicationFlexibleField.ENUM (global variable or constant)
ApplicationFlexibleField.INT (global variable or constant)
ApplicationFlexibleField.NewApplicationField (built-in variable)
ApplicationFlexibleField.NewGuestLinkField (built-in variable)
ApplicationFlexibleField.NewQueuedApplicationField (built-in variable)
ApplicationFlexibleField.PopulateQueuedApplicationField (built-in variable)
ApplicationFlexibleField.STRING (global variable or constant)
ApplicationFlexibleFieldAttribute.BranchId (built-in variable)
ApplicationFlexibleFieldAttribute.CreationDate (built-in variable)
ApplicationFlexibleFieldAttribute.DataRange (built-in variable)
ApplicationFlexibleFieldAttribute.DataType (built-in variable)
ApplicationFlexibleFieldAttribute.DefaultValue (built-in variable)
ApplicationFlexibleFieldAttribute.DisplayName (built-in variable)
ApplicationFlexibleFieldAttribute.FieldOrderIndex (built-in variable)
ApplicationFlexibleFieldAttribute.FlexibleFieldId (built-in variable)
ApplicationFlexibleFieldAttribute.HelpText (built-in variable)
ApplicationFlexibleFieldAttribute.Id (built-in variable)
ApplicationFlexibleFieldAttribute.IsActive (built-in variable)
ApplicationFlexibleFieldAttribute.IsEnabled (built-in variable)
ApplicationFlexibleFieldAttribute.IsValidationField (built-in variable)
ApplicationFlexibleFieldAttribute.LastModifield (built-in variable)
ApplicationFlexibleFieldAttribute.Mandatory (built-in variable)
ApplicationFlexibleFieldAttribute.Name (built-in variable)
ApplicationFlexibleFieldAttribute.ValidationFailValue (built-in variable)
ApplicationFlexibleFieldAttribute.ValidationPassValue (built-in variable)
ApplicationFlexibleFieldAttribute.ValidationWarningValue (built-in variable)
applicationFlexibleFieldAttributes.Flags (built-in variable)
ApplicationFlexibleFieldAttributesResponse.ApplicationFlexibleFieldAttributes (built-in variable)
ApplicationFlexibleFieldList.m_Item1 (built-in variable)
ApplicationFlexibleFieldList.m_Item2 (built-in variable)
ApplicationFlexibleFieldValue() (class)
ApplicationFlexibleFieldValue.DocumentContainerId (built-in variable)
ApplicationFlexibleFieldValue.Field (ApplicationFlexibleFieldValue attribute)
ApplicationFlexibleFieldValue.FieldValueDate (built-in variable)
ApplicationFlexibleFieldValue.FieldValueDecimal (built-in variable)
ApplicationFlexibleFieldValue.FieldValueInt (built-in variable)
ApplicationFlexibleFieldValue.FieldValueString (built-in variable)
ApplicationFlexibleFieldValue.FlexibleFieldId (built-in variable)
ApplicationFlexibleFieldValue.FlexibleFieldVersionId (built-in variable)
ApplicationFlexibleFieldValue.ValidationStatus (built-in variable)
ArchiveAdvancedQueryRequest.Arguments (built-in variable)
ArchiveAdvancedQueryRequest.DocumentSortingColumn (built-in variable)
ArchiveAdvancedQueryRequest.Page (built-in variable)
ArchiveAdvancedQueryRequest.PageSize (built-in variable)
ArchiveAdvancedQueryRequest.RangeFrom (built-in variable)
ArchiveAdvancedQueryRequest.RangeUntil (built-in variable)
ArchiveAdvancedQueryRequest.SortingDirection (built-in variable)
ArchiveContainerQueryRequest.ContainerBranchId (built-in variable)
ArchiveContainerQueryRequest.ContainerCreatedAtRangeFrom (built-in variable)
ArchiveContainerQueryRequest.ContainerCreatedAtRangeUntil (built-in variable)
ArchiveContainerQueryRequest.ContainerOrganisationId (built-in variable)
ArchiveContainerQueryRequest.ContainerScannedByUserId (built-in variable)
ArchiveContainerQueryRequest.DocumentHolderName (built-in variable)
ArchiveContainerQueryRequest.FlexibleFieldSearchSpecifications (built-in variable)
ArchiveContainerQueryRequest.FlexibleFieldSpecificationSearchOperator (built-in variable)
ArchiveContainerQueryRequest.Page (built-in variable)
ArchiveContainerQueryRequest.PageSize (built-in variable)
ArchiveContainerQueryRequest.SortingDirection (built-in variable)
ArchiveContainerQueryResponse.DocumentContainers (built-in variable)
ArchiveContainerQueryResponse.Page (built-in variable)
ArchiveContainerQueryResponse.PageSize (built-in variable)
ArchiveContainerQueryResponse.PaginationSupported (built-in variable)
ArchiveContainerQueryResponse.TotalPages (built-in variable)
ArchiveContainerQueryResponse.TotalRecords (built-in variable)
ArchiveContainerQueryResponse.TotalRecordsMatched (built-in variable)
ArchiveDocumentContainerRequest.ContainerId (built-in variable)
ArchiveQueryResponse.Documents (built-in variable)
ArchiveQueryResponse.Page (built-in variable)
ArchiveQueryResponse.PageSize (built-in variable)
ArchiveQueryResponse.PaginationSupported (built-in variable)
ArchiveQueryResponse.TotalPages (built-in variable)
ArchiveQueryResponse.TotalRecords (built-in variable)
ArchiveQueryResponse.TotalRecordsMatched (built-in variable)
B
Branch() (class)
Branch.Active (built-in variable)
Branch.Description (Branch attribute)
(built-in variable)
Branch.Id (Branch attribute)
(built-in variable)
Branch.Name (Branch attribute)
(built-in variable)
Branch.OrganisationId (Branch attribute)
(built-in variable)
Branch.PRIVILEGE_CREATE_APPLICATIONS (global variable or constant)
Branch.Privileges (Branch attribute)
(built-in variable)
C
CallbackInfo.Aborted (built-in variable)
CallbackInfo.CallbackAt (built-in variable)
CallbackInfo.CallbackId (built-in variable)
CallbackInfo.CallbackStatusCode (built-in variable)
CallbackInfo.CallbackUrl (built-in variable)
CallbackInfo.ErrorMessage (built-in variable)
CallbackInfo.ProcessName (built-in variable)
CallbackInfo.RetryCounter (built-in variable)
CallbackInfo.ScheduledAt (built-in variable)
CallbackInfo.State (built-in variable)
CallbackInfo.UpdatedAt (built-in variable)
CallbackInfo.WorkflowName (built-in variable)
CallbackInfo.WorkflowState (built-in variable)
CallbackInfo.WorkflowStorage (built-in variable)
CallbackState.Dispatched (built-in variable)
CallbackState.OperatorAction (built-in variable)
CallbackState.Processing (built-in variable)
CallbackState.ReadyToDispatch (built-in variable)
CallbackState.Scheduled (built-in variable)
CallbackState.UnableToDispatch (built-in variable)
CallbackState.Workflow (built-in variable)
CallbackState.WorkflowComplete (built-in variable)
ChargeableStatus.Charge (built-in variable)
ChargeableStatus.ChargeIfReviewed (built-in variable)
ChargeableStatus.NoCharge (built-in variable)
Config() (class)
Configuration.SERVICE_SYSTEM_TYPE (built-in variable)
Configuration.SUPPORT_PAGINATION (built-in variable)
Configuration.UI_DRIVING_LICENCE_SIDE2_MANDATORY_ENABLED (built-in variable)
Configuration.UI_ID_CARD_SIDE2_MANDATORY_ENABLED (built-in variable)
Configuration.UI_MULTIPLE_DOCUMENTS_PER_APPLICATION_DISABLED (built-in variable)
Configuration.UI_PERSON_NOT_SEEN_REQUIRED_ENABLED (built-in variable)
Configuration.UI_PHOTO_MATCHES_REQUIRED_ENABLED (built-in variable)
Container() (class)
Container.AccessLock (built-in variable)
Container.ApplicationFlexibleFieldList (built-in variable)
Container.BranchId (built-in variable)
Container.BranchName (built-in variable)
Container.Container.OVERALL_STATUS_TYPE.ALERT (global variable or constant)
Container.Container.OVERALL_STATUS_TYPE.NO_ALERT (global variable or constant)
Container.Container.OVERALL_STATUS_TYPE.RESOLVED (global variable or constant)
Container.CreatedAt (built-in variable)
Container.DOCUMENT_SOURCE_IMAGE (global variable or constant)
Container.DOCUMENT_SOURCE_SCANNER (global variable or constant)
Container.DOCUMENT_SOURCE_SYNC (global variable or constant)
Container.DOCUMENT_SOURCE_TTA_IMPORT (global variable or constant)
Container.Documents (built-in variable)
(Container attribute)
Container.DocumentSource (built-in variable)
Container.DocumentStorageType (built-in variable)
Container.Id (built-in variable)
Container.LIVENESS_RESULT_TYPE.ERROR (global variable or constant)
Container.LIVENESS_RESULT_TYPE.FACE_ANGLE_TOO_LARGE (global variable or constant)
Container.LIVENESS_RESULT_TYPE.FACE_NOT_FOUND (global variable or constant)
Container.LIVENESS_RESULT_TYPE.FACE_TOO_CLOSE (global variable or constant)
Container.LIVENESS_RESULT_TYPE.FACE_TOO_SMALL (global variable or constant)
Container.LIVENESS_RESULT_TYPE.FAILED_TO_READ_IMAGE (global variable or constant)
Container.LIVENESS_RESULT_TYPE.LIVE (global variable or constant)
Container.LIVENESS_RESULT_TYPE.NOT_LIVE (global variable or constant)
Container.LIVENESS_RESULT_TYPE.POOR_IMAGE_QUALITY (global variable or constant)
Container.LIVENESS_RESULT_TYPE.UNKNOWN (global variable or constant)
Container.LivenessTestResult (built-in variable)
(Container attribute)
Container.LivenessTestScore (built-in variable)
(Container attribute)
Container.OVERALL_STATUS_TYPE (global variable or constant)
Container.OverallStatus (built-in variable)
(Container attribute)
Container.ReferralHistory (built-in variable)
Container.ReferralType (built-in variable)
Container.Referred (built-in variable)
Container.ReferredAt (built-in variable)
Container.ReferredFrom (built-in variable)
Container.ReviewApplicationInstigatingUser (built-in variable)
Container.ReviewApplicationState (built-in variable)
Container.ScannedByUser (built-in variable)
Container.Synchronised (built-in variable)
Container.TtaImport (built-in variable)
Container.UpdatedAt (built-in variable)
Container.UserId (built-in variable)
Container.VpeDeviceId (built-in variable)
Container.VpeName (built-in variable)
Container.VpeType (built-in variable)
Container.WorkflowType (built-in variable)
CreateDocumentContainerRequest.ApplicationFlexibleFieldValues (built-in variable)
CreateDocumentContainerRequest.ClientApplicationReference (built-in variable)
CreateDocumentContainerRequest.CreateDocument (built-in variable)
CreateDocumentContainerRequest.DocumentSource (built-in variable)
CreateDocumentContainerRequest.ScannerType (built-in variable)
CreateDocumentContainerResponse.ClientApplicationReference (built-in variable)
CreateDocumentContainerResponse.ContainerId (built-in variable)
CreateDocumentContainerResponse.DocumentId (built-in variable)
CreateDocumentRequest.ContainerId (built-in variable)
CreateDocumentRequest.Document (built-in variable)
CreateDocumentRequest.DocumentType (built-in variable)
CreateDocumentRequest.Mrz (built-in variable)
CreateDocumentRequest.RfidMrz (built-in variable)
CreateDocumentRequest.ScannerType (built-in variable)
CreateDocumentResponse.ContainerId (built-in variable)
CreateDocumentResponse.DocumentId (built-in variable)
CreateGuestLinkRequest.ApplicationFlexibleFieldValues (built-in variable)
CreateGuestLinkRequest.BranchId (built-in variable)
CreateGuestLinkRequest.ClientApplicationReference (built-in variable)
CreateGuestLinkRequest.ContainerEventCallbackHeaders (built-in variable)
CreateGuestLinkRequest.ContainerEventCallbackUrl (built-in variable)
CreateGuestLinkRequest.DigitalIdentificationScheme (built-in variable)
CreateGuestLinkRequest.Email (built-in variable)
CreateGuestLinkRequest.EmailContentOverride (built-in variable)
CreateGuestLinkRequest.EmailSubjectOverride (built-in variable)
CreateGuestLinkRequest.Name (built-in variable)
CreateGuestLinkRequest.SendEmail (built-in variable)
CreateGuestLinkResponse.EmailContent (built-in variable)
CreateGuestLinkResponse.EmailSubject (built-in variable)
CreateGuestLinkResponse.LinkUrl (built-in variable)
CreateQueuedDocumentContainerRequest.ApplicationFlexibleFieldValues (built-in variable)
CreateQueuedDocumentContainerRequest.BranchId (built-in variable)
CreateQueuedDocumentContainerRequest.ClientApplicationReference (built-in variable)
CreateQueuedDocumentContainerRequest.ContainerEventCallbackHeaders (built-in variable)
CreateQueuedDocumentContainerRequest.ContainerEventCallbackUrl (built-in variable)
CreateQueuedDocumentContainerResponse.ClientApplicationReference (built-in variable)
CreateQueuedDocumentContainerResponse.ContainerId (built-in variable)
CustomField() (class)
CustomField.DATA_TYPE_DROP_DOWN (global variable or constant)
CustomField.DATA_TYPE_EXPIRY_DATE (global variable or constant)
CustomField.DATA_TYPE_STRING (global variable or constant)
CustomField.DataType (built-in variable)
CustomField.DisplayName (built-in variable)
(CustomField attribute)
CustomField.Help (built-in variable)
CustomField.Index (built-in variable)
CustomField.PropertyName (built-in variable)
(CustomField attribute)
CustomField.Required (built-in variable)
CustomField.Value (built-in variable)
CustomField.Values (built-in variable)
CustomFieldDataType.DropDown (built-in variable)
CustomFieldDataType.ExpiryDate (built-in variable)
CustomFieldDataType.String (built-in variable)
CustomFieldsResponse.CustomFields (built-in variable)
D
DataType (None attribute)
DeleteDocumentContainerSetRequest.ContainerIdSet (built-in variable)
DeleteDocumentContainerSetResponse.DeletedContainerIds (built-in variable)
DigitalIdentificationSchemeType.DbsBasic (built-in variable)
DigitalIdentificationSchemeType.DbsEnhanced (built-in variable)
DigitalIdentificationSchemeType.DbsStandard (built-in variable)
DigitalIdentificationSchemeType.None (built-in variable)
DigitalIdentificationSchemeType.RightToRent (built-in variable)
DigitalIdentificationSchemeType.RightToWorkDbsBasic (built-in variable)
DigitalIdentificationSchemeType.RightToWorkDbsEnhanced (built-in variable)
DigitalIdentificationSchemeType.RightToWorkDbsStandard (built-in variable)
Document() (class)
Document.AspectRatio (built-in variable)
Document.Audited (built-in variable)
Document.AuditedByUser (built-in variable)
Document.AuditorMessage (built-in variable)
Document.AuditorStatus (built-in variable)
Document.Blacklisted (built-in variable)
Document.BlacklistedAt (built-in variable)
Document.BranchName (built-in variable)
Document.ContainerId (built-in variable)
Document.ContinuedManually (built-in variable)
Document.CreatedAt (built-in variable)
Document.CustomFieldDictionary (built-in variable)
Document.CustomFieldKeys (built-in variable)
Document.CustomFields (global variable or constant)
Document.DetectedOrientation (built-in variable)
Document.DOCUMENT_TYPE_BIOMETRIC_RESIDENCE_PERMIT (global variable or constant)
Document.DOCUMENT_TYPE_DRIVINGLICENCE (global variable or constant)
Document.DOCUMENT_TYPE_IDENTITYCARD (global variable or constant)
Document.DOCUMENT_TYPE_PASSPORT (global variable or constant)
Document.DOCUMENT_TYPE_SUPPORTINGDOCUMENT (global variable or constant)
Document.DOCUMENT_TYPE_VISA (global variable or constant)
Document.DocumentCompleted (built-in variable)
Document.DocumentConfiguration (built-in variable)
Document.DocumentFields (built-in variable)
Document.DocumentId (built-in variable)
Document.DocumentName (built-in variable)
(global variable or constant)
Document.DocumentResultsSummary (built-in variable)
(global variable or constant)
Document.DocumentSubType (built-in variable)
Document.DocumentType (built-in variable)
(global variable or constant)
Document.DocumentValidations (built-in variable)
Document.DocumentVersion (built-in variable)
Document.DrivingLicenceCategory (built-in variable)
Document.Editable (built-in variable)
Document.ExpiryNotification (built-in variable)
Document.ExternalServices (built-in variable)
Document.ExternalServicesQueried (built-in variable)
Document.FEEDBACK_PERSON_MATCHES_NO (global variable or constant)
Document.FEEDBACK_PERSON_MATCHES_NOTSEEN (global variable or constant)
Document.FEEDBACK_PERSON_MATCHES_YES (global variable or constant)
Document.FeedbackFeatures (built-in variable)
Document.FeedbackHasMrz (built-in variable)
Document.FeedbackPersonMatches (built-in variable)
(global variable or constant)
Document.FeedbackRFIDImageMatches (built-in variable)
Document.FIELD_DATE_OF_BIRTH (global variable or constant)
Document.FIELD_DOCUMENT_NUMBER (global variable or constant)
Document.FIELD_EXPIRY_DATE (global variable or constant)
Document.FIELD_FIRSTNAME (global variable or constant)
Document.FIELD_GENDER_CODE (global variable or constant)
Document.FIELD_LASTNAME (global variable or constant)
Document.FIELD_MIDDLENAME (global variable or constant)
Document.GENDER_FEMALE (global variable or constant)
Document.GENDER_MALE (global variable or constant)
Document.GENDER_TRANSGENDER (global variable or constant)
Document.GENDER_UNKNOWN (global variable or constant)
Document.GENDER_UNSPECIFIED (global variable or constant)
Document.GeneralDocumentProperties (built-in variable)
(global variable or constant)
Document.HasError (built-in variable)
Document.HighRiskCountry (built-in variable)
Document.Images (built-in variable)
(global variable or constant)
Document.IssuingAuthority (built-in variable)
Document.IssuingCountry (built-in variable)
Document.KDB (built-in variable)
Document.Locked (built-in variable)
Document.MaxAgeFailed (built-in variable)
Document.MinAgeFailed (built-in variable)
Document.MissingFieldsProperties (built-in variable)
(global variable or constant)
Document.Mrz (built-in variable)
(global variable or constant)
Document.MrzCharacterCount (built-in variable)
(global variable or constant)
Document.MRZCorrected (built-in variable)
Document.MRZCorrectionProvided (built-in variable)
Document.MrzImageType (built-in variable)
Document.MrzLineCount (built-in variable)
(global variable or constant)
Document.MrzSameLength (built-in variable)
(global variable or constant)
Document.MrzValidationProperties (built-in variable)
(global variable or constant)
Document.Nationality (built-in variable)
Document.NoInitialFaceImage (built-in variable)
Document.Notes (built-in variable)
Document.OcrDataApplied (built-in variable)
Document.OcrFieldData (built-in variable)
Document.OperatorMessage (built-in variable)
Document.OperatorStatus (built-in variable)
Document.OriginalMrz (built-in variable)
Document.PartiallyRecognised (built-in variable)
Document.RFIDFailed (built-in variable)
Document.RfidMrz (built-in variable)
Document.RuleDenied (built-in variable)
Document.ScanCounter (built-in variable)
Document.ScannedAt (built-in variable)
Document.ScannerType (built-in variable)
Document.SeenBeforeDocumentContainerId (built-in variable)
Document.SeenBeforeDocumentId (built-in variable)
Document.STATUS_ACCEPTED (global variable or constant)
Document.STATUS_FAILED (global variable or constant)
Document.STATUS_NO_VALIDATION (global variable or constant)
Document.STATUS_REFERRED (global variable or constant)
Document.STATUS_REJECTED (global variable or constant)
Document.STATUS_UNDEFINED (global variable or constant)
Document.SupportingDocumentName (built-in variable)
Document.Unrecognised (built-in variable)
Document.UpdatedAt (built-in variable)
Document.ValidFrom (built-in variable)
Document.ValidLength (built-in variable)
Document.VpeDeviceId (built-in variable)
Document.VpeName (built-in variable)
Document.WizardCompleted (built-in variable)
DocumentConfiguration.DisableExpiredEUDocumentsFailure (built-in variable)
DocumentContainerField.DescriptionText (built-in variable)
DocumentContainerField.DisplayName (built-in variable)
DocumentContainerField.DocumentContainerId (built-in variable)
DocumentContainerField.FieldValueDate (built-in variable)
DocumentContainerField.FieldValueString (built-in variable)
DocumentContainerField.Id (built-in variable)
DocumentContainerField.Name (built-in variable)
DocumentContainerField.Source (built-in variable)
DocumentContainerResponse.Container (built-in variable)
DocumentContainerValidation.ActionsText (built-in variable)
DocumentContainerValidation.DescriptionText (built-in variable)
DocumentContainerValidation.DetailedResult (built-in variable)
DocumentContainerValidation.DisplayName (built-in variable)
DocumentContainerValidation.DocumentContainerId (built-in variable)
DocumentContainerValidation.Id (built-in variable)
DocumentContainerValidation.InformationText (built-in variable)
DocumentContainerValidation.Name (built-in variable)
DocumentContainerValidation.OutcomeCommentText (built-in variable)
DocumentContainerValidation.RefFieldNames (built-in variable)
DocumentContainerValidation.RefFieldNamesAsString (built-in variable)
DocumentContainerValidation.ValidationOutcome (built-in variable)
DocumentContainerValidationOutcome.Attention (built-in variable)
DocumentContainerValidationOutcome.AttentionWithWarning (built-in variable)
DocumentContainerValidationOutcome.Caution (built-in variable)
DocumentContainerValidationOutcome.CautionWithWarning (built-in variable)
DocumentContainerValidationOutcome.Failed (built-in variable)
DocumentContainerValidationOutcome.FailedWithWarning (built-in variable)
DocumentContainerValidationOutcome.Passed (built-in variable)
DocumentContainerValidationOutcome.PassedWithWarning (built-in variable)
DocumentContainerValidationOutcome.Skipped (built-in variable)
DocumentContainerValidationOutcome.SkippedWithWarning (built-in variable)
DocumentContainerValidationOutcome.Unknown (built-in variable)
DocumentContainerValidationOutcome.UnknownWithWarning (built-in variable)
DocumentFeatureFeedback.DocumentFeatureId (built-in variable)
DocumentFeatureFeedback.FeatureType (built-in variable)
DocumentFeatureFeedback.Feedback (built-in variable)
DocumentFeedback.ErrorMessage (built-in variable)
DocumentFeedback.Name (built-in variable)
DocumentFeedback.Value (built-in variable)
DocumentFeedback.ValueUndefined (built-in variable)
DocumentField.DataType (built-in variable)
DocumentField.DescriptionText (built-in variable)
DocumentField.DisplayName (built-in variable)
DocumentField.DocumentId (built-in variable)
DocumentField.FieldValueDate (built-in variable)
DocumentField.FieldValueString (built-in variable)
DocumentField.Id (built-in variable)
DocumentField.ImageType (built-in variable)
DocumentField.Name (built-in variable)
DocumentField.RegionCoordinates (built-in variable)
DocumentField.Reliability (built-in variable)
DocumentField.SourceId (built-in variable)
DocumentFieldDataType.String (built-in variable)
DocumentFieldSource.Hrz (built-in variable)
DocumentFieldSource.Manual (built-in variable)
DocumentFieldSource.Mrz (built-in variable)
DocumentFieldSource.Other (built-in variable)
DocumentFieldSource.Unknown (built-in variable)
DocumentResponse.Document (built-in variable)
DocumentSortingColumn() (class)
DocumentSortingColumn.ApplicantName (built-in variable)
(global variable or constant)
DocumentSortingColumn.DocumentType (built-in variable)
(global variable or constant)
DocumentSortingColumn.ScanDate (built-in variable)
(global variable or constant)
DocumentSource.Image (built-in variable)
DocumentSource.ReviewApplication (built-in variable)
DocumentSource.Scanner (built-in variable)
DocumentSource.TTAImport (built-in variable)
DocumentStatus.Accepted (built-in variable)
DocumentStatus.Failed (built-in variable)
DocumentStatus.NoValidation (built-in variable)
DocumentStatus.Referred (built-in variable)
DocumentStatus.Rejected (built-in variable)
DocumentStatus.Undefined (built-in variable)
DocumentStorageType.Archive (built-in variable)
DocumentStorageType.Holding (built-in variable)
DocumentStorageType.Pending (built-in variable)
DocumentStorageType.Temp (built-in variable)
DocumentStorageType.Workflow (built-in variable)
DocumentType.DrivingLicence (built-in variable)
DocumentType.OnlineCheck (built-in variable)
DocumentType.OnlineRTRCheck (built-in variable)
DocumentType.Passport (built-in variable)
DocumentType.SupportingDocument (built-in variable)
DocumentType.Unrecognised (built-in variable)
DocumentType.Visa (built-in variable)
DocumentTypeChargeStatus() (class)
DocumentTypeChargeStatus.Active (built-in variable)
(global variable or constant)
DocumentTypeChargeStatus.AddedBy (built-in variable)
(global variable or constant)
DocumentTypeChargeStatus.ChargeStatus (built-in variable)
(global variable or constant)
DocumentTypeChargeStatus.DisplayName (built-in variable)
(global variable or constant)
DocumentTypeChargeStatus.DocumentType (built-in variable)
(global variable or constant)
DocumentTypeChargeStatus.DocumentTypeCode (built-in variable)
(global variable or constant)
DocumentTypeChargeStatus.DropDownSectionIndex (built-in variable)
(global variable or constant)
DocumentTypeChargeStatus.Id (built-in variable)
(global variable or constant)
DocumentValidation.ActionsText (built-in variable)
DocumentValidation.DescriptionText (built-in variable)
DocumentValidation.DisplayName (built-in variable)
DocumentValidation.DocumentId (built-in variable)
DocumentValidation.Id (built-in variable)
DocumentValidation.ImageType (built-in variable)
DocumentValidation.InformationText (built-in variable)
DocumentValidation.Name (built-in variable)
DocumentValidation.OutcomeCommentText (built-in variable)
DocumentValidation.RefFieldNames (built-in variable)
DocumentValidation.RegionCoordinates (built-in variable)
DocumentValidation.Result (built-in variable)
DocumentValidationResult.Attention (built-in variable)
DocumentValidationResult.AttentionWithWarning (built-in variable)
DocumentValidationResult.Caution (built-in variable)
DocumentValidationResult.CautionWithWarning (built-in variable)
DocumentValidationResult.Failed (built-in variable)
DocumentValidationResult.FailedWithWarning (built-in variable)
DocumentValidationResult.Passed (built-in variable)
DocumentValidationResult.PassedWithWarning (built-in variable)
DocumentValidationResult.Skipped (built-in variable)
DocumentValidationResult.SkippedWithWarning (built-in variable)
DocumentValidationResult.Unknown (built-in variable)
DocumentValidationResult.UnknownWithWarning (built-in variable)
downloadOnlineCheckRequest.DocumentId (built-in variable)
downloadOnlineCheckResponse.Document (built-in variable)
DownloadPDFRequest.DeviceId (built-in variable)
DownloadPDFRequest.id (built-in variable)
DownloadPDFRequest.SessionId (built-in variable)
E
EstablishedDocumentData.DocumentType (built-in variable)
EstablishedDocumentData.FeedbackHasMrz (built-in variable)
EstablishedDocumentData.IssuingCountryCode (built-in variable)
ExportPDFRequest.ContainerId (built-in variable)
ExternalServiceData.CallerId (built-in variable)
ExternalServiceData.ErrorMessage (built-in variable)
ExternalServiceData.ID (built-in variable)
ExternalServiceData.Match (built-in variable)
ExternalServiceData.MatchedProperties (built-in variable)
ExternalServiceData.Name (built-in variable)
ExternalServiceData.ServiceCalled (built-in variable)
ExternalServiceData.ServiceCallPending (built-in variable)
ExternalServiceData.Success (built-in variable)
ExternalServiceData.Timestamp (built-in variable)
F
FeedbackProperty() (class)
FeedbackProperty.ErrorMessage (FeedbackProperty attribute)
FeedbackProperty.Name (FeedbackProperty attribute)
FeedbackProperty.Value (FeedbackProperty attribute)
FeedbackProperty.ValueUndefined (FeedbackProperty attribute)
FilterDateOption.After (built-in variable)
FilterDateOption.Before (built-in variable)
FilterDateOption.Exact (built-in variable)
FilterDateOption.None (built-in variable)
FlexibleFieldDataType.DateTime (built-in variable)
FlexibleFieldDataType.Decimal (built-in variable)
FlexibleFieldDataType.Enum (built-in variable)
FlexibleFieldDataType.Int (built-in variable)
FlexibleFieldDataType.String (built-in variable)
FlexibleFieldSearchSpecification.__type (built-in variable)
FlexibleFieldSearchSpecification.DateExactMatchList (built-in variable)
FlexibleFieldSearchSpecification.DateRangeList (built-in variable)
FlexibleFieldSearchSpecification.DecimalExactMatchList (built-in variable)
FlexibleFieldSearchSpecification.DecimalRangeList (built-in variable)
FlexibleFieldSearchSpecification.EnumExactMatchList (built-in variable)
FlexibleFieldSearchSpecification.FlexibleFieldId (built-in variable)
FlexibleFieldSearchSpecification.FlexibleFieldName (built-in variable)
FlexibleFieldSearchSpecification.IntExactMatchList (built-in variable)
FlexibleFieldSearchSpecification.IntRangeList (built-in variable)
FlexibleFieldSearchSpecification.StringExactMatchList (built-in variable)
FlexibleFieldSearchSpecification.StringPartialMatchList (built-in variable)
FlexibleFieldSpecificationSearchOperator.AND (built-in variable)
FlexibleFieldSpecificationSearchOperator.OR (built-in variable)
G
Gender.Female (built-in variable)
Gender.Male (built-in variable)
Gender.Transgender (built-in variable)
Gender.Unknown (built-in variable)
Gender.Unspecified (built-in variable)
GetDocumentTypeChargeStatusesResponse.DocumentTypeChargeStatuses (built-in variable)
H
Help (None attribute)
I
Image() (class)
Image.CreatedAt (built-in variable)
Image.CropArea (built-in variable)
Image.DocumentId (built-in variable)
(global variable or constant)
Image.Filename (built-in variable)
Image.Id (built-in variable)
(global variable or constant)
Image.IMAGE_TYPE_BARCODE (global variable or constant)
Image.IMAGE_TYPE_DETECTEDFACE (global variable or constant)
Image.IMAGE_TYPE_DOCUMENT (global variable or constant)
Image.IMAGE_TYPE_DOCUMENTBACK (global variable or constant)
Image.IMAGE_TYPE_DOCUMENTSIDE3 (global variable or constant)
Image.IMAGE_TYPE_DOCUMENTSIDE4 (global variable or constant)
Image.IMAGE_TYPE_FACE (global variable or constant)
Image.IMAGE_TYPE_FINGERPRINT (global variable or constant)
Image.IMAGE_TYPE_INFRARED (global variable or constant)
Image.IMAGE_TYPE_INFRAREDBACK (global variable or constant)
Image.IMAGE_TYPE_INFRAREDSIDE3 (global variable or constant)
Image.IMAGE_TYPE_INFRAREDSIDE4 (global variable or constant)
Image.IMAGE_TYPE_MRZ (global variable or constant)
Image.IMAGE_TYPE_OCR (global variable or constant)
Image.IMAGE_TYPE_ORIGINALDOCUMENT (global variable or constant)
Image.IMAGE_TYPE_ORIGINALDOCUMENTBACK (global variable or constant)
Image.IMAGE_TYPE_RFID (global variable or constant)
Image.IMAGE_TYPE_ULTRAVIOLET (global variable or constant)
Image.IMAGE_TYPE_ULTRAVIOLETBACK (global variable or constant)
Image.IMAGE_TYPE_ULTRAVIOLETSIDE3 (global variable or constant)
Image.IMAGE_TYPE_ULTRAVIOLETSIDE4 (global variable or constant)
Image.IMAGE_TYPE_UNKNOWN (global variable or constant)
Image.ImageSourceId (built-in variable)
(global variable or constant)
Image.ImageType (built-in variable)
(global variable or constant)
Image.Rotation (built-in variable)
ImageOrientation.Clockwise (built-in variable)
ImageOrientation.Counterclockwise (built-in variable)
ImageOrientation.NoRotation (built-in variable)
ImageOrientation.UnknownRotation (built-in variable)
ImageOrientation.Upsidedown (built-in variable)
ImageRequest.DeviceId (built-in variable)
ImageRequest.id (built-in variable)
ImageRequest.SessionId (built-in variable)
ImageType.Barcode (built-in variable)
ImageType.DetectedFace (built-in variable)
ImageType.Document (built-in variable)
ImageType.DocumentBack (built-in variable)
ImageType.DocumentSide3 (built-in variable)
ImageType.DocumentSide4 (built-in variable)
ImageType.Face (built-in variable)
ImageType.Fingerprint (built-in variable)
ImageType.Infrared (built-in variable)
ImageType.InfraredBack (built-in variable)
ImageType.InfraredSide3 (built-in variable)
ImageType.InfraredSide4 (built-in variable)
ImageType.MRZ (built-in variable)
ImageType.OCR (built-in variable)
ImageType.OriginalDocument (built-in variable)
ImageType.OriginalDocumentBack (built-in variable)
ImageType.RFID (built-in variable)
ImageType.Ultraviolet (built-in variable)
ImageType.UltravioletBack (built-in variable)
ImageType.UltravioletSide3 (built-in variable)
ImageType.UltravioletSide4 (built-in variable)
ImageType.Unknown (built-in variable)
Index (None attribute)
K
KDBCountry.Alias1 (built-in variable)
KDBCountry.Alias2 (built-in variable)
KDBCountry.Alias3 (built-in variable)
KDBCountry.AltMrz (built-in variable)
KDBCountry.EU (built-in variable)
KDBCountry.Mrz (built-in variable)
KDBCountry.Name (built-in variable)
KDBCountry.Nationality (built-in variable)
KDBCountry.UK (built-in variable)
KDBDocumentNumber.Default (built-in variable)
KDBDocumentNumber.DrivingLicenseNumber (built-in variable)
KDBDocumentNumber.IdentityCardNumber (built-in variable)
KDBDocumentNumber.PassportNumber (built-in variable)
KDBDocumentNumber.VisaNumber (built-in variable)
KDBDocumentSubType.DocumentType (built-in variable)
KDBDocumentSubType.Id (built-in variable)
KDBDocumentSubType.Mrz (built-in variable)
KDBDocumentSubType.Name (built-in variable)
KDBDocumentSubType.RewriteDocumentNumber (built-in variable)
KDBDocumentSubType.RewriteDocumentType (built-in variable)
KDBFeatureType.ColourVsIR (built-in variable)
KDBFeatureType.FullDocumentComparison (built-in variable)
KDBFeatureType.Hologram (built-in variable)
KDBFeatureType.OCR (built-in variable)
KDBFeatureType.PrimaryFace (built-in variable)
KDBFeatureType.PrimaryFaceAndColourVsIR (built-in variable)
KDBFeatureType.ScannedVsStock (built-in variable)
KDBFeatureType.SecondaryFace (built-in variable)
KDBGetCountriesResponse.Countries (built-in variable)
L
LivenessResultType.Error (built-in variable)
LivenessResultType.FaceAngleTooLarge (built-in variable)
LivenessResultType.FaceNotFound (built-in variable)
LivenessResultType.FaceTooClose (built-in variable)
LivenessResultType.FaceTooSmall (built-in variable)
LivenessResultType.FailedToReadImage (built-in variable)
LivenessResultType.Live (built-in variable)
LivenessResultType.NotLive (built-in variable)
LivenessResultType.PoorImageQuality (built-in variable)
LivenessResultType.Unknown (built-in variable)
LoginRequest.ApiVersionNumber (built-in variable)
LoginRequest.ChangePassword (built-in variable)
LoginRequest.DesktopClient (built-in variable)
LoginRequest.NewPassword (built-in variable)
LoginRequest.Password (built-in variable)
LoginRequest.RequireAdmin (built-in variable)
LoginRequest.Username (built-in variable)
LoginResponse.Branch (built-in variable)
LoginResponse.Configuration (built-in variable)
LoginResponse.DesktopClientDenied (built-in variable)
LoginResponse.IncompatibleServiceVersion (built-in variable)
LoginResponse.LockedUserAccount (built-in variable)
LoginResponse.NewPasswordRequired (built-in variable)
LoginResponse.Organisation (built-in variable)
LoginResponse.RemainingCredits (built-in variable)
LoginResponse.ServerApiVersion (built-in variable)
LoginResponse.SessionId (built-in variable)
LoginResponse.User (built-in variable)
LoginResponse.VpeName (built-in variable)
M
ModelBase() (class)
MrzQueryOption.HasMrz (built-in variable)
MrzQueryOption.NoMrz (built-in variable)
MrzQueryOption.NotValid (built-in variable)
MrzQueryOption.Off (built-in variable)
MrzQueryOption.Valid (built-in variable)
O
OcrCoordinates.Height (built-in variable)
OcrCoordinates.Width (built-in variable)
OcrCoordinates.X (built-in variable)
OcrCoordinates.Y (built-in variable)
OcrField.Address (built-in variable)
OcrField.DateOfBirth (built-in variable)
OcrField.DocumentIssue (built-in variable)
OcrField.DrivingLicenceCategory (built-in variable)
OcrField.ExpiryDate (built-in variable)
OcrField.Firstname (built-in variable)
OcrField.Gender (built-in variable)
OcrField.IdentityCardNumber (built-in variable)
OcrField.IssuingAuthority (built-in variable)
OcrField.IssuingCountry (built-in variable)
OcrField.Lastname (built-in variable)
OcrField.Middlename (built-in variable)
OcrField.Mrz (built-in variable)
OcrField.Nationality (built-in variable)
OcrField.Other (built-in variable)
OcrField.PassportNumber (built-in variable)
OcrField.PersonalNumber (built-in variable)
OcrField.ValidFrom (built-in variable)
OcrField.VisaNumber (built-in variable)
OcrFieldData.Coordinates (built-in variable)
OcrFieldData.Field (built-in variable)
OcrFieldData.Label (built-in variable)
OcrFieldData.Text (built-in variable)
Organisation() (class)
Organisation.Active (built-in variable)
Organisation.Description (built-in variable)
(Organisation attribute)
Organisation.Id (built-in variable)
(Organisation attribute)
Organisation.Name (built-in variable)
(Organisation attribute)
OverallStatus.Alert (built-in variable)
OverallStatus.NoAlert (built-in variable)
OverallStatus.Resolved (built-in variable)
P
PublishDocumentContainerRequest.AutoReferral (built-in variable)
PublishDocumentContainerRequest.CallbackUrl (built-in variable)
PublishDocumentContainerRequest.ContainerId (built-in variable)
PublishDocumentContainerRequest.EstablishedDocumentData (built-in variable)
PublishDocumentContainerRequest.LockAccess (built-in variable)
PublishDocumentContainerRequest.MergeContainers (built-in variable)
PublishDocumentContainerRequest.MergeTargetContainerId (built-in variable)
PublishDocumentContainerRequest.ReplaceContainerId (built-in variable)
PublishDocumentContainerRequest.ReplaceDocumentId (built-in variable)
PublishDocumentContainerRequest.RFIDFailed (built-in variable)
PublishDocumentContainerRequest.WebClientIgnoreOCR (built-in variable)
PublishDocumentContainerRequest.WebClientRequest (built-in variable)
PublishDocumentContainerResponse.AutoReferred (built-in variable)
PublishDocumentContainerResponse.DocumentReplaced (built-in variable)
PublishDocumentContainerResponse.MergeContainers (built-in variable)
PublishDocumentContainerResponse.Merged (built-in variable)
Q
QueryBranchesResponse.Branches (built-in variable)
R
ReferralHistoryRecord.CompletedAt (built-in variable)
ReferralHistoryRecord.ReferralType (built-in variable)
ReferralHistoryRecord.ReferredAt (built-in variable)
ReferralHistoryRecord.ReferredBy (built-in variable)
ReferralHistoryRecord.ReferredTo (built-in variable)
ReferralType.Auto (built-in variable)
ReferralType.MRZ (built-in variable)
ReferralType.Review (built-in variable)
RemainingCredits() (class)
RemainingCredits.Branch (built-in variable)
(RemainingCredits attribute)
RemainingCredits.Organisation (built-in variable)
(RemainingCredits attribute)
Required (None attribute)
RetrieveDocumentContainerRequest.ContainerId (built-in variable)
RetrieveDocumentRequest.ContainerId (built-in variable)
RetrieveDocumentRequest.DocumentId (built-in variable)
RetrieveImageRequest.ImageId (built-in variable)
ReviewApplicationState.AwaitingUpdateFromReviewSystem (built-in variable)
ReviewApplicationState.Locked (built-in variable)
ReviewApplicationState.ReadyForDeletion (built-in variable)
ReviewApplicationState.ReadyForDispatchToCustomerSystem (built-in variable)
ReviewApplicationState.Unset (built-in variable)
S
SortingDirection() (class)
SortingDirection.Ascending (built-in variable)
(global variable or constant)
SortingDirection.Descending (built-in variable)
(global variable or constant)
U
UpdateDocumentContainer.ContainerId (built-in variable)
UploadApplicantPhotoRequest.ContainerId (built-in variable)
UploadApplicantPhotoResponse.ImageId (built-in variable)
UploadImageRequest.ContainerId (built-in variable)
UploadImageRequest.DocumentId (built-in variable)
UploadImageRequest.ImageType (built-in variable)
UploadImageResponse.ImageId (built-in variable)
User() (class)
User.Active (built-in variable)
User.ARCHIVE_VISIBILITY_BRANCH (global variable or constant)
User.ARCHIVE_VISIBILITY_GLOBAL (global variable or constant)
User.ARCHIVE_VISIBILITY_ORGANISATION (global variable or constant)
User.ARCHIVE_VISIBILITY_USER (global variable or constant)
User.ArchiveVisibility (built-in variable)
(User attribute)
User.BranchId (built-in variable)
(User attribute)
User.BranchName (built-in variable)
(User attribute)
User.Description (built-in variable)
(User attribute)
User.Email (built-in variable)
(User attribute)
User.EmailAlertFlags (built-in variable)
(User attribute)
User.FailedPasswordAttemptCount (built-in variable)
(User attribute)
User.Firstname (built-in variable)
(User attribute)
User.Id (built-in variable)
(User attribute)
User.IsLockedOut (built-in variable)
(User attribute)
User.Lastname (built-in variable)
(User attribute)
User.PRIVILEGE_ARCHIVE (global variable or constant)
User.Privileges (built-in variable)
(User attribute)
User.SetInitialPassword (built-in variable)
(User attribute)
User.User.PRIVILEGE_ADMIN (global variable or constant)
User.User.PRIVILEGE_AUDITING (global variable or constant)
User.User.PRIVILEGE_DATA_EXPORT (global variable or constant)
User.User.PRIVILEGE_DELETE (global variable or constant)
User.User.PRIVILEGE_REFERRAL_MRZ (global variable or constant)
User.User.PRIVILEGE_REFERRAL_REVIEWER (global variable or constant)
User.User.PRIVILEGE_SYNC (global variable or constant)
User.Username (built-in variable)
(User attribute)
UserArchiveVisibility.Branch (built-in variable)
UserArchiveVisibility.Global (built-in variable)
UserArchiveVisibility.Organisation (built-in variable)
UserArchiveVisibility.User (built-in variable)
UserReference.DisplayName (built-in variable)
V
Value (None attribute)
Values (None attribute)
W
WorkflowType.AutoReferral (built-in variable)
WorkflowType.Standard (built-in variable)