> ## Documentation Index > Fetch the complete documentation index at: https://docs.go.gbgplc.com/llms.txt > Use this file to discover all available pages before exploring further. # Document Classification > Identify the type of identity document submitted in GBG GO, including document type and issuing authority, before downstream verification. The **Document Classification** module identifies the type of identity document a user has submitted by analysing captured images. It determines the document type, for example, whether it's a passport, driving licence, or national ID card, and where it was issued. ## Document Classification V2 Document Classification will process both single and double-sided Identity Documents. The output includes a Classification status, Document Type, Document Issue Year, Country Code, State Name (if available) and other Capture-level checks. The complete classification details are also included in the Document object under Subject. ### Capabilities The module returns a structured set of capabilities grouped into three areas: classification result, document identification, and image capture quality checks. Each capability returns a single value that downstream evaluation logic can act on. #### Document classification result The overall outcome of the classification attempt, indicating whether the module was able to identify the document type. | Value | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Document Classified` | The document was successfully classified. The module identified the document type, issuing country, and other metadata. Downstream modules can proceed with type-specific verification. | | `Document NOT Classified` | The document could not be classified. This may occur when the image quality is too poor for analysis, the document type is not in the module's reference library, or the submitted image does not contain a recognisable identity document. This is the default value if classification fails. | #### Document type The type of identity document identified during classification (for example Passport, Identification Card, or Driving License). The value determines which verification rules and reference templates are applied by downstream modules such as Document Authentication. | Value | Description | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Driving License` | A government-issued driving licence. This is one of the most commonly submitted document types across all regions. | | `Identification Card` | A national or state-issued identification card that is not a driving licence. Examples include national ID cards, state ID cards, and government-issued photo ID cards. | | `Passport` | An internationally recognised travel document issued by a national government. Passports typically contain a machine-readable zone (MRZ) and may include biometric chip data. | | `Military Identification` | An identification card issued to military personnel by a government's armed forces. | | `Residence Document` | A document that confirms the holder's right to reside in a country. This includes permanent resident cards (e.g. US Green Card), residence permits, and residence-related documents issued to non-nationals. | | `Travel Card` | A document issued for cross-border travel that is not a full passport. This includes FAST cards (Free and Secure Trade), NEXUS cards, and travel documents issued to non-nationals. | | `Tribal Card` | An identification card issued by a recognised tribal authority. In the United States, tribal ID cards are issued by federally recognised Native American tribes and may be accepted as valid identification for certain purposes. | | `Visa` | A document or endorsement granting the holder permission to enter, stay in, or transit through a country. This includes immigrant visas, re-entry permits, and entry papers. | | `Voter Identification` | A card or document issued specifically to confirm voter registration and eligibility. These are common in countries where voter ID is required at polling stations. | | `Worker Identification` | An employment-related identification document. This includes occupational licences, work permits, and employer-issued ID cards that are backed by a government authority. | | `Merchant Mariner Credential` | A credential issued to maritime workers. This includes seafarer's identity documents (SIDs) issued under the ILO (International Labour Organization) convention, which serve as both professional certification and travel documentation for merchant sailors. | | `Other` | A document type that does not fit any of the above categories. This includes weapons licences, birth certificates, medical cards, and other government-issued documents that may be accepted for identity verification in certain contexts. | | `Unknown` | The document type could not be determined. This typically occurs when the image quality is insufficient for classification or the document is not in the module's reference library. | #### Document country code This capability returns the ISO 3166-1 alpha-3 country code of the country that issued the document (e.g. `GBR` for the United Kingdom, `USA` for the United States, `AUS` for Australia). The module supports documents from over 190 countries. If the issuing country cannot be determined, the value defaults to `Unknown`. The full list of supported country codes follows the ISO 3166-1 alpha-3 standard. Common examples include: | Value | Country | | ----- | -------------- | | `GBR` | United Kingdom | | `USA` | United States | | `AUS` | Australia | | `CAN` | Canada | | `DEU` | Germany | | `FRA` | France | | `IND` | India | | `NGA` | Nigeria | | `BRA` | Brazil | | `JPN` | Japan | #### Country name This capability returns the full name of the issuing country as a human-readable string (e.g. "United Kingdom", "United States of America", "Australia"). This value corresponds to the country code returned by the document country code capability. If the country cannot be determined, the value defaults to `Unknown`. #### State name This capability returns the name of the state, province, or territory that issued the document, where applicable. This is particularly relevant for countries where identity documents are issued at the sub-national level, such as driving licences in the United States and Australia. The module supports the following regions: * **United States**: All 50 states and the territories of Guam and American Samoa (via the country code, not the state name field). * **Australia**: All states and territories, including New South Wales, Queensland, Victoria, South Australia, Western Australia, Tasmania, Northern Territory, and Australian Capital Territory. * **United Kingdom and Crown Dependencies**: Northern Ireland, Wales, Guernsey, Jersey, and Isle of Man. * **Caribbean**: Curaçao. If the document was not issued at the state or territory level, or if the state cannot be determined, the value defaults to `Unknown`. #### Image capture quality checks The module performs a series of image quality assessments on both the front and back sides of the submitted document. These checks evaluate whether the captured images are of sufficient quality for accurate classification and downstream processing. Poor image quality is one of the most common causes of classification failure. Glare from reflective document surfaces, motion blur from camera movement, low resolution from distant capture, washed-out colour from poor lighting, and cropped edges from incorrect framing can all prevent the module from identifying the document. Each capture quality check returns one of the following values: | Value | Description | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Passed` | The check passed. The image meets the required quality threshold for this criterion. | | `Failed` | The check failed. The image does not meet the required quality threshold, which may affect the accuracy of classification or downstream processing. | | `Skipped` | The check was skipped because an underlying requirement was not met. For example, a back-side check is skipped if the document is single-sided. | | `Undetermined` | The check could not produce a definitive result. The image quality falls in an ambiguous range where neither a clear pass nor a clear fail can be determined. | | `Excluded` | The check was not performed because it was not applicable or was disabled in the module configuration. Common reasons include: the second side of the document was not provided, the check does not apply to the detected document type, or an optional check (such as document liveness) was disabled in the configuration. This is the default value. | The following checks are performed: * **Low resolution check**: Evaluates whether the captured image has sufficient pixel density for the module to accurately identify document features. Low-resolution images may result from the camera being too far from the document or from a device with a low-quality camera sensor. Insufficient resolution makes it difficult to read text, identify security features, and classify the document accurately. | Capability | Description | | --------------------------------- | ------------------------------------------------ | | `Front Side Low Resolution Check` | Assesses the resolution of the front side image. | | `Back Side Low Resolution Check` | Assesses the resolution of the back side image. | * **Glare check**: Detects reflective glare on the document surface. Glare typically appears as bright white spots or washed-out areas caused by overhead lighting, camera flash, or the reflective laminate coating found on many modern identity documents. Glare can obscure printed text, photographs, and security features, making the document unreadable to the classification engine. | Capability | Description | | ------------------------ | -------------------------------------- | | `Front Side Glare Check` | Detects glare on the front side image. | | `Back Side Glare Check` | Detects glare on the back side image. | * **Blur check**: Detects motion blur or focus blur in the captured image. Blur occurs when the camera or the document moves during capture, or when the camera fails to focus correctly on the document surface. Blurred images reduce the clarity of text, edges, and fine details that the classification engine relies on to identify document type. | Capability | Description | | ----------------------- | ----------------------------------------------- | | `Front Side Blur Check` | Assesses the sharpness of the front side image. | | `Back Side Blur Check` | Assesses the sharpness of the back side image. | * **Colour check**: Determines whether the image was captured in full colour. Some document features, such as colour-coded regions, flag emblems, and security holograms, require colour information for accurate classification. A greyscale or black-and-white image, for example, from a photocopy may lack the visual information needed to classify the document correctly. This check can also help detect photocopied documents, which are commonly used in fraud attempts. | Capability | Description | | ------------------------- | ------------------------------------------------------ | | `Front Side Colour Check` | Checks whether the front side image is in full colour. | | `Back Side Colour Check` | Checks whether the back side image is in full colour. | * **Full document in view check**: Verifies that the entire document is visible within the captured image frame. If any edges of the document are cropped or cut off, the module may be unable to identify the document type, read border-area text (such as MRZ data on passports), or detect edge-based security features. This check ensures that the user positioned the document correctly within the camera's field of view during capture. | Capability | Description | | ---------------------------------------- | --------------------------------------------------------------------------- | | `Front Side Full Document In View Check` | Checks whether the full front side of the document is visible in the image. | | `Back Side Full Document In View Check` | Checks whether the full back side of the document is visible in the image. | #### Default outcomes The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic: | Outcome | Condition | Description | | ------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Document Classified` | Document classification result is `Document Classified` | The document was successfully identified. The journey can proceed to downstream document modules. | | `Document NOT Classified` | Document classification result is `Document NOT Classified` | The document could not be identified. The journey may route to a retry step, manual review, or rejection depending on the configured evaluation logic. | | `ERROR` | Default (no conditions matched) | An unexpected error occurred during processing. This outcome acts as a fallback and typically indicates a system-level issue rather than a document quality problem. | ## Input payload The following is a sample payload used to submit document images to the **Document Classification** module for processing. ```json JSON theme={null} { "resourceId": "", "context": { "config": { "delivery": "api" }, "subject": { "documents": [ { "side1Image": "", "side2Image": "", "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. Can improve classification accuracy for double-sided documents. | ## Sample response The following is a sample response for a successfully classified document. ```json JSON theme={null} { "response": { "advice": { "DocumentClassificationResult": "Document Classified", "type": "Foreigner Identification Card", "subType": "Residence Permit", "countryCode": "GBR", "stateName": "Not available", "countryName": "United Kingdom", "frontSideLowResolutionCheck": "Passed", "backSideLowResolutionCheck": "Excluded", "frontSideGlareCheck": "Passed", "backSideGlareCheck": "Excluded", "frontSideBlurCheck": "Passed", "backSideBlurCheck": "Excluded", "frontSideColourCheck": "Passed", "backSideColourCheck": "Excluded", "frontSideFullDocumentInViewCheck": "Passed", "backSideFullDocumentInViewCheck": "Excluded", "frontSideDigitalTamperCheck": "Passed", "backSideDigitalTamperCheck": "Excluded", "frontSideDocumentLivenessCheck": "Passed", "backSideDocumentLivenessCheck": "Excluded", "frontSidePhotoSubstitutionCheck": "Passed", "backSidePhotoSubstitutionCheck": "Excluded" }, "outcome": "Document Classified" } } ``` ## Document classification V1 ### Capabilities #### Document classification result The overall outcome of the classification attempt, indicating whether the module was able to identify the document type. | Value | Description | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `Document Classified` | Document was successfully classified. | | `Document Classification Mismatch` | There was a classification mismatch, this means the classified front of the document did not correlate to the classified back of the document. | | `Document NOT Classified` | Document was not classified. | | `Document Partially Classified` | This means the first provided side of document was classified while the second provided side was not classified. | #### Document type The type of identity document identified during classification (for example Passport, National Identification Card, or Driving License). The value determines which verification rules and reference templates are applied by downstream modules such as Document Authentication. | Value | Description | | -------------------------------- | ------------------------------ | | `Agents License` | Agents License | | `Driving License` | Driving License | | `Electoral Card` | Electoral Card | | `Foreigner Identification Card` | Foreigner Identification Card | | `Health Card` | Health Card | | `Job License` | Job License | | `Membership Identification Card` | Membership Identification Card | | `Military Identification Card` | Military Identification Card | | `National Identification Card` | National Identification Card | | `Passport` | Passport | | `Proof of Age Card` | Proof of Age Card | | `Visa` | Visa | | `Weapons License` | Weapons License | | `Unknown` | Unknown | #### Document sub type Returns the Document sub-type - a Driving Licence sub-type could include e.g. "Provisional Driving License" or "Learner Driving License" | Value | Description | | ----------------------------------- | --------------------------------- | | `Bank Identification Card` | Bank Identification Card | | `Chauffeur License` | Chauffeur License | | `Commercial Driver's License` | Commercial Driver's License | | `Driving License Under 21` | Driving License Under 21 | | `Employment Authorization Card` | Employment Authorization Card | | `Employment Pass` | Employment Pass | | `Enhanced Driver License` | Enhanced Driver License | | `Graduated Driving License` | Graduated Driving License | | `Instructional Permit` | Instructional Permit | | `Laissez Passport` | Laissez Passport | | `Long Term Pass` | Long Term Pass | | `Operator License` | Operator License | | `Operator License Under 21` | Operator License Under 21 | | `Origin Card` | Origin Card | | `Passport` | Passport | | `Permanent Resident` | Permanent Resident | | `Personal Driving License` | Personal Driving License | | `Personalised Employment Pass` | Personalised Employment Pass | | `Service Passport` | Service Passport | | `State Identification Card` | State Identification Card | | `Taxi and Limousine Chauffeur` | Taxi and Limousine Chauffeur | | `Temporary Passport` | Temporary Passport | | `Training Employment Pass` | Training Employment Pass | | `Unif. Serv. ID and Privilege Card` | Unif. Serv. ID and Privilege Card | | `Unified Multi-Purpose ID` | Unified Multi-Purpose ID | | `Vehicle Registration Card` | Vehicle Registration Card | | `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 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 | #### Country name Returns the full country name | Value | Description | | -------------------------------------- | ------------------------------------ | | `Afghanistan` | Afghanistan | | `Albania` | Albania | | `Algeria` | Algeria | | `Andorra` | Andorra | | `Angola` | Angola | | `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 | | `Bolivia` | Bolivia | | `Bosnia and Herzegovina` | Bosnia and Herzegovina | | `Botswana` | Botswana | | `Brazil` | Brazil | | `Brunei Darussalam` | Brunei Darussalam | | `Bulgaria` | Bulgaria | | `BurkinaFaso` | BurkinaFaso | | `Burundi` | Burundi | | `Cambodia` | Cambodia | | `Cameroon` | Cameroon | | `Canada` | Canada | | `Cayman` | Cayman | | `Chile` | Chile | | `China` | China | | `Colombia` | Colombia | | `Congo` | Congo | | `Costa Rica` | Costa Rica | | `Cote D'Ivoire` | Cote D'Ivoire | | `Croatia` | Croatia | | `Cuba` | Cuba | | `Cyprus` | Cyprus | | `Czech Republic` | Czech Republic | | `Denmark` | Denmark | | `Dominica` | Dominica | | `Dominican` | Dominican | | `Ecuador` | Ecuador | | `Egypt` | Egypt | | `El Salvador` | El Salvador | | `Estonia` | Estonia | | `Ethiopia` | Ethiopia | | `Fiji` | Fiji | | `Finland` | Finland | | `France` | France | | `Gambia` | Gambia | | `Georgia` | Georgia | | `Germany` | Germany | | `Ghana` | Ghana | | `Greece` | Greece | | `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 | | `Iraq` | Iraq | | `Ireland` | Ireland | | `Israel` | Israel | | `Italy` | Italy | | `Jamaica` | Jamaica | | `Japan` | Japan | | `Jordan` | Jordan | | `Kazakhstan` | Kazakhstan | | `Kenya` | Kenya | | `Korea` | Korea | | `Kosovo` | Kosovo | | `Kuwait` | Kuwait | | `Kyrgyzstan` | Kyrgyzstan | | `Lao` | Lao | | `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 | | `Mauritius` | Mauritius | | `Mexico` | Mexico | | `Moldova` | Moldova | | `Monaco` | Monaco | | `Mongolia` | Mongolia | | `Montenegro` | Montenegro | | `Montserrat` | Montserrat | | `Morocco` | Morocco | | `Mozambique` | Mozambique | | `Myanmar` | Myanmar | | `Namibia` | Namibia | | `Nepal` | Nepal | | `Netherlands` | Netherlands | | `New Zealand` | New Zealand | | `Nicaragua` | Nicaragua | | `Nigeria` | Nigeria | | `Norway` | Norway | | `Oman` | Oman | | `Pakistan` | Pakistan | | `Palestinian Territories` | Palestinian Territories | | `Panama` | Panama | | `Papua New Genua` | Papua New Genua | | `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 | | `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 | | `Saudi Arabia` | Saudi Arabia | | `Senegal` | Senegal | | `Serbia` | Serbia | | `Seychelles` | Seychelles | | `Sierra Leone` | Sierra Leone | | `Singapore` | Singapore | | `Sint Maarten` | Sint Maarten | | `Slovakia` | Slovakia | | `Slovenia` | Slovenia | | `Somali` | Somali | | `Somaliland` | Somaliland | | `South Africa` | South Africa | | `South Sudan ` | South Sudan | | `Spain` | Spain | | `Sri Lanka` | Sri Lanka | | `Sudan` | Sudan | | `Swaziland` | Swaziland | | `Sweden` | Sweden | | `Switzerland` | Switzerland | | `Syria` | Syria | | `Taiwan` | Taiwan | | `Tajikistan` | Tajikistan | | `Tanzania` | Tanzania | | `Thailand` | Thailand | | `Togo` | Togo | | `Tonga` | Tonga | | `Trinidad and Tobago` | Trinidad and Tobago | | `Tunisia` | Tunisia | | `Turkey` | Turkey | | `Turkmenistan` | Turkmenistan | | `Uganda` | Uganda | | `Ukraine` | Ukraine | | `United Arabic Emirates` | United Arabic Emirates | | `United Kingdom` | United Kingdom | | `United States of America` | United States of America | | `UnitedNations ` | UnitedNations | | `Uruguay` | Uruguay | | `Uzbekistan` | Uzbekistan | | `Vanatu` | Vanatu | | `Venezuela` | Venezuela | | `Vietnam` | Vietnam | | `Yemen` | Yemen | | `Zambia` | Zambia | | `Zimbabwe` | Zimbabwe | #### Front side low resolution check Assesses whether the front side image has sufficient pixel density to identify document features accurately. Low resolution, from the camera being too far away or a low-quality sensor, makes text, security features, and document type harder to identify. | 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 Assesses whether the back side image has sufficient pixel density to identify document features accurately. Low resolution, from the camera being too far away or a low-quality sensor, makes text, security features, and document type harder to identify. | 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 Detects reflective glare on the front side of the document, such as bright spots or washed-out areas from overhead lighting, camera flash, or reflective document laminate, which can obscure printed text, photographs, and security features. | 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 Detects reflective glare on the back side of the document, such as bright spots or washed-out areas from overhead lighting, camera flash, or reflective document laminate, which can obscure printed text, photographs, and security features. | 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 Detects motion or focus blur on the front side image, caused by camera or document movement during capture or incorrect focus, which reduces the clarity of text, edges, and fine detail used for classification. | 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 Detects motion or focus blur on the back side image, caused by camera or document movement during capture or incorrect focus, which reduces the clarity of text, edges, and fine detail used for classification. | 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 Checks whether the front side image was captured in full colour. Colour-coded regions, flag emblems, and security holograms require colour information; a greyscale image (for example a photocopy) may lack the detail needed to classify the document and can indicate a photocopied document. | 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 Checks whether the back side image was captured in full colour. Colour-coded regions, flag emblems, and security holograms require colour information; a greyscale image (for example a photocopy) may lack the detail needed to classify the document and can indicate a photocopied document. | 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 Verifies that the entire front side of the document is visible within the captured image frame. Cropped or cut-off edges can prevent identifying the document type, reading border-area text such as passport MRZ data, or detecting edge-based security features. | 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 full document in view check Verifies that the entire back side of the document is visible within the captured image frame. Cropped or cut-off edges can prevent identifying the document type, reading border-area text such as passport MRZ data, or detecting edge-based security features. | 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 photo substitution check Returns Front Side Photo Substitution 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 photo substitution check Returns Back Side Photo Substitution 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 digital tamper check Returns Front Side Digital Tamper 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 digital tamper check Returns Back Side Digital Tamper 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 document liveness check Returns Front Side Document Liveness 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 document liveness check Returns Back Side Document Liveness 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. | #### Input payload The following is a sample payload used to submit data to the **Document classification V1** module for processing. ```json JSON theme={null} { "context": { "subject": { "documents": [ { "side1Image": "", "side2Image": "" } ], "identity": {} } } } ``` | Field | Required | Description | | ---------------------------- | -------- | --------------------------------------------------- | | `PrimaryDocument/side1Image` | Yes | \[Describe.] {/* TODO: written by the docs team */} | | `PrimaryDocument/side2Image` | No | \[Describe.] {/* TODO: written by the docs team */} | #### Sample response The following is a sample response returned by the module. ```json JSON theme={null} { "response": { "advice": { "DocumentClassificationResult": "Document Classified", "backSideBlurCheck": "Passed", "backSideColourCheck": "Passed", "backSideDigitalTamperCheck": "Passed", "backSideDocumentLivenessCheck": "Failed", "backSideFullDocumentInViewCheck": "Passed", "backSideGlareCheck": "Passed", "backSideLowResolutionCheck": "Passed", "backSidePhotoSubstitutionCheck": "Excluded", "countryCode": "GBR", "countryName": "United Kingdom", "frontSideBlurCheck": "Passed", "frontSideColourCheck": "Passed", "frontSideDigitalTamperCheck": "Passed", "frontSideDocumentLivenessCheck": "Passed", "frontSideFullDocumentInViewCheck": "Passed", "frontSideGlareCheck": "Passed", "frontSideLowResolutionCheck": "Passed", "frontSidePhotoSubstitutionCheck": "Passed", "stateName": "Not available", "subType": "Residence Permit", "type": "Foreigner Identification Card" }, "outcome": "Document Classified" } } ```