| Name
| Parent NameSpace
| Description
|
| AuthenticationComRequest |
Communication |
Request body of the the Authentication SDK |
AuthenticationComResponse |
Communication |
Response of the Authentication SDK |
AuthenticationHostDetails |
SDK |
Details on the host version and license status |
AuthenticationHostInvalidVersionException |
Exceptions |
Throws an exception if Host is invalid |
AuthenticationHostMissingException |
Exceptions |
Throws an exception if Host is missing |
Address |
Authentication |
All address details |
AuthenticationResult |
Authentication |
Returns the confidence score of the document and individual scores |
AuthenticationResponse |
Authentication |
Returns details of the completed scan, including the document fields, a unique request ID from the AuthenticationRequest, and the AuthenticationResult. |
AuthenticationRequest |
Authentication |
The request body for the SDK |
AuthenticationProgressInfo |
Authentication |
Authentication progress message |
AuthenticationService |
SDK |
Used to initialize and connect to Authentication host |
AuthenticationServiceSettings |
SDK |
Settings for the directory path and host |
AuthenticationSettings |
Configurations |
Change language, kiosk mode, and other test settings |
AuthenticationTestSettings |
Configurations |
Configure test settings in the SDK for scanners, documents, templates, countries, states, and Scoring |
AuthenticationTestResult |
Authentication |
Returns results of each test in specific orders |
Confidence |
Authentication |
Confidence of each field in document |
CheckHostResponse |
Communication |
Checking for the host response |
CheckHostRequest |
Communication |
Checks for host request |
CrossMatch |
Authentication |
Gathers score for cross match |
CrossMatchValue |
Authentication |
Field value for data source |
DetailsExtensions |
Authentication |
Extension for Details class |
DeviceAuthenticationResponseNotification |
Communication |
Notification for response |
Document |
Authentication |
Document field values |
DocumentDetails |
Authentication |
Details on the series year, issued by, IIN, etc |
DocumentModel |
Authentication |
Available DataSources for document (DataSource.PDF417, DataSource.Rfid , DataSource.MRZ, DataSource.MagStripe, DataSource.Ocr, DataSource.IROcr ) |
ImageAuthenticationData |
Authentication |
The attached image info is necessary for the description of the test result |
ImageDetails |
Authentication |
Details on the image's orientation and angle |
ImageFrame |
Authentication |
Image's axis |
ImageTypeExtensions |
Exception |
License |
InitializationException |
Exception |
Exception type for all errors during ASDK initialization |
LicenseException |
Exception |
License exception warning |
LicenseInfo |
SDK |
Information on the license |
LicenseStatusInfo |
SDK |
Expiration date of license, hardware Id that the license is linked to |
Name |
Authentication |
First, middle, last, and full name |
PlainDocumentModel |
Authentication |
Recognized document fields values from the first available DataSource from the list which is ordered by confidence |
ProcessedInfo |
Authentication |
Processing the results from front, back, and template |
ProcessingError |
SDK |
Error from processing |
ProcessingErrorNotification |
Communication |
Notification for processing error |
ProcessingStatus |
SDK |
Status of where the process is currently at |
ProcessingStatusNotification |
Communication |
Notification for processing errors |
RawData |
Authentication |
Raw data of the string |
ReaderInfo |
Authentication |
Tyoe of scanner, serial number of the scanner, and IsTestingMode |
RfidData |
Authentication |
Rfid data |
ScanResult |
Authentication |
Document to validate |
ScoringValue |
Authentication |
Determines the score value with each field |
Test |
Authentication |
Name, description, unique identifier, and recommended positions of the test |
TestConst |
Authentication |
Authentication test const |
| Name
| Parent Class
| Return Type
| Parameters
| Descriptions
|
| AddProcess |
ChildProcessTracker |
void |
(IntPtr processHandle), (int processId) |
? |
| AddProcess |
ChildProcessTrackerStub |
void |
(IntPtr processHandle), (int processId), (Process process) |
? |
| CheckAuthenticationHostAsync |
AuthenticationService |
AuthenticationHostDetails |
(CancellationToken cancellationToken = default(CancellationToken)) |
Returns Host details(IsConnected, HostVersion, LicenseStatus, DataVersion) |
| CheckFaceAsync |
AuthenticationService |
Task(FaceResponse) |
FaceRequest request, CancellationToken cancellationToken = default(CancellationToken)) |
Checking the face on the image |
| CheckLicenseAsync |
AuthenticationService |
Task(LicenseStatusInfo) |
(LicenseInfo info, CancellationToken cancellationToken = default(CancellationToken)) |
Checking the license of SDK |
| Clone |
AuthenticationSettings |
object |
None |
Creates a new object that is a copy of that instance |
| CopyWithoutPersonalData |
Document |
Document |
None |
Returns data without PII |
| Dispose |
AuthenticationService |
void |
None |
Performs application defined tasks with freeing, releasing, or resetting unmanaged resources |
| GetStatus |
AuthenticationTestSettings |
TestStatus |
(int? Confidence, string templateName, ConfidenceType confidenceName = ConfidenceType.Total) |
Return test status for template and readerType |
| GetImageDetails |
ProcessedInfo |
ImageDetails |
ImageType, imageType |
Details of the image itself |
| InitializeAsync |
AuthenticationService |
Task |
(CancellationToken cancellationToken = default(CancellationToken)) |
Initialize Authentication SDK for (start Host, load Authentication models) |
| isEnabled |
AuthenticationTestSettings |
boolean |
string templateName |
Check test for enable |
| ProcessAsync |
AuthenticationService |
Task(AuthenticationResponse) |
(AuthenticationRequest request, CancellationToken cancellationToken = default(CancellationToken) |
Run Authentication |
| RestartHostAsync |
AuthenticationService |
Task |
(CancellationToken cancellationToken = default(CancellationToken)) |
Restart Host |
| UpdateSettingsAsync |
AuthenticationService |
Task |
(AuthenticationServiceSettings settings,CancellationToken cancellationToken = default(CancellationToken)) |
Update settings and restart host |
| Name
| Type
| Description
|
| Code |
int |
Unique identifier of the test |
| Order |
int |
The recommended position of this test in the list of tests |
| Name |
string |
Name of test |
| Description |
string |
Description of test |
| TestGroup |
TestGroup |
Group of similar tests |
| Type |
AuthenticationTestType |
Test type |
| TestStatus |
TestStatus |
The status of the test: passed, error, failed, skipped |
| RawResponse |
string |
The raw response only for external Authentication |
| Response |
string |
The text response of the test |
| Confidence |
int |
The level of confidence of this test |
| TestEffect |
TestEffect |
The effect of how the test influences the whole document Authentication |
| Weight |
int |
Weight of the test |
| ScoringValues |
List<ScoringValue> |
The correction value for scoring effect |
| ErrorCode |
short |
Error codes |
| Parent |
AuthenticationTestResult |
Parent test |
| CrossMatches |
List<CrossMatch> |
Cross Match field results(The structure is only for cross-match type tests) |
| ImageData |
ImageAuthenticationData |
The attached images are necessary for the description of the test result |
| Limits |
Dictionary<ConfidenceType, int> |
Limits for test from setting |
| ChildTests |
List<AuthenticationTestResult> |
Child tests |
| Name
| Type
| Description
|
| Confidences |
Dictionary<ConfidenceType> |
Dictionary of Confidence scores of each field |
| Enable |
bool |
Is the test enabled |
| Weight |
int |
Weighting of the tests |
| Required |
bool |
Warning-Passed mode - false, Failed-passed - true |
| IsDefault |
bool |
flag for basic settings, not user settings |
| IgnoredTemplates |
List<string> |
List of ignored Templates of the ASDK |
| IgnoredStates |
List<string> |
Ignored States of the ASDK |
| IgnoredCountries |
List<string> |
Ignored Countries of the ASDK |
| WarningTemplates |
List<string> |
Templates that give a warning status for certain tests |
| ScoringValue |
List<ScoringValue> |
Limits for fields |
| EnabledCountries |
List<string> |
List of countries where the test is performed |
| IgnoredDocumentTypes |
List<string> |
Ignored document types of the ASDK |
| IgnoredScanners |
List<string> |
Ignored document types of the ASDK |
| WarningScanners |
List<string> |
Scanners that present a warning to the ASDK |
| Name
| Type
| Description
|
| Abbr3Country |
int |
Confidence score of the respective field |
| AbbrCountry |
int |
Confidence score of the respective field |
| Address |
int |
Confidence score of the respective field |
| City |
int |
Confidence score of the respective field |
| Class |
int |
Confidence score of the respective field |
| Country |
int |
Confidence score of the respective field |
| Dob |
int |
Confidence score of the respective field |
| Document |
int |
Confidence score of the respective field |
| Expires |
int |
Confidence score of the respective field |
| Eyes |
int |
Confidence score of the respective field |
| FamilyName |
int |
Confidence score of the respective field |
| FirstName |
int |
Confidence score of the respective field |
| FullName |
int |
Confidence score of the respective field |
| Gender |
int |
Confidence score of the respective field |
| Hair |
int |
Confidence score of the respective field |
| Height |
int |
Confidence score of the respective field |
| ID |
int |
Confidence score of the respective field |
| IDType |
int |
Confidence score of the respective field |
| Issued |
int |
Confidence score of the respective field |
| MiddleName |
int |
Confidence score of the respective field |
| PostalBox |
int |
Confidence score of the respective field |
| PrivateName |
int |
Confidence score of the respective field |
| State |
int |
Confidence score of the respective field |
| Template |
int |
Confidence score of the respective field |
| Weight |
int |
Confidence score of the respective field |
| Zip |
int |
Confidence score of the respective field |
| Name
| Type
| Description
|
| AvailableSources |
HashSet<DataSource> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Numbers |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| DocumentTypes |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| ExpirationDates |
Dictionary<DataSource, DateTime> |
If document has multiple sources of this respective field, returned in a dictionary format |
| IssuesDates |
Dictionary<DataSource, DateTime> |
If document has multiple sources of this respective field, returned in a dictionary format |
| BirthDates |
Dictionary<DataSource, DateTime> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Names |
Dictionary<DataSource, Name> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Addresses |
Dictionary<DataSource, Address> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Genders |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| EyeColors |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| HairColors |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Heights |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Races |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| WeightsKG |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| WeightsLBS |
Dictionary<DataSource, string> |
If document has multiple sources of this respective field, returned in a dictionary format |
| RealID |
Dictionary<DataSource, bool> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Donor |
Dictionary<DataSource, bool> |
If document has multiple sources of this respective field, returned in a dictionary format |
| DocumentDetails |
Dictionary<DataSource, DocumentDetails> |
If document has multiple sources of this respective field, returned in a dictionary format |
| Name
| Type
| Description
|
| BackDetails |
ImageDetails |
Back side details(Angle,Orientation) |
| FrontDetails |
ImageDetails |
Front side details(Angle,Orientation) |
| isTemplateSupported |
bool |
Field for detecting if ID is supported by ASDK |
| ProccessedImages |
Dictionary<ImageType, byte[]> |
Dictionary of processed images like signature or RealID |
| RawItems |
Dictionary<RawDataSource,RawData> |
RawData of all DataSources |
| ScanInfo |
ScanInfo |
Information about the original set of images |
| SideReversed |
bool |
Deprecated |
| TemplateName |
string |
Document template series as designated by IDScan.net |
| Name in code
| Description
| | AddressAuthentication (16) | This test checks that the address listed on the document exists. |
| AntiSpoofing (17) | This test checks the authenticity of the document. |
| AntiSpoofingBarcode (82001) | This test checks the front of the ID for digital editing |
| AntiSpoofingFace (83001) | This test checks the face for liveness. |
| BackFromScreen (82004) | This test checks the back of the ID for LCD screen spoofing. |
| BadCropDetection (84003) | This test checks the sharpness of the front side. |
| Barcode (60000) | This group of tests contains information about barcode quality |
| BarcodeReadability (60003) | This test checks the readability of the barcode |
| BarCodeSize (9) | This test checks the size of a barcode. |
| BlurDetection (84002) | This test checks the sharpness of the front side. |
| CameraDocumentFace (11) | This test compares the selfie and the photo from the document. |
| CameraRfidFace (12) | This test compares faces from the RFID chip and the selfie. |
| CheckProportions (84004) | This test checks the proportions of the front side. |
| CosmeticEhancement (83003) | This test detects Cosmetic Enhancements, |
| CrossMatch (4) | This test compares data from the barcode to the document data on the front |
| CrossMatchStatus (20000) | This test aggregates information about the OCR tests |
| Donor (7) | This test checks for the presence of a Donor symbol. |
| DocumentData (3) | This aggregate test checks the format of all data fields of the document |
| FaceAnalysis (50009) | This test analyzes the face from the documentRfidPresence |
| FaceLiveness (83002) | This test checks the face for liveness |
| FieldsDetection (84006) | This test checks that the document has all the required fields. |
| FrontFromScreen (81004) | This test checks the front of the ID for LCD screen spoofing. |
| FrontFaceTampering (81005) | This test checks the face on the document for forgery. |
| FrontFaceTamperingByUV (81010) | This test checks for the correct UV markings over the face. |
| FrontFaceTamperingWholeDocument (81006) | This test checks the face on the document for forgery. |
| FrontFaceTamperingWithCrop (81007) | This test checks the face on the document for forgery. |
| FrontFaceTamperingWithCrop2 (81009) | This test checks the face on the document for forgery. |
| GlareDetection (84005) | This test checks the glareness of the front side. |
| IDData (1000) | This combined test checks the format of all data fields in the document |
| IDPhoto (50010) | This test checks that the photo is acceptable according to ISO/IEC 19794-5 standard. |
| ImagesQuality (84001) | This test checks the quality of the images. |
| IR (40000) | This group of tests contains information about all performed IR tests |
| IRBinarization (8) | This test checks for the presence of an IR mark. |
| IRBarcode (40005) | This test checks the presence of the barcode on the IR |
| IRFace (40004) | This test checks the presence of the face on the IR. |
| IRMark (1) | This test checks for the presence of an IR mark |
| IrOCR (10) | This test compares OCR (Optical Character Recognition) text to IR (infrared) OCR text. |
| MagStripeData (72000) | This combined test checks the format of all data fields in the documents MagStripe. |
| Miscellaneous (50000) | This group of tests contains all miscellaneous tests about the document |
| MiscellaneousTest (50100) | Miscellaneous Test |
| MRZalignment (60050) | This test checks the alignment in the MRZ zone. All letters must be strictly aligned. |
| MRZData (71000) | This combined test checks the format of all data fields in the documents MRZ |
| OCRData (20002) | This combined test checks the format of all fields in the documents |
| PersonAuthenticity (83000) | These tests verify that the person on camera is real and can follow simple prompts. |
| PhotoshopBack (82002) | This test checks the back of the ID for digital editing. |
| PhotoshopFront (82002) | This test checks the front of the ID for digital editing. |
| RealID (6) | This test checks for the presence of a Real ID symbol. |
| ReprintBack (82003) | This test checks reprints at the back side |
| ReprintFront (81003) | This test checks reprints at the front side |
| RfidCrossMatch (15) | This test checks the data from the RFID. |
| RFIDData (50060) | This combined test checks the format of all data fields in the documents RFID |
| RfidDocumentFace (13) | This test compares faces from RFID and the passport data page. |
| RfidPresence (50051) | This test checks the presence of RFID |
| ScanQuality (84000) | These tests check the overall quality of the scanned images |
| SpoofingBack (82000) | These tests verify the authenticity of the back side of the document |
| SpoofingDeepFake (81008) | This test checks the face on the document for deepfake. |
| SpoofingFront (81000) | These tests verify the authenticity of the front side of the document. |
| Template (100) | This test compares the series template data from the barcode with the appearance of the document |
| TemplateMatch (5) | This test compares the series template from the code to the standard document format. |
| UV (30000) | This group of tests contains information about all the performed UV tests |
| UVMark (0) | This test checks the exact form and position of the UV mark on the front side of the document |
| UvByFeatureVector (14) | This test checks for the presence of a UV mark. |
| VoidMark (2) | This test checks if the document has been invalidated |
| Name in code
| Description
| | Disabled (-1) | The test has been disabled in the Authentication Settings. |
| Error (4) | error while running the test |
| Failed (0) | The test has been determined to fail authentication checks |
| Passed (1) | The test has passed authentication checks |
| Skipped (2) | The test has been skipped (e.g., images not provided or not supported). |
| Unlicensed (5) | The client�s machine does not have the IDScan.net license installed correctly/at all. |
| Warning (3) | The test can be potentially valid |