Document Verification

The Document Verification module consolidates Document Classification, Document Extraction, and Document Authentication into a single module. Rather than placing three separate modules in a journey, this module performs all three checks in one step. The module returns the combined classification result, extracted fields, image quality checks, and authentication and tamper results. It is available in the US, EU, and AU regions. The module takes the following inputs and returns the following outputs:

Required inputs: Primary document front side image.
Optional inputs: Primary document back side image.
Outputs: Document classification, extracted document data, anchor portrait image, and document validation results.

Capabilities

The module returns capabilities grouped into four areas: classification, image quality, extraction, and authentication.

Classification capabilities

Classification identifies the document and returns its type and issuing origin. The module returns the following classification values:

Capability	Type	Values	Description
Document classification result	Enum	`Document Classified`, `Document NOT Classified`	Whether the document was successfully identified and classified.
Document type	Enum	`Driving License`, `Identification Card`, `Passport`, `Military Identification`, `Residence Document`, `Travel Card`, `Tribal Card`, `Visa`, `Voter Identification`, `Worker Identification`, `Merchant Mariner Credential`, `Other`, `Unknown`	The type of document identified. `Residence Document` includes green cards and residence permits. `Other` includes weapons licences, birth certificates, medical cards, and other types.
Document country code	Enum	ISO3 country codes such as `GBR`, `USA`, or `AUS`, or `Unknown`	The issuing country of the document in ISO3 format. Supports over 180 countries.
Country name	Enum	Full country names or `Unknown`	The issuing country as a full name.
State name	Enum	State/territory names or `Unknown`	The issuing state or territory, if applicable. Supports all US states, Australian states/territories, and select UK/Crown dependencies.

Image quality checks

The module runs image quality checks on both the front and back sides of the document. Each check returns one of five values:

Value	Description
`Passed`	The image meets the requirement for this check.
`Failed`	The image does not meet the requirement for this check.
`Skipped`	An underlying requirement was not met, so the check did not run.
`Undetermined`	The check could not reach a conclusion.
`Excluded`	The check was not applicable. For example, back side checks are excluded when no back image is provided. This is the default value.

Front side checks

The following checks run on the front side image of the document:

Capability	Description
Front side low resolution check	Whether the front image meets the minimum resolution requirement.
Front side glare check	Whether the front image is free of glare.
Front side blur check	Whether the front image is free of blur.
Front side colour check	Whether the front image is in colour.
Front side full document in view check	Whether the full document is visible in the front image.

Back side checks

The following checks run on the back side image of the document, when a back image is provided:

Capability	Description
Back side low resolution check	Whether the back image meets the minimum resolution requirement.
Back side glare check	Whether the back image is free of glare.
Back side blur check	Whether the back image is free of blur.
Back side colour check	Whether the back image is in colour.
Back side full document in view check	Whether the full document is visible in the back image.

Extraction capabilities

Extraction reads the required fields from the document and derives related values, such as the subject’s age and expiry status. The module returns the following extraction values:

Capability	Type	Values/Range	Description
Document extraction result	Enum	`Extraction Successful`, `Extraction Unsuccessful`	Whether the required fields, as defined in the module configuration, were successfully extracted.
Document expiry status	Enum	`Expired`, `Not Expired`, `Undeterminable`	The document’s expiry status.
Calculated age	Integer	0–130	The subject’s age in years, calculated from the extracted date of birth.
Days since expiry	Integer	0–36500	The number of whole days since the document expired. Returns `0` when the document has not expired or when the expiry date could not be determined. Always combine this with document expiry status = `Expired` in evaluation rules. Otherwise, the rule also matches non-expired and undeterminable documents.
Anchor image extracted	Boolean	`isTrue`, `isFalse`	Whether the portrait image was successfully extracted from the document. When `isFalse`, downstream facematch can be skipped.

Authentication capabilities

Authentication assesses whether the document is genuine and whether it shows signs of tampering. The module returns the following authentication values:

Capability	Type	Values	Description
Document authentication result	Enumset	`LOW_RISK_PASS`, `MEDIUM_RISK_PASS`, `HIGH_RISK_PASS`, `FAILED`	The overall authentication result. Uses the same risk-level model as Document Authentication V2.
Document tampering result	Enumset	`LOW_RISK_PASS`, `MEDIUM_RISK_PASS`, `HIGH_RISK_PASS`, `FAILED`	The tamper detection result.

Default outcomes

The outcome logic spans all three phases. Classification outcomes are evaluated first, then authentication/tamper risk outcomes, then extraction outcomes.

Outcome	Condition	Description
`Document NOT Classified`	Classification result is `Document NOT Classified`.	The document could not be identified. This evaluates first, because if classification fails, then no further checks are meaningful.
`Low Risk`	Authentication result includes `LOW_RISK_PASS` and tamper result includes `LOW_RISK_PASS`.	Both authentication and tamper detection passed under the strictest checks.
`Medium Risk`	Authentication result includes `MEDIUM_RISK_PASS` or tamper result includes `MEDIUM_RISK_PASS`.	Either authentication or tamper detection passed under moderate checks.
`High Risk`	Authentication result includes `HIGH_RISK_PASS` and tamper result includes `HIGH_RISK_PASS`.	Both authentication and tamper detection passed under the most relaxed checks.
`Caution`	Authentication result includes `FAILED` and tamper result includes `FAILED`.	Both authentication and tamper detection failed.
`Extraction Successful`	Extraction result is `Extraction Successful`.	The required fields were successfully extracted.
`Extraction Unsuccessful`	Extraction result is `Extraction Unsuccessful`.	The required fields could not be extracted.
`Document Classified`	Classification result is `Document Classified`.	The document was successfully classified.
`ERROR`	Default, when no conditions matched.	An unexpected error occurred.

Input payload

The following is a sample payload used to submit document images to the Document Verification module for processing.

JSON

{
  "resourceId": "<resourceId>",
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "documents": [
        {
          "side1Image": "<base64-encoded string>",
          "side2Image": "<base64-encoded string>",
          "type": "Primary"
        }
      ]
    }
  }
}

Field	Required	Description
`side1Image`	Yes	A base64-encoded string representing the image of the front side of the document.
`side2Image`	No	A base64-encoded string representing the image of the back side of the document.
`type`	Yes	The document role within the journey. Set to `Primary` for the main identity document.

Sample response

The following is a sample response from the Document Verification module.

JSON

{
  "response": {
    "advice": {
      "contains": {
        "DocumentClassificationResult": "Document Classified",
        "type": "Drivers License",
        "countryCode": "UTO",
        "stateName": "Not available",
        "countryName": "Utopia",
        "frontSideLowResolutionCheck": "Excluded",
        "backSideLowResolutionCheck": "Excluded",
        "frontSideGlareCheck": "Passed",
        "backSideGlareCheck": "Passed",
        "frontSideBlurCheck": "Passed",
        "backSideBlurCheck": "Passed",
        "frontSideColourCheck": "Excluded",
        "backSideColourCheck": "Excluded",
        "frontSideFullDocumentInViewCheck": "Excluded",
        "backSideFullDocumentInViewCheck": "Excluded",
        "documentExpiryStatus": "Not Expired",
        "firstNameIsPresent": true,
        "lastNamesIsPresent": true,
        "addressStringIsPresent": true,
        "dateOfBirthIsPresent": true,
        "expiryDateIsPresent": true,
        "issueDateIsPresent": true,
        "documentNumberIsPresent": true,
        "extractionResult": "Extraction Successful",
        "authenticationResult": [
          "FAILED"
        ],
        "tamperResult": [
          "FAILED"
        ]
      }
    },
    "outcome": "Caution"
  }
}

Document Verification consolidates Document Classification, Document Extraction, and Document Authentication into a single module dispatch. The single module returns the combined classification result, extracted fields, and authentication/tamper checks in one journey segment.

Capabilities

Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

Outcome	Condition	Description
`Document NOT Classified`	Document Classification Result is `Document NOT Classified`	The document couldn’t be classified.
`Low Risk`	Document Authentication Result is `LOW_RISK_PASS` and Document Tampering Result is `LOW_RISK_PASS`	Both authentication and tamper detection passed under the strictest checks.
`Medium Risk`	Document Authentication Result is `MEDIUM_RISK_PASS` or Document Tampering Result is `MEDIUM_RISK_PASS`	Either authentication or tamper detection passed under moderate checks.
`High Risk`	Document Authentication Result is `HIGH_RISK_PASS` and Document Tampering Result is `HIGH_RISK_PASS`	Both authentication and tamper detection passed under the most relaxed checks.
`Caution`	Document Authentication Result is `FAILED` and Document Tampering Result is `FAILED`	Both authentication and tamper detection failed.
`Extraction Successful`	Document Extraction Result is `Extraction Successful`	The required fields were successfully extracted.
`Extraction Unsuccessful`	Document Extraction Result is `Extraction Unsuccessful`	The required fields couldn’t be extracted.
`Document Classified`	Document Classification Result is `Document Classified`	The document was successfully classified.
`ERROR`	Default, when no conditions matched	An unexpected error occurred, so the module couldn’t return a result.

Input payload

The following is a sample payload used to submit data to the Document Verification module for processing.

JSON

{
  "context": {
    "config": {
      "delivery": "api",
      "requiredDataExtraction": {
        "anchorImage": false
      }
    },
    "subject": {
      "identity": {}
    }
  }
}

Field	Required	Description
`PrimaryDocument/side1Image`	Yes	An image of the front of the primary identity document.
`PrimaryDocument/side2Image`	No	An image of the back of the primary identity document.

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "extractionResult": "Extraction Successful"
    },
    "outcome": "Extraction Successful"
  }
}

Document tampering result

Returns the result for document tampering.

Value	Description
`HIGH_RISK_PASS`	Passed at Low Sensitivity
`MEDIUM_RISK_PASS`	Passed at Medium Sensitivity
`LOW_RISK_PASS`	Passed at High Sensitivity
`FAILED`	Caution

Document authentication result

Returns the result of the document authentication.

Value	Description
`HIGH_RISK_PASS`	Passed at Low Sensitivity
`MEDIUM_RISK_PASS`	Passed at Medium Sensitivity
`LOW_RISK_PASS`	Passed at High Sensitivity
`FAILED`	Caution

Anchor image extracted

Indicates whether the anchor (portrait) image was successfully extracted from the document. When false, downstream facematch can be skipped as there is no anchor image to compare against.

Detail	Description
Type	Boolean
Default	`isFalse`

Days since expiry

Provides the number of whole days since the document’s Expiry Date. Returns 0 when the document has not expired, or when the Expiry Date could not be determined. Important: when authoring a threshold rule, always combine this with Document Expiry Status = Expired, because Not Expired and Undeterminable documents also return 0 — a rule on Days Since Expiry alone (for example, <= 730) would match those too. Example: ‘Document Expiry Status is Expired AND Days Since Expiry <= 730’ accepts only documents that expired within a 730-day / ~2-year grace period.

Detail	Description
Type	Integer
Range	0–36500
Default	`0`

Calculated age

Provides a calculated Age (in years) based on date of birth and current date.

Detail	Description
Type	Integer
Range	0–130
Default	`0`

Document expiry status

Provides the document’s Expiry status.

Value	Description
`Expired`	Document has expired.
`Not Expired`	Document has not expired.
`Undeterminable`	Document expiry status could not be determined.

Document extraction result

Provides an extraction result based on the customer’s required extraction data (as defined in configuration).

Value	Description
`Extraction Successful`	Extraction Successful
`Extraction Unsuccessful`	Extraction Unsuccessful

Back side full document in view check

Returns Back Side Full Document In View Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Front side full document in view check

Returns Front Side Full Document In View Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Back side colour check

Returns Back Side Colour Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Front side colour check

Returns Front Side Colour Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Back side blur check

Returns Back Side Blur Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Front side blur check

Returns Front Side Blur Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Back side glare check

Returns Back Side Glare Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Front side glare check

Returns Front Side Glare Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Back side low resolution check

Returns Back Side Low Resolution Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Front side low resolution check

Returns Front Side Low Resolution Check result

Value	Description
`Passed`	Check has passed.
`Failed`	Check has failed.
`Skipped`	Check has skipped, this is usually caused when an underlying requirement has not been met.
`Undetermined`	This check was not able to be determined.
`Excluded`	This check was excluded, this can be because the second side was not provide or not applicable, it can also be because additional checks as set in configuration where disable, for example Document Liveness was set to false.

Country name

Returns the full country name

Value	Description
`Afghanistan`	Afghanistan
`Albania`	Albania
`Algeria`	Algeria
`American Samoa`	American Samoa
`Andorra`	Andorra
`Angola`	Angola
`Anguilla`	Anguilla
`Antarctica`	Antarctica
`Antigua and Barbuda`	Antigua and Barbuda
`Argentina`	Argentina
`Armenia`	Armenia
`Aruba`	Aruba
`Australia`	Australia
`Austria`	Austria
`Azerbaijan`	Azerbaijan
`Bahamas`	Bahamas
`Bahrain`	Bahrain
`Bangladesh`	Bangladesh
`Barbados`	Barbados
`Belarus`	Belarus
`Belgium`	Belgium
`Belize`	Belize
`Benin`	Benin
`Bermuda`	Bermuda
`Bhutan`	Bhutan
`Bolivia`	Bolivia
`Bolivia, Plurinational State of`	Bolivia, Plurinational State of
`Bosnia and Herzegovina`	Bosnia and Herzegovina
`Botswana`	Botswana
`Brazil`	Brazil
`British Indian Ocean Territory`	British Indian Ocean Territory
`Brunei Darussalam`	Brunei Darussalam
`Bulgaria`	Bulgaria
`BurkinaFaso`	BurkinaFaso
`Burundi`	Burundi
`Cabo Verde`	Cabo Verde
`Cambodia`	Cambodia
`Cameroon`	Cameroon
`Canada`	Canada
`Cayman`	Cayman
`Cayman Islands`	Cayman Islands
`Central African Republic`	Central African Republic
`Chad`	Chad
`Chile`	Chile
`China`	China
`Colombia`	Colombia
`Comoros`	Comoros
`Congo`	Congo
`Congo, Democratic Republic of the`	Congo, Democratic Republic of the
`Cook Islands`	Cook Islands
`Costa Rica`	Costa Rica
`Cote D'Ivoire`	Cote D’Ivoire
`Croatia`	Croatia
`Cuba`	Cuba
`Curaçao`	Curaçao
`Cyprus`	Cyprus
`Czech Republic`	Czech Republic
`Czechia`	Czechia
`Denmark`	Denmark
`Djibouti`	Djibouti
`Dominica`	Dominica
`Dominican`	Dominican
`Dominican Republic`	Dominican Republic
`Ecuador`	Ecuador
`Egypt`	Egypt
`El Salvador`	El Salvador
`Equatorial Guinea`	Equatorial Guinea
`Eritrea`	Eritrea
`Estonia`	Estonia
`Eswatini`	Eswatini
`Ethiopia`	Ethiopia
`Falkland Islands (Malvinas)`	Falkland Islands (Malvinas)
`Faroe Islands`	Faroe Islands
`Fiji`	Fiji
`Finland`	Finland
`France`	France
`French Guiana`	French Guiana
`French Polynesia`	French Polynesia
`French Southern Territories`	French Southern Territories
`Gabon`	Gabon
`Gambia`	Gambia
`Georgia`	Georgia
`Germany`	Germany
`Ghana`	Ghana
`Gibraltar`	Gibraltar
`Greece`	Greece
`Greenland`	Greenland
`Grenada`	Grenada
`Greneda`	Greneda
`Guatemala`	Guatemala
`Guinea`	Guinea
`Guinea-Bissau`	Guinea-Bissau
`Guyana`	Guyana
`Haiti`	Haiti
`Honduras`	Honduras
`Hong Kong`	Hong Kong
`Hungary`	Hungary
`Iceland`	Iceland
`India`	India
`Indonesia`	Indonesia
`Iran`	Iran
`Iran, Islamic Republic of`	Iran, Islamic Republic of
`Iraq`	Iraq
`Ireland`	Ireland
`Israel`	Israel
`Italy`	Italy
`Jamaica`	Jamaica
`Japan`	Japan
`Jordan`	Jordan
`Kazakhstan`	Kazakhstan
`Kenya`	Kenya
`Kiribati`	Kiribati
`Korea`	Korea
`Korea, Republic of`	Korea, Republic of
`Kosovo`	Kosovo
`Kuwait`	Kuwait
`Kyrgyzstan`	Kyrgyzstan
`Lao`	Lao
`Lao People's Democratic Republic`	Lao People’s Democratic Republic
`Laos`	Laos
`Latvia`	Latvia
`Lebanon`	Lebanon
`Lesotho`	Lesotho
`Liberia`	Liberia
`Libya`	Libya
`Liechtenstein`	Liechtenstein
`Lithuania`	Lithuania
`Luxembourg`	Luxembourg
`Macedonia`	Macedonia
`Madagascar`	Madagascar
`Malawi`	Malawi
`Malaysia`	Malaysia
`Maldives`	Maldives
`Mali`	Mali
`Malta`	Malta
`Marshall Islands`	Marshall Islands
`Mauritania`	Mauritania
`Mauritius`	Mauritius
`Mexico`	Mexico
`Micronesia, Federated States of`	Micronesia, Federated States of
`Moldova`	Moldova
`Moldova, Republic of`	Moldova, Republic of
`Monaco`	Monaco
`Mongolia`	Mongolia
`Montenegro`	Montenegro
`Montserrat`	Montserrat
`Morocco`	Morocco
`Mozambique`	Mozambique
`Myanmar`	Myanmar
`Namibia`	Namibia
`Nepal`	Nepal
`Netherlands`	Netherlands
`Netherlands, Kingdom of the`	Netherlands, Kingdom of the
`New Caledonia`	New Caledonia
`New Zealand`	New Zealand
`Nicaragua`	Nicaragua
`Niger`	Niger
`Nigeria`	Nigeria
`North Macedonia`	North Macedonia
`Norway`	Norway
`Oman`	Oman
`Pakistan`	Pakistan
`Palestinian Territories`	Palestinian Territories
`Panama`	Panama
`Papua New Genua`	Papua New Genua
`Papua New Guinea`	Papua New Guinea
`Paraguay`	Paraguay
`Peru`	Peru
`Philippines`	Philippines
`Poland`	Poland
`Portugal`	Portugal
`Puerto Rico`	Puerto Rico
`Qatar`	Qatar
`Republic of Congo`	Republic of Congo
`Romania`	Romania
`Russia`	Russia
`Russian Federation`	Russian Federation
`Rwanda`	Rwanda
`Saint Christopher St Kitts and Nevis`	Saint Christopher St Kitts and Nevis
`Saint Kitts and Nevis`	Saint Kitts and Nevis
`Saint Lucia`	Saint Lucia
`Saint Vincent And the Grenadines`	Saint Vincent And the Grenadines
`Samoa`	Samoa
`San Marino`	San Marino
`Sao Tome and Principe`	Sao Tome and Principe
`Saudi Arabia`	Saudi Arabia
`Senegal`	Senegal
`Serbia`	Serbia
`Seychelles`	Seychelles
`Sierra Leone`	Sierra Leone
`Singapore`	Singapore
`Sint Maarten`	Sint Maarten
`Sint Maarten (Dutch part)`	Sint Maarten (Dutch part)
`Slovakia`	Slovakia
`Slovenia`	Slovenia
`Solomon Islands`	Solomon Islands
`Somali`	Somali
`Somalia`	Somalia
`Somaliland`	Somaliland
`South Africa`	South Africa
`South Sudan`	South Sudan
`Spain`	Spain
`Sri Lanka`	Sri Lanka
`Sudan`	Sudan
`Suriname`	Suriname
`Swaziland`	Swaziland
`Sweden`	Sweden
`Switzerland`	Switzerland
`Syria`	Syria
`Syrian Arab Republic`	Syrian Arab Republic
`Taiwan`	Taiwan
`Taiwan, Province of China`	Taiwan, Province of China
`Tajikistan`	Tajikistan
`Tanzania`	Tanzania
`Tanzania, United Republic of`	Tanzania, United Republic of
`Thailand`	Thailand
`Timor-Leste`	Timor-Leste
`Togo`	Togo
`Tokelau`	Tokelau
`Tonga`	Tonga
`Trinidad and Tobago`	Trinidad and Tobago
`Tunisia`	Tunisia
`Turkey`	Turkey
`Türkiye`	Türkiye
`Turkmenistan`	Turkmenistan
`Turks and Caicos Islands`	Turks and Caicos Islands
`Tuvalu`	Tuvalu
`Uganda`	Uganda
`Ukraine`	Ukraine
`United Arab Emirates`	United Arab Emirates
`United Arabic Emirates`	United Arabic Emirates
`United Kingdom`	United Kingdom
`United Kingdom of Great Britain and Northern Ireland`	United Kingdom of Great Britain and Northern Ireland
`United States of America`	United States of America
`UnitedNations`	UnitedNations
`Uruguay`	Uruguay
`Uzbekistan`	Uzbekistan
`Vanatu`	Vanatu
`Vanuatu`	Vanuatu
`Venezuela`	Venezuela
`Venezuela, Bolivarian Republic of`	Venezuela, Bolivarian Republic of
`Vietnam`	Vietnam
`Western Sahara`	Western Sahara
`Yemen`	Yemen
`Zambia`	Zambia
`Zimbabwe`	Zimbabwe

Document country code

Returns the country code in ISO3 format, eg. GBR.

Value	Description
`ABW`	ABW
`AFG`	AFG
`AGO`	AGO
`AIA`	AIA
`ALB`	ALB
`AND`	AND
`ARE`	ARE
`ARG`	ARG
`ARM`	ARM
`ASM`	ASM
`ATA`	ATA
`ATF`	ATF
`ATG`	ATG
`AUS`	AUS
`AUT`	AUT
`AZE`	AZE
`BDI`	BDI
`BEL`	BEL
`BEN`	BEN
`BFA`	BFA
`BGD`	BGD
`BGR`	BGR
`BHR`	BHR
`BHS`	BHS
`BIH`	BIH
`BLR`	BLR
`BLZ`	BLZ
`BMU`	BMU
`BOL`	BOL
`BRA`	BRA
`BRB`	BRB
`BRN`	BRN
`BTN`	BTN
`BWA`	BWA
`CAF`	CAF
`CAN`	CAN
`CHE`	CHE
`CHL`	CHL
`CHN`	CHN
`CMR`	CMR
`COD`	COD
`COG`	COG
`COK`	COK
`COL`	COL
`COM`	COM
`CPV`	CPV
`CRI`	CRI
`CUB`	CUB
`CUW`	CUW
`CYM`	CYM
`CYP`	CYP
`CZE`	CZE
`DEU`	DEU
`DJI`	DJI
`DMA`	DMA
`DNK`	DNK
`DOM`	DOM
`DZA`	DZA
`ECU`	ECU
`EGY`	EGY
`ERI`	ERI
`ESH`	ESH
`ESP`	ESP
`EST`	EST
`ETH`	ETH
`FIN`	FIN
`FJI`	FJI
`FLK`	FLK
`FRA`	FRA
`FRO`	FRO
`FSM`	FSM
`GAB`	GAB
`GBR`	GBR
`GEO`	GEO
`GHA`	GHA
`GIB`	GIB
`GIN`	GIN
`GMB`	GMB
`GMB`	GMB
`GNB`	GNB
`GNQ`	GNQ
`GRC`	GRC
`GRD`	GRD
`GRL`	GRL
`GTM`	GTM
`GUF`	GUF
`GUY`	GUY
`HKG`	HKG
`HND`	HND
`HRV`	HRV
`HTI`	HTI
`HUN`	HUN
`IDN`	IDN
`IND`	IND
`IOT`	IOT
`IRL`	IRL
`IRN`	IRN
`IRQ`	IRQ
`ISL`	ISL
`ISR`	ISR
`ITA`	ITA
`JAM`	JAM
`JOR`	JOR
`JPN`	JPN
`KAZ`	KAZ
`KEN`	KEN
`KGZ`	KGZ
`KHM`	KHM
`KIR`	KIR
`KNA`	KNA
`KOR`	KOR
`KWT`	KWT
`LAO`	LAO
`LBN`	LBN
`LBR`	LBR
`LBY`	LBY
`LCA`	LCA
`LIE`	LIE
`LKA`	LKA
`LTU`	LTU
`LUX`	LUX
`LVA`	LVA
`MAR`	MAR
`MCO`	MCO
`MDA`	MDA
`MDG`	MDG
`MDV`	MDV
`MEX`	MEX
`MHL`	MHL
`MKD`	MKD
`MLI`	MLI
`MLT`	MLT
`MMR`	MMR
`MNE`	MNE
`MNG`	MNG
`MOZ`	MOZ
`MRT`	MRT
`MSR`	MSR
`MUS`	MUS
`MWI`	MWI
`MYS`	MYS
`NAM`	NAM
`NCL`	NCL
`NER`	NER
`NGA`	NGA
`NIC`	NIC
`NLD`	NLD
`NOR`	NOR
`NPL`	NPL
`NZL`	NZL
`OMN`	OMN
`PAK`	PAK
`PAN`	PAN
`PER`	PER
`PHL`	PHL
`PNG`	PNG
`POL`	POL
`PRT`	PRT
`PRY`	PRY
`PYF`	PYF
`QAT`	QAT
`ROU`	ROU
`RUS`	RUS
`RWA`	RWA
`SDN`	SDN
`SEN`	SEN
`SGP`	SGP
`SLB`	SLB
`SLE`	SLE
`SLV`	SLV
`SMR`	SMR
`SOM`	SOM
`SSD`	SSD
`STP`	STP
`SUR`	SUR
`SVK`	SVK
`SVN`	SVN
`SWE`	SWE
`SWZ`	SWZ
`SXM`	SXM
`SYC`	SYC
`SYR`	SYR
`TCA`	TCA
`TCD`	TCD
`TGO`	TGO
`THA`	THA
`TJK`	TJK
`TKL`	TKL
`TKM`	TKM
`TLS`	TLS
`TON`	TON
`TTO`	TTO
`TUN`	TUN
`TUR`	TUR
`TUV`	TUV
`TWN`	TWN
`TZA`	TZA
`UGA`	UGA
`UKR`	UKR
`URY`	URY
`USA`	USA
`UZB`	UZB
`VCT`	VCT
`VEN`	VEN
`VNM`	VNM
`VUT`	VUT
`WSM`	WSM
`YEM`	YEM
`ZAF`	ZAF
`ZMB`	ZMB
`ZWE`	ZWE
`Unknown`	Unknown

State name

Returns the state name if applicable.

Value	Description
`Alabama`	Alabama
`Alaska`	Alaska
`Arizona`	Arizona
`Arkansas`	Arkansas
`Australian Capital Territory`	Australian Capital Territory
`California`	California
`Colorado`	Colorado
`Connecticut`	Connecticut
`Curacao`	Curacao
`Delaware`	Delaware
`Florida`	Florida
`Georgia`	Georgia
`Guam`	Guam
`Guernsey`	Guernsey
`Hawaii`	Hawaii
`Idaho`	Idaho
`Illinois`	Illinois
`Indiana`	Indiana
`Iowa`	Iowa
`Isle of Man`	Isle of Man
`Jersey`	Jersey
`Kansas`	Kansas
`Kentucky`	Kentucky
`Louisiana`	Louisiana
`Maine`	Maine
`Maryland`	Maryland
`Massachusetts`	Massachusetts
`Michigan`	Michigan
`Minnesota`	Minnesota
`Mississippi`	Mississippi
`Missouri`	Missouri
`Montana`	Montana
`Nebraska`	Nebraska
`Nevada`	Nevada
`New Hampshire`	New Hampshire
`New Jersey`	New Jersey
`New Mexico`	New Mexico
`New South Wales`	New South Wales
`New York`	New York
`North Carolina`	North Carolina
`North Dakota`	North Dakota
`Northern Ireland`	Northern Ireland
`Northern Territory`	Northern Territory
`Ohio`	Ohio
`Oklahoma`	Oklahoma
`Oregon`	Oregon
`Pennsylvania`	Pennsylvania
`Queensland`	Queensland
`Rhode Island`	Rhode Island
`South Australia`	South Australia
`South Carolina`	South Carolina
`South Dakota`	South Dakota
`Tasmania`	Tasmania
`Tennessee`	Tennessee
`Texas`	Texas
`Utah`	Utah
`Vermont`	Vermont
`Victoria`	Victoria
`Virginia`	Virginia
`Wales`	Wales
`Washington`	Washington
`West Virginia`	West Virginia
`Western Australia`	Western Australia
`Wisconsin`	Wisconsin
`Wyoming`	Wyoming
`Unknown`	Unknown

Document type

Returns the type of document, for example: Passport, Identification Card, etc.

Value	Description
`Driving License`	Driving License
`Identification Card`	Identification Card
`Passport`	Passport
`Military Identification`	Military Identification
`Residence Document`	Includes Green Card, Resident-related document, residence-related document issued to non-nationals
`Travel Card`	Includes FAST Card, travel document issued to non-nationals
`Tribal Card`	Tribal Card
`Visa`	Including immigrant visa, re-entry permit, entry paper
`Voter Identification`	Voter Identification
`Worker Identification`	Including occupational license
`Merchant Mariner Credential`	Includes seafarer’s ID document
`Other`	Includes weapons license, birth certificate, medical card, and other document types
`Unknown`	Unknown or unclassified document type
`Drivers License`	Drivers License

Document classification result

Overall Classification Result for Classification Module

Value	Description
`Document Classified`	Document was successfully classified.
`Document NOT Classified`	Document was not classified.

The following guides and tutorials use this module or explain how to configure it.

Identity document verification

Verify a customer’s identity document.

How to combine document and biometric modules

Ordering documents and biometrics.

​Capabilities

​Classification capabilities

​Image quality checks

​Front side checks

​Back side checks

​Extraction capabilities

​Authentication capabilities

​Default outcomes

​Input payload

​Sample response