Acu Fill Web Services Programmers Guide

AcuFill_WebServicesProgrammersGuide

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 65

AcuFill Web Services
Programmer’s Guide
March 2018
Copyright © 2003-2018 Acuant Inc. All rights reserved.
This document contains proprietary and confidential technology, information, and creative works owned by
Acuant and its respective licensors, if any. Any use, copying, publication, distribution, display, modification, or
transmission of such information, in whole or in part, in any form or by any means, without the prior express
written permission of Acuant, is strictly prohibited. Except where expressly provided by Acuant in writing,
possession of this information shall not be construed to confer any license or rights under any Acuant intellectual
property rights, whether by estoppel, implication, or otherwise.
AssureID and i-Dentify are trademarks of Acuant Inc. Other Acuant product or service names or logos referenced
this document are either trademarks or registered trademarks of Acuant.
All 3M trademarks are trademarks of 3M Company.
Windows® is a registered trademark of Microsoft Corporation.
Certain product, service, or company designations for companies other than Acuant may be mentioned in this
document for identification purposes only. Such designations are often claimed as trademarks or service marks. In
all instances where Acuant is aware of a claim, the designation appears in initial capital or all capital letters.
However, you should contact the appropriate companies for more complete information regarding such
designations and their registration status.
March 2018
Acuant Inc.
6080 Center Drive
Suite 850
Los Angeles, CA 90045
Contents
AcuFill Web Services Programmer’s Guide iii
Contents
Overview ................................................................................................... 1
Data Center Security ................................................................................. 1
Transmission and Network Security .......................................................... 2
Security Audits .......................................................................................... 2
Image Requirements ................................................................................. 3
Methods .................................................................................................... 4
GetLicenseDetails method .......................................................................... 5
ProcessDLDuplex method ........................................................................... 7
ProcessDriversLicense method .................................................................. 14
ProcessMedInsuranceCard method ............................................................. 21
ProcessPassport method ........................................................................... 25
IdentityVerification method ....................................................................... 29
KBA method ........................................................................................... 32
SubmitQuiz method ................................................................................. 35
WatchList method .................................................................................... 37
GetDLData method .................................................................................. 39
GetMedInsuranceData method .................................................................. 43
FacialMatch method ................................................................................. 46
TransactionResult method ........................................................................ 47
Error Codes and Error Descriptions ......................................................... 49
Response Code Authorizations .................................................................. 49
Response Codes ...................................................................................... 50
Get Response Codes ................................................................................ 51
Barcode Response Codes .......................................................................... 51
Passport Response Codes ......................................................................... 51
Medical Card Response Codes ................................................................... 52
Reformat Image Response Codes .............................................................. 52
Registration Error Codes ........................................................................... 53
Validation Error Codes .............................................................................. 53
Web Response Codes ............................................................................... 54
ContentsGetLicenseDetails method
iv AcuFill Web Services Programmer’s Guide
License Key Activation Descriptions ........................................................... 56
New License Key Error Descriptions ........................................................... 56
KBA Error Code Descriptions ..................................................................... 56
HTTP Error Code Descriptions .................................................................... 57
Appendix A: AssureID Authentication ..................................................... 58
Authentication Test Descriptions ................................................................ 58
Authentication results .............................................................................. 60
Evaluating authentication results .......................................................... 60
Overview
AcuFill Web Services Programmer’s Guide 1
Overview
AcuFill Web Services is a Software as a Service (SaaS) solution which is designed to simplify your
development efforts. Web Services supports data extraction from driver’s licenses, state IDs, other
government issued IDs, custom IDs, driver’s license barcodes, passports, and medical insurance cards. It
also supports document authentication and facial recognition to verify and authenticate the identity.
This document contains a detailed description of the functions that developers need to integrate with
AcuFill Web Services.
Note You must have a valid license key in order to execute any Web Services method. Contact
sales@acuantcorp.com to obtain a license key.
For IDs and Driver's Licenses from Asia, Australia, Europe, South America, and Africa, we return the date
fields in dd-mm-yyyy or dd-mm-yy format. For IDs and Driver's Licenses from United States and Canada,
we return the date fields in mm-dd-yyyy or mm-dd-yy format. For a complete list of regions, states, and
countries supported for ID processing, please refer to the ScanW document available at:
http://www.id-reader.com/ftp/applications/sdk/docs/ScanW.pdf.
For Passports of all the regions, we return the date fields in mm-dd-yyyy or mm-dd-yy format.
Data Center Security
Acuant has partnered with Amazon Web Services (AWS) to offer a highly reliable and scalable
infrastructure platform in the cloud. AWS’s world-class, highly secure data centers utilize state-of-the art
electronic surveillance and multi-factor access control systems. Data centers, located in US., Europe,
Brazil, Singapore, Japan, and Australia, are staffed 24x7 by trained security guards, and access is
authorized strictly on a least privileged basis.
AWS has achieved ISO 27001 certification and has been validated as a Level 1 service provider under the
Payment Card Industry (PCI) Data Security Standard (DSS). AWS undergo annual SOC 1 audits and have
been successfully evaluated at the Moderate level for Federal government systems as well as DIACAP
Level 2 for DoD systems. Each certification means that an auditor has verified that specific security
controls are in place and operating as intended.
Transmission and Network Security
2 AcuFill Web Services Programmer’s Guide
Transmission and Network Security
In addition to AWS’s cloud infrastructure security, Acuant has implemented numerous security protocols
to further enhance the overall security of its Web Services:
All data transmissions are secured via SSL and HTTPS AES 256-bit encryption to ensure the
highest level of security.
No data and/or images are stored on the servers. Images reported by the customers for
support are stored in an encrypted repository.
All network traffic is controlled by a firewall; access to Web Services is only allowed on
specific ports.
Access to Acuant’s Web Services is restricted to users with a valid license key.
Access to the cloud infrastructure is restricted with a 2-step authentication.
Prevention against malicious attacks including DoS, DDoS, MITM, IP Spoofing, and Packet
sniffing by other tenants have been also implemented.
Acuant is certified as Safe Harbor Compliant.
Security Audits
Acuant has developed a comprehensive 24x7 monitoring system to insure the health of the network,
database and application availability. The monitoring system alerts appropriate staff for immediate
action when a threat is detected. Our security team undertakes frequent testing of the system for
security vulnerabilities. Appropriate groups are notified if a threat is found. The security group then
oversees the changes made to resolve the security issue.
Image Requirements
AcuFill Web Services Programmer’s Guide 3
Image Requirements
The following list contains the minimum requirements for submitting images to AcuFill Web Services
for processing:
Color images only
If you are using a scanner to capture the images, please capture cropped 300 dpi images of
IDs (front side only), passports, and medical insurance cards.
600 dpi image is required if you are capturing both front and back side images of the IDs.
If you are using a mobile device or any camera- based device, make sure to use a minimum of
5 Megapixel camera to capture the images for AcuFill and 8 Megapixel camera for AssureID.
The ID image should cover 80% of the overall image.
Make sure images are not blurry and there is no glare, shadow, or holographic reflection on
the images.
AcuFill Web Services supports cropping of uncropped images. See the Web Services methods to learn
how to enable cropping.
If you are sending cropped images, use the following recommended sizes:
*Height adjusted to aspect ratio
Make sure images are not blurry and there are no glare, shadow, or holographic reflection on the images.
Cropped sample images for development are located at:
https://www.dropbox.com/s/4sq6rglpesx81w4/Sample_Images.zip?dl=0
Document
Pixel width*
Driver’s License/ID
1250 (AcuFill) | 2024 (AssureID)
Insurance Card
1500
Passport
1478
Methods
4 AcuFill Web Services Programmer’s Guide
Methods
This section describes the following methods:
GetLicenseDetails method
ProcessDLDuplex method
ProcessDriversLicense method
ProcessMedInsuranceCard method
ProcessPassport method
IdentityVerification method
KBA method
SubmitQuiz method
WatchList method
GetDLData method
GetMedInsuranceData method
FacialMatch method
TransactionResult method
GetLicenseDetails method
AcuFill Web Services Programmer’s Guide 5
GetLicenseDetails method
Gets details about the license key
For License key details, see the following:
Web: http://acuantwebapps.com/Licensing/GetLicenseDetails.htm
URL: https://cssnwebservices.com/CSSNService/CardProcessor/GetLicenseDetails
Help page: https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/GetLicenseDetails
Parameters
Output parameter
Description
AccountStatus
Indicates whether the account is active
Values: True (account is active) | False
(account is disabled)
AddressVerification
Indicates whether address verification is enabled
Values: True | False
AssureIDAllowed
Indicates whether AssureID document
authentication is enabled. Values: True | False
AssureIDProcesses
Specifies the total AssureID document
authentication processes over a month’s time
BarcodeAllowed
Indicates whether barcode processing is allowed
Values: True | False
BarcodeProcesses
Specifies the total barcode processes over
a month’s time
CompanyName
Company name associated with the license key
CustomerName
Customer name associated with the account
DriversLicenseAllowed
Indicates whether Driver’s license processing is
allowed. Values: True | False
DriversLicenseProcesses
Total driver’s license processes over a
month’s time
Input parameter
Data type
Description
LicenseKey
String
Sets the license key (provided by Acuant) in the
header of the HTTPS request.
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
6 AcuFill Web Services Programmer’s Guide
Output parameter
Description
Email
Email address associated with the license key
InsuranceAllowed
Indicates whether medical insurance card
processing is allowed. Values: True | False
InsuranceProcesses
Total medical insurance card processes in
a month
IsLicenseKeyActivated
Indicates whether a license key is active
Values: True | False
PassportAllowed
Indicates whether passport processing is allowed
Values: True | False
PassportProcesses
Total passport processes in a month
ResponseCodeAuthorization
See error codes and error descriptions
ResponseMessageAuthorization
See error codes and error descriptions
SoftwareProvider
See error codes and error descriptions
WebResponseCode
See error codes and error descriptions
WebResponseDescription
See error codes and error descriptions
ProcessDLDuplex method
AcuFill Web Services Programmer’s Guide 7
ProcessDLDuplex method
Processes both front and back side of a driver’s license
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/ProcessDLDuplex/{REGIONSET}/{AUTODETECT
STATE}/{PROCSTATE}/{GETFACEIMAGE}/{GETSIGNIMAGE}/{REFORMATIMAGE}/{REFORMATIMAGECOLOR
}/{REFORMATIMAGEDPI}/{IMAGESOURCE}/{PREPROCIMAGE}/{WIDECHARACTERS}/{LOGTRANSACTION}
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/DLDuplex_x0020_with_x0020
_image_x0020_source_x002C__x0020_pre-processing_x002C__x0020_wide_x0020_characters_
x0020_and_x0020_log_x0020_transaction
Parameters
Input parameter
Data type
Description
LicenseKey
String
Sets the license key (provided by Acuant) in the
header of the HTTPS request.
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
Images
Front and back images of the ID
Note: See the sample code for information about
passing the images to Web Services.
RegionSet
Integer
Integer parameter of the region
Values:
0
United States
4
Australia
5
Asia
1
Canada
2
America
3
Europe
7
Africa
6
General Documents
AutoDetectState
Boolean
Indicates whether Web Services will auto detect
the state of the ID. Values: True | False (will use the
value of ProcState integer)
ProcessDLDuplex method
8 AcuFill Web Services Programmer’s Guide
Input parameter
Data type
Description
ProcState
Integer
Integer value of the state to which ID belongs
1. If AutoDetectState is True, Web Services will
automatically detect the state of the ID and
ProcState value will be ignored.
2. If AutoDetectState is False, Web Services will
use ProcState integer value for processing.
Note: For a complete list of the different countries
supported by Web Services and their different
State integer values, see the ScanW document:
http://www.id-reader.com/
ftp/applications/sdk/docs/ScanW.pdf
GetFaceImage
Boolean
Indicates whether to return the face image from
the ID. Values: True | False
GetSignImage
Boolean
Indicates whether to return the signature image
from the ID. Values: True | False
ReformatImage
Boolean
Indicates whether Web Services will return the
reformatted image from the ID
Values: True | False
ReformatImageColor
Integer
Integer value that specifies the color value of the
reformatted image
Values: 0 | 1
0
Image same color
1
Black and White
ReformatImageDpi
Integer
Integer that indicates what dpi value (up to 600 dpi)
to reformat the image
Note: The size of the image is dependent on the dpi
value; a lower value (150 dpi) is recommended to
obtain a smaller image.
ProcessDLDuplex method
AcuFill Web Services Programmer’s Guide 9
Input parameter
Data type
Description
ImageSource
Integer
Specifies the source of the image
Note: See the Image Requirements section for
recommended values.
101
Cropped image from a mobile camera or any
other camera
Note: Image should be 1250 pixels (width and
height based on aspect ratio).
102
Cropped 300 dpi or 600 dpi image from
ScanShell scanner or any TWAIN scanner
Note: If an uncropped image is sent, then
specify CropImage as True in the API call.
103
Cropped 300 dpi or 600 dpi image from a
SnapShell scanner
105
Miscellaneous. Specify this value if you want
the AcuFill Web Services to resize the image
for optimal processing. This value works with
both CropImage True or False.
Note: If ImageSource value is not specified and the
input cropped image is not 300 dpi or 600 dpi, then
Web Services will resize the input image to 300 dpi
and 1250 pixels wide for optimal processing.
PreProcImage
Boolean
Indicates whether to crop the input image
Values: True | False
WideCharacters
Boolean
Indicates whether to enable diacritics
Values: True | False
LogTransaction
Boolean
Set this to true if you want to save the transaction
and retrieve it later from Acuant web services.
Values: True | False
Output parameter
Data type
Description
Address
String
Address field on the ID
Address2
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address3
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address4
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address5
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address6
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
ProcessDLDuplex method
10 AcuFill Web Services Programmer’s Guide
Output parameter
Data type
Description
ReformattedImageTwo
Byte
Back image of the ID
FaceImage
Byte
Face picture on the ID
ReformattedImage
Byte
Front image of the ID
SignImage
Byte
Signature name field on the ID
City
String
City field on in the ID
Class
String
Class field on the ID
CountryShort
String
Three-letter country codes as per ISO 3166-1
alpha-3 codes
County
String
County field on the ID
DateOfBirth
String
Date of birth field on the ID with yy year format
DateOfBirth4
String
Date of birth field on the ID with yyyy year
format
DateOfBirthLocal
String
Date of birth local field on the ID
DocType
String
Acuant internal field. For internal use only.
Endorsements
String
Endorsements field on the ID
ExpirationDate
String
Expiration date field on the ID in yy year format
ExpirationDate4
String
Expiration date field on the ID in yyyy year format
Eyes
String
Eyes field on the ID
FatherName
String
Father’s name field on the ID
Fee
String
Fee field on the ID
Hair
String
Hair field on the ID
Height
String
Height field on the ID
Id
String
ID number field on the ID
IdCountry
String
Full country name field
IsBarcodeRead
Boolean
Indicates whether the barcode on the back side
of the ID could be read. Values: True | False
IsOcrRead
String
Indicates whether the front side of the ID could
be processed. Values: True | False
IssueDate
String
Issue date field on the ID with yy year format
IssueDate4
String
Issue date field on the ID in yyyy year format
IssueDateLocal
String
Issue date local field on the ID
MotherName
String
Mother name field on the ID
NameFirst
String
First name field on the ID
NameFirst_NonMRZ
String
First name field on the ID (not MRZ line) **
ProcessDLDuplex method
AcuFill Web Services Programmer’s Guide 11
Output parameter
Data type
Description
NameLast
String
Last name field on the ID
NameLast1
String
Additional last names field on the ID
NameLast2
String
Additional last names field on the ID
NameLast_NonMRZ
String
Last name field on the ID (not MRZ line) **
NameMiddle
String
Middle name field on the ID
NameMiddle_NonMRZ
String
Middle name field on the ID (not MRZ line) **
NameSuffix
String
Name suffix field on the ID
NameSuffix_NonMRZ
String
Name suffix field on the ID (not MRZ line) **
Nationality
String
Nationality field on the ID
Original
String
Original field on the ID
PlaceOfBirth
String
Place of birth field on the ID
PlaceOfIssue
String
Place of issue field on the ID
Restriction
String
Restriction field on the ID
Results2D
Integer
Acuant internal field. For internal use only.
Sex
String
Sex (Gender) field on the ID
SigNum
String
SigNum field on the ID
SocialSecurity
String
Social Security number field on the ID
State
String
State field on the ID
Text1
String
Additional data fields
Text2
String
Additional data fields
Text3
String
Additional data fields
Type
String
Type field on the ID
Weight
String
Weight field on the ID
Zip
String
Zip field on the ID
license
String
License number field on the ID
CSC
String
CSC field on the ID
Audit
String
Audit field on the ID
CardType
String
Type of card mentioned on the ID
Note: Only available for few states in the U.S.
ProcessDLDuplex method
12 AcuFill Web Services Programmer’s Guide
Output parameter
Data type
Description
TemplateType
String
Type of template. Values:
▪ Not Set
▪ ID
▪ DL
▪ Passport
▪ Club
▪ Military
▪ Member
▪ Resident Permit
▪ Visa
▪ Employee
▪ DVLA
▪ Gun License
▪ Social Security
▪ ID/DL
▪ Professional Regulation Commission
▪ Unified Multi-Purpose ID
▪ Travel Document
▪ Sex Offender
▪ Photo Card
▪ Biometric Passport
▪ Biometric ID
DocumentDetectedName
String
State of issue of the ID
DocumentDetectedNameShort
String
Two-letter state code of the issue state of the ID
AuthenticationResult
String
Authentication result. Values:
▪ Passed
▪ Failed
▪ Attention
▪ Unknown
See Appendix A: AssureID Authentication for
more information about authentication results.
AuthenticationResultSummary
String
If the AuthenticationResult is Attention or
Unknown, then AuthenticationResultSummary
may contain the summary of reasons for the
authentication result. See Appendix A: AssureID
Authentication for more information about
authentication results.
GetTransactionId
String
Transaction ID
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ProcessDLDuplex method
AcuFill Web Services Programmer’s Guide 13
Output parameter
Data type
Description
ResponseCodeAutoDetectState
Integer
If the value is equal or greater than 0 and you
would like to know the state of the ID detected,
match the value against the Document/State ID
values listed in the ScanW document:
http://www.id-reader.com/ftp/applications/
sdk/docs/ScanW.pdf
State definitions are also available
ResponseCodeAutoDetectStateDesc
String
See error codes and error descriptions
ResponseCodeGetFaceImage
Integer
See error codes and error descriptions
ResponseCodeGetFaceImageDesc
String
See error codes and error descriptions
ResponseCodeGetSignImage
Integer
See error codes and error descriptions
ResponseCodeGetSignImageDesc
String
See error codes and error descriptions
ResponseCodeProcState
Integer
See error codes and error descriptions
ResponseCodeProcStateDesc
String
See error codes and error descriptions
ResponseCodeReformatImage
Integer
See error codes and error descriptions
ResponseCodeReformatImageDesc
String
See error codes and error descriptions
ResponseCodeReformatImageTwo
Integer
See error codes and error descriptions
ResponseCodeReformatImageTwoDesc
String
See error codes and error descriptions
ResponseCodeRegionSet
Integer
See error codes and error descriptions
ResponseCodeRegionSetDesc
String
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
* Not applicable to U.S., Canadian, and Australian IDs
ProcessDriversLicense method
14 AcuFill Web Services Programmer’s Guide
ProcessDriversLicense method
Processes front side only of the driver’s license
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/ProcessDriversLicense/{REGIONSET}/{AUTODE
TECTSTATE}/{PROCSTATE}/{GETFACEIMAGE}/{GETSIGNIMAGE}/{REFORMATIMAGE}/{REFORMATIMAGEC
OLOR}/{REFORMATIMAGEDPI}/{PREPROCIMAGE}/{IMAGESOURCE}/{WIDECHARACTERS}/{LOGTRANSACTI
ON}
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/DL_x0020_with_x0020_prepr
ocessing_x002C__x0020_image_x0020_source_x002C__x0020_wide_x0020_characters_x0020_and_x00
20_log_x0020_transaction
Parameters
Input parameters
Data type
Description
LicenseKey
String
License key provided by Acuant
Set license key in the header of the HTTPS request:
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
Images
Front and back images of the ID. See the sample
code on how to pass the images to Web Services.
RegionSet
Integer
Integer parameter of the region
Values:
0
United States
4
Australia
5
Asia
1
Canada
2
America
3
Europe
7
Africa
6
General Documents
AutoDetectState
Boolean
Indicates whether Web Services will auto detect
the state of the ID. Values: True | False (will use the
value of ProcState integer)
ProcessDriversLicense method
AcuFill Web Services Programmer’s Guide 15
Input parameters
Data type
Description
ProcState
Integer
Integer value of the state to which ID belongs
3. If AutoDetectState is True, Web Services will
automatically detect the state of the ID and
ProcState value will be ignored.
4. If AutoDetectState is False, Web Services will
use ProcState integer value for processing.
Note: For a complete list of the different countries
supported by Web Services and their different
State integer values, see the ScanW document:
http://www.id-reader.com/ftp/
applications/sdk/docs/ScanW.pdf
GetFaceImage
Boolean
Indicates whether Web Services returns the face
image from the ID. Values: True | False
GetSignImage
Boolean
Indicates whether Web Services returns the
signature image from the ID. Values: True | False
ReformatImage
Boolean
Indicates whether Web Services returns the
reformatted image from the ID. Values: True | False
ReformatImageColor
Integer
Integer value that specifies the color value of the
reformatted image. Values:
0
Image same color
1
Black and White
ReformatImageDpi
Integer
Integer that indicates what dpi value (up to 600 dpi)
to reformat the image
Note: The size of the image is dependent on the dpi
value; a lower value (150 dpi) is recommended to
obtain a smaller image.
PreProcImage
Boolean
Indicates whether to crop the input image
Values: True | False
ProcessDriversLicense method
16 AcuFill Web Services Programmer’s Guide
Input parameters
Data type
Description
ImageSource
Integer
Specifies the source of the image
Note: See the Image Requirements section for
recommended values.
101
Cropped image from a mobile camera or any
other camera. Image should be 1250 pixels
(width and height based on aspect ratio).
102
Cropped 300 dpi or 600 dpi image from
ScanShell scanner or any TWAIN scanner
Note: If uncropped image is sent, then specify
CropImage as True in the API call.
103
Cropped 300 dpi or 600 dpi image from the
SnapShell scanner
105
Miscellaneous. Specify this value if you want
AcuFill Web Services to resize the image for
optimal processing. This value works with
both CropImage True or False.
Note If ImageSource value is not specified and the input
cropped image is not 300 dpi or 600 dpi, then
Web Service will resize the input image to 300 dpi
and 1250 pixels wide for optimal processing.
WideCharacters
Boolean
Indicates whether to enable diacritics
Values: True | False
LogTransaction
Boolean
Set this to true if you want to save the transaction
and retrieve it later from Acuant web services.
Values: True | False
Output parameters
Data type
Description
Address
String
Address on the ID
Address2
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address3
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address4
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address5
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
Address6
String
Populated when address on the ID has multiple
lines, especially IDs in Asia*
FaceImage
Byte
Face picture on the ID
ReformattedImage
Byte
Front image on the ID
ProcessDriversLicense method
AcuFill Web Services Programmer’s Guide 17
Output parameters
Data type
Description
SignImage
Byte
Signature name field on the ID
City
String
City field on in the ID
Class
String
Class field on the ID
CountryShort
String
Three-letter country codes as per ISO 3166-1
alpha-3 codes
County
String
County field on the ID
DateOfBirth
String
Date of birth field on the ID with yy year format
DateOfBirth4
String
Date of birth field on the ID with yyyy year
format
DateOfBirthLocal
String
Date of birth local field on the ID
DocType
String
Acuant internal field. For internal use only.
Endorsements
String
Endorsements field on the ID
ExpirationDate
String
Expiration date field on the ID with yy year
format
ExpirationDate4
String
Expiration date field on the ID with yyyy year
format
Eyes
String
Eyes field on the ID
FatherName
String
Father name field on the ID
Fee
String
Fee field on the ID
Hair
String
Hair field on the ID
Height
String
Height field on the ID
Id
String
ID number field on the ID
IdCountry
String
Full country name
IssueDate
String
Issue date field on the ID with yy year format
IssueDate4
String
Issue date field on the ID with yyyy year format
IssueDateLocal
String
Issue date local field on the ID
MotherName
String
Mother name field on the ID
NameFirst
String
First name field on the ID
NameFirst_NonMRZ
String
First name field on the ID (not MRZ line) **
NameLast
String
Last name field on the ID
ProcessDriversLicense method
18 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
NameLast1
String
Additional last names on the ID
NameLast2
String
Additional last names on the ID
NameLast_NonMRZ
String
Last name field on the ID (not MRZ line)**
NameMiddle
String
Middle name field on the ID
NameMiddle_NonMRZ
String
Middle name field on the ID (not MRZ line)**
NameSuffix
String
Name suffix field on the ID
NameSuffix_NonMRZ
String
Name suffix field on the ID (not MRZ line)**
Nationality
String
Nationality field on the ID
Original
String
Original field on the ID
PlaceOfBirth
String
Place of birth field on the ID
PlaceOfIssue
String
Place of issue field on the ID
Restriction
String
Restriction field on the ID
Sex
String
Sex (Gender) field on the ID
SigNum
String
SigNum field on the ID
SocialSecurity
String
Social Security number field on the ID
State
String
State field on the ID
Text1
String
Additional data fields
Text2
String
Additional data fields
Text3
String
Additional data fields
Type
String
Type field on the ID
Weight
String
Weight field on the ID
Zip
String
Zip field on the ID
license
String
License number field on the ID
CSC
String
CSC field on the ID
Audit
String
Audit field on the ID
CardType
String
Type of card mentioned on the ID
Note: Only available for few states in the U.S.
ProcessDriversLicense method
AcuFill Web Services Programmer’s Guide 19
Output parameters
Data type
Description
TemplateType
String
Type of template
Values:
5. Not Set
6. ID
7. DL
8. Passport
9. Club
10. Military
11. Member
12. Resident Permit
13. Visa
14. Employee
15. DVLA
16. Gun License
17. Social Security
18. ID/DL
19. Professional Regulation Commission
20. Unified Multi-Purpose ID
21. Travel Document
22. Sex Offender
23. Photo Card
24. Biometric Passport
25. Biometric ID
DocumentDetectedName
String
State of issue of the ID
AuthenticationResult
String
Authentication result
Values:
26. Passed
27. Failed
28. Attention
29. Unknown
See Appendix A: AssureID Authentication for
more information about authentication results.
AuthenticationResultSummary
List
If AuthenticationResult is Attention or
Unknown, then AuthenticationResultSummary
may contain the summary of reasons for the
authentication result. See Appendix A: AssureID
Authentication for more information about
authentication results.
GetTransactionId
String
Transaction ID
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ProcessDriversLicense method
20 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
ResponseCodeAutoDetectState
Integer
If the value is equal or greater than 0 and you
would like to know the state of the ID detected,
please match the value against the
Document/State ID values described in the
ScanW document: http://www.id-
reader.com/ftp/
applications/sdk/docs/ScanW.pdf.
State definitions are also available
See error codes and error descriptions
ResponseCodeAutoDetectStateDesc
String
See error codes and error descriptions
ResponseCodeGetFaceImage
Integer
See error codes and error descriptions
ResponseCodeGetFaceImageDesc
String
See error codes and error descriptions
ResponseCodeGetSignImage
Integer
See error codes and error descriptions
ResponseCodeGetSignImageDesc
String
See error codes and error descriptions
ResponseCodeProcState
Integer
See error codes and error descriptions
ResponseCodeProcStateDesc
String
See error codes and error descriptions
ResponseCodeReformatImage
Integer
See error codes and error descriptions
ResponseCodeReformatImageDesc
String
See error codes and error descriptions
ResponseCodeRegionSet
Integer
See error codes and error descriptions
ResponseCodeRegionSetDesc
String
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
*Not applicable to U.S., Canadian, and Australian IDs
** Valid only for IDs which have an MRZ line, such as European IDs
ProcessMedInsuranceCard method
AcuFill Web Services Programmer’s Guide 21
ProcessMedInsuranceCard method
Processes medical insurance cards
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/ProcessMedInsuranceCard/{REFORM
ATIMAGE}/{REFORMATIMAGECOLOR}/{REFORMATIMAGEDPI}/{PREPROCIMAGE}/{LOGTRANSAC
TION}
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/ProcessMedInsuranc
eCard_x0020_with_x0020_log_x0020_transaction
Parameters
Input parameters
Data type
Description
LicenseKey
String
Sets license key (provided by Acuant) in the
header of the HTTPS request
var authInfo =
$.base64.encode($("#txtLicenseKey").va
l());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
Images
Front and back images of the ID
See the sample code for information about
passing the images to Web Services
ReformatImage
Boolean
Indicates whether Web Services returns the
reformatted image from the ID
Values: True | False
ReformatImageColor
Integer
Integer value that specifies the color value of
the reformatted image
Values:
0
Image same color
1
Black and White
ReformatImageDpi
Integer
Integer that indicates what dpi value (up to
600 dpi) to reformat the image
Note: The size of the image is dependent on
the dpi value; a lower value (150 dpi) is
recommended to obtain a smaller image.
PreProcImage
Boolean
Indicates whether to crop the input image
Values: True | False
ProcessMedInsuranceCard method
22 AcuFill Web Services Programmer’s Guide
Input parameters
Data type
Description
LogTransaction
Boolean
Set this to true if you want to save the
transaction and retrieve it later from Acuant
web services.
Values: True | False
ImageSource
Integer
Specifies the source of the image
Note: See the Image Requirements section for
recommended values.
101
Cropped image from a mobile camera or any other camera
Note: Image should be 1250 pixels (width and height based on
aspect ratio).
102
Cropped 300 dpi or 600 dpi image from ScanShell scanner or
any TWAIN scanner
Note: If an uncropped image is sent, then specify CropImage as
True in the API call.
103
Cropped 300 dpi or 600 dpi image from a SnapShell scanner
105
Miscellaneous. Specify this value if you want the AcuFill Web
Services to resize the image for optimal processing. This value
works with both CropImage True or False.
Note: If ImageSource value is not specified
and the input cropped image is not 300 dpi or
600 dpi, then Web Services will resize the
input image to 300 dpi and 1250 pixels wide
for optimal processing.
Output parameters
Data type
Description
ReformattedImageTwo
Byte
Back image of the ID
ReformattedImage
Byte
Front image of the ID
ContractCode
String
Contract code on the ID
CopayEr
String
CopayEr field on the ID
CopayOv
String
CopayOv field on the ID
CopaySp
String
CopaySp field on the ID
CopayUc
String
CopayUc field on the ID
Coverage
String
Coverage field on the ID
DateOfBirth
String
Date of birth field on the ID
Deductible
String
Deductible field on the ID
EffectiveDate
String
Effective date field on the ID
ProcessMedInsuranceCard method
AcuFill Web Services Programmer’s Guide 23
Output parameters
Data type
Description
Employer
String
Employer field on the ID
ExpirationDate
String
Expiration date field on the ID
FirstName
String
First name field on the ID
GroupName
String
Group name field on the ID
GroupNumber
String
Group number field on the ID
IssuerNumber
String
Issuer number field on the ID
LastName
String
Last name field on the ID
ListAddress[{
City
FullAddress
State
Street
Zip
}]
List
Address field on the ID
ListDeductible[{
Label
Value
}]
List
Deductibles field on the ID
ListEmail [{
Label
Value
}]
List
Emails field on the ID
ListPlanCode[{
PlanCode
}]
List
Plan codes field on the ID
ListTelephone[{
Label
Value
}]
List
Telephone numbers field on the ID
ListWeb[{
Label
Value
}]
List
Web address field on the ID
MemberId
String
Member ID field on the ID
MemberName
String
Member name field on the ID
MiddleName
String
Middle name field on the ID
24 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
NamePrefix
String
Name prefix field on the ID
NameSuffix
String
Name suffix field on the ID
Other
String
Other field on the ID
PayerId
String
Payer ID field on the ID
PlanAdmin
String
Plan admin field on the ID
PlanProvider
String
Plan provider field on the ID
PlanType
String
Plan type field on the ID
RxBin
String
RxBin field on the ID
RxGroup
String
RxGroup field on the ID
RxId
String
RxID field on the ID
RxPcn
String
RxPCN field on the ID
GetTransactionId
String
Transaction ID field on the ID
RawText
String
Raw unstructured text from the medical
insurance card
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseCodeProcMedicalCard
Integer
See error codes and error descriptions
ResponseCodeProcMedicalCardDesc
String
See error codes and error descriptions
ResponseCodeReformatImage
Integer
See error codes and error descriptions
ResponseCodeReformatImageDesc
String
See error codes and error descriptions
ResponseCodeReformatImageTwo
Integer
See error codes and error descriptions
ResponseCodeReformatImageTwoDesc
String
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
ProcessPassport method
AcuFill Web Services Programmer’s Guide 25
ProcessPassport method
Processes passport’s face image information page.
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/ProcessPassport/{GETFACEIMAGE}/{G
ETSIGNIMAGE}/{REFORMATIMAGE}/{REFORMATIMAGECOLOR}/{REFORMATIMAGEDPI}/{PREPR
OCIMAGE}/{IMAGESOURCE}/{WIDECHARACTERS}/{LOGTRANSACTION}
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/Passport_x0020_wit
h_x0020_image_x0020_source_x002C__x0020_wide_x0020_characters_x0020_and_x0020_log
_x0020_transaction
Parameters
Input parameter
Data type
Description
LicenseKey
String
Sets license key (provided by Acuant) in the header
of the HTTPS request:
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
Images
Face picture side image of the passport. See the
sample code on how to pass the images to Web
Services.
GetFaceImage
Boolean
Indicates whether to return the face image from the
passport
Values: True | False
GetSignImage
Boolean
Indicates whether to return the signature image
from the passport
Values: True | False
ReformatImage
Boolean
Indicates whether Web Services returns the
reformatted image from the passport
Values: True | False
ReformatImageColor
Integer
Integer value that specifies the color value of the
reformatted image
Values: 0 | 1
0
Image same color
1
Black and White
ReformatImageDpi
Integer
Integer that indicates what dpi value (up to 600 dpi)
to reformat the image
ProcessPassport method
26 AcuFill Web Services Programmer’s Guide
Input parameter
Data type
Description
Note: The size of the image is dependent on the dpi
value; a lower value (150 dpi) is recommended to
obtain a smaller image.
PreProcImage
Boolean
Indicates whether to crop the input image
Values: True | False
ImageSource
Integer
Specifies the source of the image. See the Image
Requirements section for more information about
these values.
101
Cropped image from a mobile camera or any
other camera. Image should be1250 pixel wide
and height based on aspect ratio.
102
Cropped 300 dpi or 600 dpi image from
ScanShell scanner or any TWAIN scanner. If
uncropped image is sent, then please specify
CropImage True in the API call.
103
Cropped 300 dpi or 600 dpi image from
SnapShell scanner.
105
Miscellaneous. Specify this value if you want
AcuFill Web Services to resize the image for
optimal processing. This value works with both
CropImage True or False.
Note: If ImageSource value is not specified and the
input cropped image is not 300 dpi or 600 dpi, then
Web Services will resize the input image to 300 dpi
1250 pixels width for optimal processing.
WideCharacters
Boolean
Indicates whether to enable diacritics
Values: True | False
LogTransaction
Boolean
Set this to true if you want to save the transaction
and retrieve it later from Acuant web services.
Values: True | False
Output parameters
Data type
Description
Address2
String
Address field on the passport
Address3
String
Populated when address on the
passport has multiple lines, especially
IDs in Asia*
Country
String
Three-letter country codes as per ISO
3166-1 alpha-3 codes
CountryLong
String
Full country name on the passport
DateOfBirth
String
Date of birth field on the passport with
mm-dd-yy year format
ProcessPassport method
AcuFill Web Services Programmer’s Guide 27
Output parameters
Data type
Description
DateOfBirth4
String
Date of birth field on the passport with
yyyy year format
End_POB
String
End POB field on passport
ExpirationDate
String
Expiration date field on the passport
with yy year date format
ExpirationDate4
String
Expiration date field on the passport
with yyyy year format
IssueDate
String
Issue date field on the passport with yy
year format
IssueDate4
String
Issue date field on the passport with
yyyy year format
NameFirst
String
First name field on the MRZ line on the
passport
NameFirst_NonMRZ
String
First name field on the passport
NameLast
String
Last name field on the MRZ line on the
passport
NameLast_NonMRZ
String
Last name field on the passport
NameMiddle
String
Middle name field on the MRZ line on
the passport
Nationality
String
Three-letter country codes as per ISO
3166-1 alpha-3 codes for nationality
country.
NationalityLong
String
Full country name for nationality on
the passport
PassportNumber
String
Passport number field on the passport
PersonalNumber
String
Personal number field on the passport
Sex
String
Sex (Gender) field on the passport
AuthenticationResult
String
Authentication result
Values:
▪ Passed
▪ Failed
▪ Attention
▪ Unknown
See Appendix A: AssureID
Authentication for more information
about authentication results.
ProcessPassport method
28 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
AuthenticationResultSummary
List
If AuthenticationResult is Attention or
Unknown, then
AuthenticationResultSummary may
contain the summary of reasons for the
authentication result. See Appendix A:
AssureID Authentication for more
information about authentication
results.
GetTransactionId
String
Transaction ID on the passport
FaceImage
Byte
Face image on the passport
ReformattedImage
Byte
Passport image on the passport
SignImage
Byte
Sign image on the passport
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseCodePassportFaceImage
Integer
See error codes and error descriptions
ResponseCodePassportFaceImageDesc
String
See error codes and error descriptions
ResponseCodePassportSignatureImage
Integer
See error codes and error descriptions
ResponseCodePassportSignatureImageDesc
String
See error codes and error descriptions
ResponseCodeProcPassport
Integer
See error codes and error descriptions
ResponseCodeProcPassportDesc
String
See error codes and error descriptions
ResponseCodeReformatImage
Integer
See error codes and error descriptions
ResponseCodeReformatImageDesc
String
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
*Not applicable to U.S., Canadian, and Australian IDs
IdentityVerification method
AcuFill Web Services Programmer’s Guide 29
IdentityVerification method
Verifies the address or identity of an individual
URL: https:// cssnwebservices.com/CSSNService/CardProcessor/IdentityVerification/
{ADDRESSVERIFICATION}/{IDENTITYVERIFICATION}
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/IdentityVerification
User Identity Details
Name
Data Type
Description
FirstName
String
First name of the person (Required)
Note: Title, middle initial or middle name cannot be part of the
first name.
MiddleName
String
Middle name of the person
LastName
String
Last name of the person (Required)
Note: Suffix can’t be part of the last name.
DateOfBirth
String
Date of birth in the format: mm-dd-yyyy (Only required if
IdentityVerification input parameter is set to true)
Address
String
For example, 123 Main St. Apt 6.
City
String
The person's city information
Zip
String
Postal Code (Required only for the US)
State
String
U.S. two-character state (Required only for the US)
Country
String
Set the country of the person. ISO 3166 Country Code (2-letter)
(Required)
http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_c
ountry_names_and_code_elements.htm
County
String
Set the county of the person. (Ireland only) Submit either county code
or county name.
IdType
Integer
ID type (Optional). Values:
4
Driver’s License No.
19
U.S. Social Security Number
IdNumber
String
ID number based on IdType (Optional). Values:
4
Driver’s License Number
19
U.S. Social Security Number
IdentityVerification method
30 AcuFill Web Services Programmer’s Guide
Parameters
Input parameters
Data type
Description
AddressVerification
Boolean
Indicates whether to verify name to address
Values: True | False
IdentityVerification
Boolean
Indicates whether to verify identity
Values: True | False
LicenseKey
String
Sets the license key (provided by Acuant) in the header
of the HTTPS request
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
{
userIdentityDetails {
FirstName,
MiddleName,
LastName,
DateOfBirth,
Address
City,
Zip,
State,
Country,
IdNumber,
IdType}
}
String
String in JSON format passed to the body of the request
containing the details of the person that needs to be
verified
DateOfBirth in mm-dd-yyyy format
Output parameters
Data type
Description
NameToAddressMatch
Boolean
Indicates a name to address match
Values: True | False
IdentityVerification
Boolean
Specifies whether the identity is verified
Values: True | False
SSNVerification
Boolean
Specifies whether the Social Security Number is
verified Values: True | False
AcuFill Web Services Programmer’s Guide 31
Output parameters
Data type
Description
DMVVerification
Boolean
Indicates whether DMV verification was successful
Note: Only the following states are supported for
DMV verification.
CT
Connecticut
CO
Colorado
ME
Maine
MI
Michigan
MO
Missouri
OH
Ohio
OR
Oregon
TN
Tennessee
TX
Texas
WI
Wisconsin
WY
Wyoming
IDNumberFormatVerification
Boolean
Indicates whether the ID number format is correct
Values: True | False
TransactionID
String
Unique identifier for the transaction
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
ValidationErrorCodes
Integer
See error codes and error descriptions
ValidationErrorMessages
Array of String
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
KBA method
32 AcuFill Web Services Programmer’s Guide
KBA method
Requests a quiz that contains several personal questions to verify an individual
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/KBA
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/KBA
User Identity Details
Name
Data Type
Description
ApplicantId
String
Unique session ID generated by on the first request to Web Services. This
element is left empty on the first request. Use the ApplicantId generated
by Web Service for each subsequent request.
FirstName
String
An individual’s first name (Required)
Note: Title, middle initial or middle name can’t be part of the first name.
MiddleName
String
An individual’s middle name (Optional)
LastName
String
The last name of the person (Required)
Note: Suffix can’t be part of the last name.
DateOfBirth
String
Date of Birth in either mm-dd-yyyy format (Required)
Address
String
Address of the individual (Required) For example, 123 Main St. Apt 6.
City
String
An individual's city information (Required)
Zip
String
Postal Code (Required)
State
String
U.S. two-character-state (Required)
Ssn
String
Social Security Number (Optional)
KBA method
AcuFill Web Services Programmer’s Guide 33
Parameters
Input parameters
Data type
Description
LicenseKey
String
License key provided by Acuant
Set license key in the header of the HTTPS request:
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
{
userIdentityDetails{
ApplicantId,
FirstName,
MiddleName,
LastName,
DateOfBirth,
Address,
City,
Zip,
State,
Ssn
}
}
String
String in JSON format passed to the body of the request
containing the details of the person that needs to be
verified.
Note: Date of Birth must be in mm-dd-yyyy format.
ApplicantId
Data type
Description
ApplicantId
String
Unique session ID generated by on the first request to
Web Services
Note: This element is left empty on the first request.
Use the ApplicantId generated by Web Services for
each subsequent request.
NumberOfQuestions
Integer
Number of questions
Questions [{
Choices,
String,
String,
String,
QuestionId,
QuestionText
}]
String
Contains the unique identifier of the question,
questions and choices
KBAErrorCode
Integer
See error codes and error descriptions
KBAErrorDescription
String
See error codes and error descriptions
KBA method
34 AcuFill Web Services Programmer’s Guide
ApplicantId
Data type
Description
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
SubmitQuiz method
AcuFill Web Services Programmer’s Guide 35
SubmitQuiz method
Sends the answers after calling the KBA function or after calling SubmitQuiz function. An additional
question will be returned by Web Services if the client answered one of the questions incorrectly.
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/SubmitQuiz
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/SubmitQuiz
Parameters
Input parameters
Data type
Description
LicenseKey
String
LicenseKey provided by Acuant.
Set license key in the header of the HTTPS request.
var authInfo =
$.base64.encode($("#txtLicenseKey").val())
;
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
ApplicantId
String
Unique session ID generated by on the first request to Web
Services. This element is left empty on the first request. Use
the ApplicantId generated by Web Services for each
subsequent request.
NumberOfQuestions
Integer
Number of questions
Answers[{
QuestionId,
ItemAnswer},
{
QuestionId,
ItemAnswer
},
{
QuestionId,
ItemAnswer
}]
String
Answer to each question
SubmitQuiz method
36 AcuFill Web Services Programmer’s Guide
Output Parameters
Data type
Description
ApplicantId
String
Unique session ID generated by on the first request to
Web Services. This element is left empty on the first
request. Use the ApplicantId generated by Web
Services for each subsequent request.
NumberOfQuestions
Integer
Number of questions
Questions [{
Choices,
String,
String,
String,
QuestionId,
QuestionText
}]
String
Contains the unique identifier of the question,
questions and choices.
Status
Integer
Status Codes:
1
Quiz Generated
2
No Quiz Generated
3
Error
4
Time Out
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
WatchList method
AcuFill Web Services Programmer’s Guide 37
WatchList method
Checks an identity against multiple Watch Lists
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/WatchList
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/WatchList
Watch List Details
Name
Data Type
Description
FirstName
String
An individual’s first name (Required)
Note: Title, middle initial or middle name can’t be part of the
first name.
LastName
String
An individual’s last name (Required)
Note: Suffix can’t be part of the last name.
DOB
String
Date of Birth in MM-DD-YYYY format (Required)
Address
String
Address
For example, 123 Main St. Apt 6.
Zip
String
Postal Code (Required)
Country
String
Country either in ISO "ALPHA-2 Code or in ISO ALPHA-3 Code
(Required)
WatchListName
List
Watch list name to get results of a specific watch list (Optional)
For example, U.S. Department of the Treasury - Office of Foreign Assets
Control. When specified, only specified watch list results are returned.
WatchList method
38 AcuFill Web Services Programmer’s Guide
Parameters
Input parameters
Data type
Description
LicenseKey
String
LicenseKey provided by Acuant
Set license key in the header of the HTTPS request:
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
{
watchListInput {
FirstName,
LastName,
DOB,
Address,
City,
Zip,
Country,
WatchListName,
}
}
String
String in JSON format passed to the body of the request
containing the details of the person that needs to be
verified.
DateOfBirth in mm-dd-yyyy format
Country either in ISO "ALPHA-2 Code or in ISO ALPHA-3
Code
Output parameters
Data type
Description
ValidationErrorCodes
List
Validation error codes list
ValidationErrorMessages
List
Validation error messages list
WatchListResponse
String
Watch list response
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
GetDLData method
AcuFill Web Services Programmer’s Guide 39
GetDLData method
Gets driver’s license information posted by idScan or MedicScan Connect software only
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/GetDLData
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/GetDLData
Parameters
Input parameters
Data type
Description
AccessKey
String
Each machine has an AccessKey, which can be obtained
from idScan/MedicScan connect software.
Set access key in the header of the HTTPS request:
var authinfo = $.base64.encode(accessKey);
xhr.setRequestHeader("Authorization", "AccessKey
" + authinfo);
Output parameters
Data type
Description
Address
String
Address on the ID
Address2
String
Populated when address on the ID has multiple lines,
especially IDs in Asia*
Address3
String
Populated when address on the ID has multiple lines,
especially IDs in Asia*
Address4
String
Populated when address on the ID has multiple lines,
especially IDs in Asia*
Address5
String
Populated when address on the ID has multiple lines,
especially IDs in Asia*
Address6
String
Populated when address on the ID has multiple lines,
especially IDs in Asia*
Base64BackReformattedImage
String
Back image of the ID
Base64FaceImage
String
Face picture on the ID
Base64FrontReformattedImage
String
Front image of the ID
Base64SignImage
String
Signature name on the ID
City
String
City on in the ID
Class
String
Class on the ID
CountryShort
String
Three-letter country codes as per ISO 3166-1 alpha-3
codes
County
String
County on the ID
GetDLData method
40 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
DateOfBirth4
String
Date of birth on the ID with yyyy year format
DateOfBirthLocal
String
Date of birth local on the ID
DocType
String
Acuant internal field. For internal use only.
Endorsements
String
Endorsements on the ID
ExpirationDate4
String
Expiration date on the ID with yyyy year format
Eyes
String
Eyes on the ID
FatherName
String
Father name on the ID
Fee
String
Fee on the ID
Hair
String
Hair on the ID
Height
String
Height on the ID
Id
String
ID number on the ID
IdCountry
String
Full country name on the ID
IsBarcodeRead
Boolean
Indicates that the barcode on the back side of the ID
could be read. Values: True | False
IsOcrRead
Boolean
Indicates that the barcode on the front side of the ID
could be read. Values: True | False
IssueDate4
String
Issue date field on the ID with yyyy year format
IssueDateLocal
String
Issue date local field on the ID
MotherName
String
Mother name field on the ID
NameFirst
String
First name field on the ID
NameFirst_NonMRZ
String
First name field on the ID (not MRZ line)**
NameLast
String
Last name field on the ID
NameLast1
String
Additional last names on the ID
NameLast2
String
Additional last names on the ID
NameLast_NonMRZ
String
Last name field on the ID (not MRZ line)**
NameMiddle
String
Middle name on the ID
NameMiddle_NonMRZ
String
Middle name field on the ID (not MRZ line)**
NameSuffix
String
Name suffix on the ID
NameSuffix_NonMRZ
String
Name suffix field on the ID (not MRZ line)**
Nationality
String
Nationality field on the ID
Original
String
Original field on the ID
PlaceOfBirth
String
Place of birth field on the ID
PlaceOfIssue
String
Place of issue field on the ID
GetDLData method
AcuFill Web Services Programmer’s Guide 41
Output parameters
Data type
Description
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
Restriction
String
Restriction on the ID
Results2D
Integer
Acuant internal field. For internal use only.
Sex
String
Sex (Gender) on the ID
SigNum
String
SigNum on the ID
SocialSecurity
String
Social Security number on the ID
State
String
State on the ID
Text1
String
Additional data fields
Text2
String
Additional data fields
Text3
String
Additional data fields
Type
String
Type on the ID
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
Weight
String
Weight on the ID
Zip
String
Zip on the ID
License
String
License number on the ID
CardType
String
Type of card mentioned on the ID
Note: Only available for few states in the U.S.
GetDLData method
42 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
TemplateType
String
Type of template. Values:
▪ Not Set
▪ ID
▪ DL
▪ Passport
▪ Club
▪ Military
▪ Member
▪ Resident Permit
▪ Visa
▪ Employee
▪ DVLA
▪ Gun License
▪ Social Security
▪ ID/DL
▪ Professional Regulation Commission
▪ Unified Multi-Purpose ID
▪ Travel Document
▪ Sex Offender
▪ Photo Card
▪ Biometric Passport
▪ Biometric ID
DocumentDetectedName
String
State of issue of the ID
DocumentDetectedNameShort
String
State of issue of the ID
** Valid only for IDs which have an MRZ line, such as European IDs
GetMedInsuranceData method
AcuFill Web Services Programmer’s Guide 43
GetMedInsuranceData method
Gets medical insurance card information posted by MedicScan Connect software
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/GetMedInsuranceData
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/GetMedInsuranceDa
ta
Parameters
Input parameters
Data type
Description
AccessKey
String
Each machine has an AccessKey, which can be obtained
from MedicScan connect software. Set access key in the
header of the HTTPS request.
var authinfo = $.base64.encode(accessKey);
xhr.setRequestHeader("Authorization",
"AccessKey " + authinfo);
Output parameters
Data type
Description
Base64BackReformattedImage
String
Back image of the ID
Base64FrontReformattedImage
String
Front image of the ID
ContractCode
String
Contract code field on the ID
CopayEr
String
CopayEr field on the ID
CopayOv
String
CopayOv field on the ID
CopaySp
String
CopaySp field on the ID
CopayUc
String
CopayUc field on the ID
Coverage
String
Coverage field on the ID
DateOfBirth
String
Date of birth field on the ID
Deductible
String
Deductible field on the ID
EffectiveDate
String
Effective date field on the ID
Employer
String
Employer field on the ID
ExpirationDate
String
Expiration date field on the ID
FirstName
String
First name field on the ID
GetMedInsuranceData method
44 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
GroupName
String
Group name field on the ID
GroupNumber
String
Group number field on the ID
IssuerNumber
String
Issuer number field on the ID
LastName
String
Last name field on the ID
ListAddress [{
City
FullAddress
State
Street
Zip
}]
List
Address field on the ID
ListDeductible [{
Label
Value
}]
List
Deductibles field on the ID
ListEmail [{
Label
Value
}]
List
Emails field on the ID
ListPlanCode [{
PlanCode
}]
List
Plan codes field on the ID
ListTelephone [{
Label
Value
}]
List
Telephone numbers field on the ID
ListWeb [{
Label
Value
}]
List
Web address field on the ID
MemberId
String
MemberID field on the ID
MemberName
String
Member name field on the ID
MiddleName
String
Middle name field on the ID
NamePrefix
String
Name prefix field on the ID
NameSuffix
String
Name suffix field on the ID
Other
String
Other field on the ID
GetMedInsuranceData method
AcuFill Web Services Programmer’s Guide 45
Output parameters
Data type
Description
PayerId
String
Payer ID field on the ID
PlanAdmin
String
Plan admin field on the ID
PlanProvider
String
Plan provider field on the ID
PlanType
String
Plan type field on the ID
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
RxBin
String
RxBin field on the ID
RxGroup
String
RxGroup field on the ID
RxId
String
RxID field on the ID
RxPcn
String
RXPCN field on the ID
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
FacialMatch method
46 AcuFill Web Services Programmer’s Guide
FacialMatch method
Matches two facial images.
URL:
https://cssnwebservices.com/CSSNService/CardProcessor/FacialMatch/{LOGTRANSACTION}
Help page:
https://cssnwebservices.com/CSSNService/CardProcessor/help/operations/Face_x0020_image_
x0020_recognition_x0020_with_x0020_log_x0020_transaction
Parameters
Input parameter
Data type
Description
LicenseKey
String
License key provided by Acuant
Set license key in the header of the HTTPS request:
var authInfo =
$.base64.encode($("#txtLicenseKey").val());
xhr.setRequestHeader("Authorization",
"LicenseKey " + authInfo);
Images
Two facial images to be matched. Please refer to
the sample code on how to pass the facial images
to the request.
LogTransaction
Boolean
Set this to true if you want to save the transaction
and retrieve it later from Acuant web services.
Values: True | False
Output parameter
Data type
Description
FacialMatch
Boolean
Indicates whether two face images match or not.
FacialMatchConfidenceRating
Integer
Facial match confidence rating out of 100. A score
of 80 or above indicates two face images match.
ManualReview
Boolean
Indicates whether the face images were sent for
manual review or not.
Note: This option only returns true if you have
subscribed for DocX FRM.
TransactionId
String
Unique Transaction ID for the transaction.
ResponseCodeAuthorization
Integer
See error codes and error descriptions
ResponseMessageAuthorization
String
See error codes and error descriptions
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
TransactionResult method
AcuFill Web Services Programmer’s Guide 47
TransactionResult method
Provides the result of a transaction
URL:
https://cssnwebservices.com/CSSNService/cardprocessor/TransactionResult/
Help page:
https://cssnwebservices.com/CSSNService/cardprocessor/help/operations/TransactionResult
Parameters
Input parameter
Data type
Description
TransactionID
String
Unique ID for the transaction
Output parameters
Data type
Description
BackImage
Byte
Back image of the document
CreatedDate
String
Date and time at which the request was received
ErrorCode
Integer
A number less than 1 indicates an error
See error codes and error descriptions
ErrorDescription
String
See error codes and error descriptions
FrontImage
Byte
Front image of the document
ProcessingTime
Integer
Time, in milliseconds, for the server to process a
transaction
RequestParams
String
Request parameters that are sent with the
request
TemplateType
String
Document template type
Values:
▪ Not Set
▪ ID
▪ DL
▪ Passport
▪ Club
▪ Military
▪ Member
▪ Resident Permit
▪ Visa
▪ Employee
▪ DVLA
▪ Gun License
▪ Social Security
▪ ID/DL
TransactionResult method
48 AcuFill Web Services Programmer’s Guide
Output parameters
Data type
Description
▪ Professional Regulation Commission
▪ Unified Multi-Purpose ID
▪ Travel Document
▪ Sex Offender
▪ Photo Card
▪ Biometric Passport
▪ Biometric ID
WebResponseCode
Integer
See error codes and error descriptions
WebResponseDescription
String
See error codes and error descriptions
Response Code Authorizations
AcuFill Web Services Programmer’s Guide 49
Error Codes and Error Descriptions
This section describes the error codes and error descriptions returned by AcuFill Web Services.
Response Code Authorizations
Response code
Authorization message
-8
Unable to process request; invalid credentials
-9
Account disabled
-12
Unauthorized to Process Driver’s License
-15
Unable to process
-17
Unauthorized to Process Passport
-18
Unauthorized to Process Barcode
-20
Unauthorized to process medical insurance cards
-26
Credentials required
-27
Basic authentication or Unique ID authentication was not recognized
-28
No Authorization header specified
-41
Invalid License Key
-44
License Key disabled
-46
License Key needs to be activated
-70
Unauthorized to Process Barcode String
-98
Address Verification Limit has been reached
-99
Unauthorized to verify address
-100
Unauthorized to verify identity
-103
Unauthorized to verify user details
-107
Unauthorized to process KBA
-108
KBA Limit has been reached
-118
Unauthorized to verify social identity
Response Codes
50 AcuFill Web Services Programmer’s Guide
Response Codes
Response code
Description
1
No Error
-1
State not Recognized
-2
State not Supported
-3
Bad Parameters
-4
No Match Found
-5
Error in Opening the File
-6
Bad Destination File
-7
Feature not Supported
-8
Country not Initialized
-9
No Next Country
-10
State not Initialized
-11
No Next State
-12
Cannot Delete the Destination File
-13
Cannot Copy to the Destination Location
-14
Face Image or Signature Image not Found
-15
State not Recognized
-16
USA Templates not Found
-17
Wrong Template File
-18
Region not Initialized
-19
Auto Detection of State not Supported
-20
Compare no Text
-21
Compare no Barcode
-22
Compare Barcode Library not Found
-23
Compare License does not Match Barcode Library
-24
DM Library not Found
-25
DM Library not Loaded
-26
DM WM not Found
-27
DM WM not Authenticated
-28
UV Error - Bank not Found
-29
UV Error - Region not Supported
-30
UV Error - Image File Missing
-31
UV Error - Image Loading Failed
-32
UV Error - Template not Implemented
Get Response Codes
AcuFill Web Services Programmer’s Guide 51
Response code
Description
-33
UV Authentication Failed
-200
Image Missing Stamp or SDK Missing Activation Code
Get Response Codes
Response code
Description
0
Error In Processing
1
No Error
Barcode Response Codes
Response code
Description
0
No Barcode Found
1
No Error
-1
Bad Parameter
Passport Response Codes
Response code
Description
-40
Bad Parameters
-41
Cannot Delete the Destination File
-42
Cannot Copy to the Destination Location
-43
Cannot Delete the Destination Image
Medical Card Response Codes
52 AcuFill Web Services Programmer’s Guide
Medical Card Response Codes
Response code
Description
-1
File not Found
-2
Unable to Load the File
-3
No text found the Card
-4
Unable to Load the Image
-5
Invalid Field
-6
No Data
-7
Last Data
-8
Next Data Exists
Reformat Image Response Codes
Response code
Description
0
No Error
-100
Error in Opening the File
-101
Bad Image Angle
-102
Bad Image Angle
-103
Bad Image File Destination
-104
Error in Saving the File
-105
Error in Saving the File to Clipboard
-106
Error in Opening the File
-107
Error in Opening the File
-108
Unknown File Combo Type
-109
Image Bad Parameters
-130
Image Bad Color
-131
Image Bad dpi
-132
Invalid Internal Image
-133
Bad Image Dump
-134
Bad Image Dimensions
-200
Image Missing Stamp
Registration Error Codes
AcuFill Web Services Programmer’s Guide 53
Registration Error Codes
Error code
Error message
-65
Customer name is required
-66
Email Address is required
-67
Email address has an invalid format
-68
License Code is required
-69
Company Name is required
Validation Error Codes
Error Code
Error message
-36
Address required
-37
City required
-38
State required
-39
Zip required
-66
Email required
-77
Input required to save log
-81
First name is a required input
-82
Last name is a required input
-86
Date of Birth required
-87
Input required to process verification
-88
App Name input required
-89
Key input required
-90
Error input required
-92
Input required to process social verification
-95
Date is invalid
-97
ID Type is not within the list of acceptable ID Types
Web Response Codes
54 AcuFill Web Services Programmer’s Guide
Web Response Codes
Response code
Description
7
Client passed the quiz
1
Successful
0
Failed
-1
Image is null
-3
Unable to parse parameter: {parameter}
-4
Value is out of range for: {parameter}
-5
Parameter autoDetectState value cannot be equal to ‘false’ if procState is equal to ‘-1’
-6
Image not valid
-8
Unable to process request; invalid credentials
-9
Account disabled
-11
Unexpected error occurred
-15
Unable to process
-16
Not able to crop the image
-21
Only uploading of one or two images are allowed
-22
Unable to process
-25
An argument exception occurred
-31
Front and back images of the card are required for upload
-32
Input Unique ID required
-34
WebP Image is not supported for this function
-35
Address verifier failed to initialize
-40
Getting license details for this kind of authentication is not supported
-41
Invalid License Key
-42
Account status or License Key Activation status is unrecognized
-44
License Key disabled
-46
License Key needs to be activated
-47
Text extraction was not successful
-50
Invalid Access Key
-51
Cannot return data; failed to delete record
-53
Data not found
-54
ID image only or both ID image and Barcode image are required for upload
-56
Unauthorized authentication type detected
-57
Input barcode string is required
-58
Front Image and Barcode String are required
Web Response Codes
AcuFill Web Services Programmer’s Guide 55
Response code
Description
-61
Maximum number of machines is already registered with this License Code
-63
This machine is already registered
-66
Email Address is required
-71
Your account is not allowed to report images
-72
Card type unknown
-73
One image upload is required
-74
Upload at least one image
-75
No record found
-83
Unable to parse input image. Please check the format of the request.
-84
Unable to parse the input image and text file. Please check the format of the request.
-91
Error in getting machine count
-93
No verification option selected
-104
Error has occurred in generating quiz
-105
No quiz generated
-106
Timeout has occurred in generating quiz
-109
Client failed to pass the quiz
-110
Error has occurred while evaluating the quiz answers
-111
Answers are incomplete. All questions must be answered.
-112
Applicant ID is required
-113
Number of questions must be greater than zero
-114
The identity verification is not available at this moment. Please try again later.
-115
The quiz generation is not available at this moment. Please try again later.
-117
Social identity cannot be verified at this moment. Please try again later.
-120
Could not generate KBA. KBA velocity reached.
License Key Activation Descriptions
56 AcuFill Web Services Programmer’s Guide
License Key Activation Descriptions
Activation description
License Key was activated successfully.
This license key is already activated.
License Key disabled.
Invalid License Key
New License Key Error Descriptions
Error description
License Key not found.
Account disabled.
Key reset required. The key is not activated.
KBA Error Code Descriptions
Error code
Description
2001
Missing Zip/Postal Code
2002
No Account Found
2003
Account Closed
2004
Invalid DOB
2005
Account Not Opened
2006
Invalid Zip/Postal Code
2007
Database Error Occurred
2008
Missing State
2009
DOB out of valid range for verification (such as 1/1/1995)
2010
DOB before 1900
2011
Missing or Invalid Verification Data
2012
Missing DOB
2013
Zip/State do not match
2015
Must provide State or Zip
2016
XX: Country Not Supported
2017
ID# Not Submitted
2030
VME is not available
2031
Invalid IP
2032
Invalid ID
HTTP Error Code Descriptions
AcuFill Web Services Programmer’s Guide 57
Error code
Description
2050
Missing First Name
2051
Missing Last Name
2052
Missing Address
2070
Missing Contact Phone
2071
Missing Contact Email
2072
Missing Contact Amount
2073
Missing Phone
2074
Missing Social Security No.
2079
Missing/Invalid Mobile Number
2080
Missing/Invalid County
2085
Missing Answers to Quiz
2999
Invalid Acct Type
2110
E-Sig Failure
4000
Provider Error
4001
Provider Timeout
5001
Insufficient Data (The identity was found but there is not sufficient data to generate quiz
questions)
5002
Individual not valid (The identity was found but either the Name, DOB, or SSN does not match the
values in our data)
5003
Invalid Applicant ID
5004
Maximum attempts hit for Individual
5005
Invalid Request
5006
Quiz Expired
5007
Identity not Found
HTTP Error Code Descriptions
Error code
Description
429
Too many requests
500
Server internal error
503
Service unavailable
504
Gateway timeout
Note A 200 HTTP response is returned for any other type of error and returns the errors in the
response body.
Appendix A: AssureID Authentication
AcuFill Web Services Programmer’s Guide 58
Appendix A: AssureID Authentication
AssureID performs a number of tests on a document to determine its authenticity. Each document type
in the AssureID Document Library contains a defined set of individual authentication tests that is
relevant for that particular document type only. The set of authentication tests performed on one type
of document will not be the same as the set of tests performed on another type, although many of the
same tests are used. The number and types of authentication tests will vary for a particular document,
but a typical document will be subjected to 10–50 individual authentication tests. For example, one test
may confirm the presence of security features and/or patterns on the document under one or more
light sources, and another may compare the data from different sources on the document (such as MRZ
and e-Passport chip).
Authentication Test Descriptions
The following table describes the AssureID authentication tests:
Note This is not a comprehensive list. Not every test is executed on every type of document. These
names do not represent actual authentication test names.
Authentication test
Description
2D barcode
Verifies that the barcode was both read successfully and the contents
were extracted.
2D barcode
format validation
Verifies that two-dimensional barcode could both be read successfully and
decoded. Fails if the 2D barcode could not be correctly decoded, which could be a
result of incorrectly encoding, either inadvertently due to a manufacturing problem,
or intentionally.
Data validity tests
Reads the multiple data sources on a document and verifies that no widespread
differences exist in the data between data sources, which may indicate that the
document has either been tampered with or is a counterfeit.
Field crosschecks
Compares the fields between two or more data elements in multiple locations on a
document (such as visual, 2D barcode, magnetic stripe, or contactless chip) to verify
that they match.
Magnetic stripe
Verifies that the magnetic stripe on the document was read successfully and the
contents were extracted.
Microprint/
microtext detection
Verifies that a microscopic text security feature is present and in the expected
location on the document.
MRZ check digit validation
Checks the digits in the machine-readable zone (MRZ) to verify that the data was
correctly interpreted. Validates the visible personal number check digit by
comparing it with a calculated check digit from the visible personal number
element.
Near-infrared pattern
Verifies that a security feature, visible in the near-infrared spectrum, is present and
in the expected location on the document.
Appendix A: AssureID Authentication
AcuFill Web Services Programmer’s Guide 59
Authentication test
Description
Near-infrared response
Verifies that a region of the document responds as expected when viewed under
near-infrared illumination. This test may be used to determine:
▪ The integrity of the photo (detect photo substitutions)
▪ That the document is not counterfeit
▪ That the document has not been tampered with or modified
Note Text, photos, and other features on a document may not be visible under
near-infrared, depending on the type of ink used. The presence or absence
of these features may indicate that the document has either been tampered
with or is a counterfeit.
Photo
substitution detection
Detects any digital image tampering.
Note The ability to detect photo tampering attempts will vary by document type
(some documents provide more photo protection features than others).
Photo printing verification
Verifies that a detailed printing technique was used on the photo. This test may be
used to verify:
▪ The integrity of the photo (detect photo substitutions)
▪ That the document is not counterfeit
Retroreflective
laminate detection
Tests for images or text incorporated into the lamination of the document that are
revealed by indirect light.
RFID
Verifies that the chip was present and that the chip was both read successfully and
the contents were extracted.
RFID chip authentication
Verifies that the appropriate document and country verifying certificates are
available. This test may fail if:
▪ The document was prematurely removed from the reader
▪ The contactless chip is faulty
▪ The contactless chip is not genuine due to replacement
(country and document certificates do not match)
Ultraviolet (UV)
pattern match
Verifies that a security feature, visible in the ultraviolet spectrum, is present and in
the expected location on the document.
Ultraviolet response
Verifies that a region of the document responds as expected when viewed under
ultraviolet (UV) illumination. This test may be used to determine:
▪ The integrity of the photo (detect photo substitutions)
▪ That the document is not counterfeit
▪ That the document has not been tampered with or modified
Note Text, photos, and other features on a document may not be visible under
near-infrared, depending on the type of ink used. The presence or absence
of these features may indicate that the document has either been tampered
with or is a counterfeit.
Visible pattern match
Verifies that a security feature in the visible spectrum is present and in the
expected location on the document.
Authentication results
60 AcuFill Web Services Programmer’s Guide
Authentication results
The failure of a single authentication test will not necessarily result in overall document authentication
failure. Each test is evaluated and the resulting value is then used to calculate the authentication result
of the test itself, which indicates whether this particular test passed or failed. By performing more
authentication tests, the sensitivity of the individual tests can be reduced, which will result in fewer false
rejects (authentic documents being flagged as suspect). In most cases, fraudulent documents will tend
to fail a number of authentication tests.
There are several variables that are more likely to cause a document to fail:
Image capture quality (for example blurriness or reflection)
Personalization of the document (such as especially long names)
Variations in manufacturing techniques (for example card printed on wrong side or slight
variations in printing location)
Wear and aging of the document (a worn or dirty card can cause failure)
Tampering and counterfeiting (unlawful changes or reproduction of documents)
Evaluating authentication results
These are the possible results that may be returned from an individual authentication test:
Result
Description
Passed
No indication that the document is fraudulent, therefore the document passed the
authentication process. This result does not provide a guarantee of authenticity as some types of
documents have very few or no security features.
Failed
One or more authentication tests have failed that indicate that the document may be fraudulent,
therefore the document failed the authentication process. This result does not guarantee that the
document is fraudulent; however, further investigation should be conducted, either by manual
inspection or by using other means to verify the identity of the bearer.
Attention
Document passed the authentication process, however, there is something of note that the user
should be aware of. Most commonly this is result is returned when an expired document is
encountered. In this case, the document may be authentic, but has expired.
Unknown
Document type could not be determined; therefore, it cannot be authenticated. This result may
occur when a document is inserted incorrectly, overly skewed, or moved during the image
capture process. Less commonly, it may also be encountered when a new type of document is
captured that is not yet supported by the AssureID document library. This result does not indicate
that the document is fraudulent, however further investigation should be conducted, either by
manual inspection or by using other means to verify the identity of the bearer.
Skipped
The authentication process was skipped entirely. This result should only be seen when using the
Data Capture edition of AssureID.
IMPORTANT! A Caution result will only be returned as an individual test result (not as an overall
result). It indicates a borderline test result between Passed and Failed, indicating that
an authentication's finding is not ideal but also not a strong indicator of a problem.
Appendix A: AssureID Authentication
AcuFill Web Services Programmer’s Guide 61
Attention result
If a document passes with Attention for the document result, you should review the tests that were
attributed to the result. For example, an Attention can occur if a document has expired. Depending on
business rules, this may be very important (such as in the case of passport validity). An Attention can
also occur if the back side of the document could not be classified, for example, possibly indicating that
someone has falsified the document. If you have a document that has failed some individual
authentication tests, you can modify the authentication sensitivity and then run a new transaction to
see what overall result changes occur.
Authentication check
Description
2D barcode read
Verifies that two-dimensional barcode on the document was read successfully
Chip authentication
Verifies that contactless chip in document is authentic
Contactless chip presence
Checks for the presence of a contactless chip in the document
Contactless chip read
Verifies that the contactless chip, if present, was read successfully
Document classification
Verifies that type of document is supported and can be fully authenticated
Document expired
Checks whether a document has expired
Document orientation
Checks that a document was presented in a correct orientation (dependent on the
magstripe location)
Magstripe presence
Checks for the presence of a magnetic stripe on the document
Magstripe read
Verifies that the magnetic stripe, if present, was read successfully

Navigation menu