This section will provide you with a sample result that you may receive when using various functions that we have in our SDK.
Driver Licence and ID card Sample Results
The code below shows a sample result for the user's card information (see details here). It contains personal user data, card, or license information.
{
"CardInfo": {
"RecognizedFrontImage": "YES",
"RecognizedBackImage": "NO",
"FaceImage": "YES",
"CardData": [
{
"Key": "CountryOfIssue",
"Value": "Australia"
},
{
"Key": "CardType",
"Value": "AUS_NSW_DRIVERLICENCE"
},
{
"Key": "Issuer",
"Value": "New South Wales, Australia"
},
{
"Key": "CardStyle",
"Value": "1.1"
},
{
"Key": "CardNumber",
"Value": "1111111111"
},
{
"Key": "LastName",
"Value": "CITIZEN"
},
{
"Key": "FirstName",
"Value": "JANE "
},
{
"Key": "MiddleName",
"Value": "MICHELLE "
},
{
"Key": "DOB",
"Value": "12/02/1992"
},
{
"Key": "Sex",
"Value": ""
},
{
"Key": "Nationality",
"Value": ""
},
{
"Key": "Address",
"Value": "71 GREEN STREET KELLYVILLE NSW 2106"
},
{
"Key": "Street",
"Value": "71 GREEN STREET"
},
{
"Key": "City",
"Value": "KELLYVILLE NSW 2106"
},
{
"Key": "State",
"Value": "NSW"
},
{
"Key": "ZipCode",
"Value": ""
},
{
"Key": "LicenceNumber",
"Value": "11111111"
},
{
"Key": "LicenceClass",
"Value": "C"
},
{
"Key": "LicenceCondition",
"Value": "8"
},
{
"Key": "LicenceType",
"Value": ""
},
{
"Key": "LicenceVersion",
"Value": ""
},
{
"Key": "Donor",
"Value": ""
},
{
"Key": "Entitlements",
"Value": ""
},
{
"Key": "IssueDate",
"Value": ""
},
{
"Key": "ExpiryDate",
"Value": "14/07/2020"
}
],
"Analysis": [
{
"Key": "Over18",
"Value": "YES"
},
{
"Key": "Expired",
"Value": "YES"
},
{
"Key": "ImageQuality",
"Value": "Bad"
}
],
"StatusCode": "200",
"StatusMessage": "Success"
}
}
Definitions
Field | Data Type | Description |
|---|---|---|
CountryOfIssue | String | Country of issue |
CardType | String | Type code of the document |
Issuer | String | Issuer of the document i.e. SNSW |
CardStyle | String | This is the variant of the card/sub variant |
CardNumber | String | This is the card number/document number the is printed on the card |
LastName | String | Last name of the customer |
FirstName | String | First name of the customer |
MiddleName | String | Middle name of the customer |
DOB | String | Date of birth of the card holder, default date format is “DD/MM/YYYY”. Possible to have this configured. |
Sex | String | The sex of the person printed on the document if supplied. |
Nationality | String | The nationality of the individual shown on the document if supplied. |
Address | String | Address of the customer |
Street | String | Street number, name and type |
City | String | Suburb, State and Postal Code |
State | String | State code |
ZipCode | String | Also known as Postal code in Australia/NZ |
ChangeOfAddress | String | Address that appears on a “change of address sticker” |
LicenceNumber | String | This is the Licence number that is listed on the document. |
LicenceClass | String | This is the class that appears on the document as printed by authorities. Typically Driver Licence documents. |
LicenceCondition | String | Driver Licence Condition, these would be included if the individual has requirements to drive or restrictions (i.e. Glasses). |
LicenceType | String | Driver Licence Type is not available on all documents. Typically NZ documents. |
LicenceVersion | String | This is applicable for NZ documents. Not Australia. |
Donor | String | Indicates if the individual is an organ donor. Not applicable on all documents. |
Entitlements | String | This is optional for documents. Usually a “special” or “professional” driver licence includes these. |
IssueDate | String | The date of issue of the document |
ExpiryDate | String | Default format is DD/MM/YYYY. Possible to have this configured. |
Over18 | Boolean | YES/NO - This is if the individual is determined to be over 18years of age based on the printed date of birth on the document. |
Expired | Boolean | YES/NO - This is calculated based on the expiration date on the document. YES is defined to be expired. NO is not. |
ImageQuality | Boolean | Bad/Good - This is a calculation on the image quality based on blur factor and light conditions. If “Bad” you may ask the user to recapture. Good indicated a higher chance of a better OCR read result. |
Passport Sample Results
The code below shows a passport sample results in an MRZOCResult object (see details here). It contains information like the card type, document type, and document validation.
{
"DocData": [
{
"Key": "CardType",
"Value": "MRZ",
"Accuracy": [
"100",
"100",
"100",
"100",
"100",
"100"
]
},
{
"Key": "Validation",
"Value": "FALSE",
"Accuracy": [
"100",
"100",
"100",
"100",
"100",
"100"
]
},
{
"Key": "DocumentType",
"Value": "Passport",
"Accuracy": [
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80"
]
},
{
"Key": "CountryOfIssue",
"Value": "Australia",
"Accuracy": [
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80"
]
},
{
"Key": "LastName",
"Value": "CITIZEN",
"Accuracy": [
"161",
"110",
"273",
"184",
"213",
"215",
"134"
]
},
{
"Key": "FirstName",
"Value": "JANE",
"Accuracy": [
"162",
"214",
"88",
"129",
"72",
"395",
"0"
]
},
{
"Key": "MiddleName",
"Value": "MICHELLE",
"Accuracy": [
"49",
"88",
"241",
"95",
"180",
"133",
"367",
"115",
"0"
]
},
{
"Key": "DocumentNumber",
"Value": "NXXXXXXX",
"Accuracy": [
"127",
"30",
"162",
"197",
"284",
"236",
"48",
"77",
"0"
]
},
{
"Key": "Nationality",
"Value": "Australia",
"Accuracy": [
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80"
]
},
{
"Key": "DateOfBirth",
"Value": "12\/02\/1992",
"Accuracy": [
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80"
]
},
{
"Key": "Sex",
"Value": "M",
"Accuracy": [
"269"
]
},
{
"Key": "DateOfExpiry",
"Value": "07\/04\/2024",
"Accuracy": [
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80",
"80"
]
},
{
"Key": "PersonalNumber",
"Value": "30000007D",
"Accuracy": [
"67",
"816",
"72",
"91",
"1062",
"801",
"197",
"261",
"521",
"0"
]
}
]
}
Field | Data Type | Description |
|---|---|---|
CardType | String | Type code of the document |
Validation | Boolean | True/False This is an ISO format check. Note: Some passports do not conform to the latest standards so it is possible to have a False value. |
DocumentType | String | This is the type of document it is. (i.e. Passport, ID card which supports MRZ scanning) |
CountryOfIssue | String | Country of issue |
LastName | String | Last name of the customer |
FirstName | String | First name of the customer |
MiddleName | String | Middle name of the customer |
DocumentNumber | String | This is the Passport number that is printed on the passport or ID. |
Nationality | String | The nationality of the individual shown on the document if supplied. |
DateOfBirth | String | Date of birth of the card holder, default date format is “DD/MM/YYYY”. Possible to have this configured. See Code sample for possible formats. |
Sex | String | The sex of the person printed on the document if supplied. |
DateOfExpiry | String | Default format is DD/MM/YYYY. Possible to have this configured. |
PersonalNumber | String | This is applicable for passports, it is a secondary document number. |
Medicare Sample Results
The code below shows a medicare sample result in a MedicareOCResult object (see details here). It contains information like the card type, medicare, and user.
{
"CardInfo": {
"RecognizedFrontImage": "YES",
"RecognizedBackImage": "NO",
"FaceImage": "NO",
"CardData": [
{
"Key": "CardType",
"Value": "AUS_MEDICARE",
"Accuracy": "100"
},
{
"Key": "CountryOfIssue",
"Value": "Australia",
"Accuracy": "100"
},
{
"Key": "Issuer",
"Value": "MedicareCard",
"Accuracy": "100"
},
{
"Key": "MedicareId",
"Value": "4111 11111 19",
"Accuracy": "100"
},
{
"Key": "IdentifierNo",
"Value": "1111 1513",
"Accuracy": "100"
},
{
"Key": "IssueNo",
"Value": "9",
"Accuracy": "100"
},
{
"Key": "Checksum",
"Value": "4",
"Accuracy": "100"
},
{
"Key": "User 1",
"Value": "DEBORAH CITIZEN",
"IRN": "1",
"Accuracy": "100"
},
{
"Key": "User 2",
"Value": "STEPHEN CITIZEN",
"IRN": "2",
"Accuracy": "100"
},
{
"Key": "User 3",
"Value": "JACK CITIZEN",
"IRN": "3",
"Accuracy": "100"
},
{
"Key": "User 4",
"Value": "ALEXANDER CITIZEN",
"IRN": "4",
"Accuracy": "100"
},
{
"Key": "User 5",
"Value": "MATILDA CITIZEN",
"IRN": "5",
"Accuracy": "100"
},
{
"Key": "ValidTo",
"Value": "04/2025",
"Accuracy": "100"
}
],
"AsfCheck": [
{
"Key": "Mark",
"Value": "748, 99",
"Accuracy": "100"
},
{
"Key": "Hologram",
"Value": "yes",
"Accuracy": "100"
},
{
"Key": "CardColour",
"Value": "Green",
"Accuracy": "100"
}
],
"StatusCode": "200",
"StatusMessage": "Success"
}
}
Field | Data Type | Description |
|---|---|---|
RecognizedFrontImage | Boolean | Yes/No As medicare is a front only document. This validates if the front was only captured. |
RecognizedBackImage | Boolean | Yes/No - This validates if the back of card was captured for a Medicare document. This should be recaptured if Yes. |
FaceImage | Boolean | This should always be a No on Medicare. Australian Medicare cards do not have a face on images like other countries supported. |
CardType | String | Type code of the document |
CountryOfIssue | String | Country of issue |
Issuer | String | Issuer of the document i.e. MedicareCard |
MedicareID | String | This is the full card number/document number the is printed on the document. This includes the Issue number (the last digit on the Medicare Card number). |
IdentiferNo | String | This is the card number/document number as printed on the document without the issue number. |
IssueNo | String | This is the last digit of the Medicare Card number, known as “Issue Number”. |
Checksum | String | The number of individuals on a card. |
User X | String | This is the full name of the individual X that is printed on the card. If the individuals name spans across multiple lines you will receive a X-1, X-2 to indicate it is the same name. |
IRN | String | Refers to the allocated number next to the individuals name. An IRN will be listed for each user. |
ValidTo | String | This is when the card expires. Note that the response not include a DD and only MM/YYYY |
Mark | String | This identifies the location of the Medicare Logo for Medicare Card scanning solutions in Healthcare. |
Hologram | Boolean | Yes/No - This indicates if the Hologram was detected. |
CardColour | String | Green, Blue, Yellow are possible values. |
StatusCode | String | Status code 200 for success, all other status code will be considered as failure scanning. |
StatusMessage | String | For successful scan status message will be “Success”, otherwise failure specific error messages will be sent from OCR engine. |
💬 We're here to help!
If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.