SDK Response Definitions and Samples

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”: “NO”,
        “CardData”: [
            {
                “Key”: “CountryOfIssue”,
                “Value”: “Australia”
            },
            {
                “Key”: “CardType”,
                “Value”: “AUS_NSW_DRIVERLICENCE”
            },
            {
                “Key”: “Issuer”,
                “Value”: “New South Wales, Australia”
            },
            {
                “Key”: “CardStyle”,
                “Value”: “1.2"
            },
            {
                “Key”: “CardNumber”,
                “Value”: “2045597996"
            },
            {
                “Key”: “LastName”,
                “Value”: “BUDIMAN”
            },
            {
                “Key”: “FirstName”,
                “Value”: “Mathew ”
            },
            {
                “Key”: “MiddleName”,
                “Value”: “Femando ”
            },
            {
                “Key”: “DOB”,
                “Value”: “12/02/2002"
            },
            {
                “Key”: “Sex”,
                “Value”: “”
            },
            {
                “Key”: “Nationality”,
                “Value”: “”
            },
            {
                “Key”: “Address”,
                “Value”: “71 BURNS RD KELLYVILLE NSW 2155"
            },
            {
                “Key”: “Street”,
                “Value”: “71 BURNS RD”
            },
            {
                “Key”: “City”,
                “Value”: “KELLYVILLE ”
            },
            {
                “Key”: “State”,
                “Value”: “NSW ”
            },
            {
                “Key”: “ZipCode”,
                “Value”: “2155"
            },
            {
                “Key”: “LicenceNumber”,
                “Value”: “15987694"
            },
            {
                “Key”: “LicenceClass”,
                “Value”: “C”
            },
            {
                “Key”: “LicenceCondition”,
                “Value”: “S”
            },
            {
                “Key”: “LicenceType”,
                “Value”: “”
            },
            {
                “Key”: “LicenceVersion”,
                “Value”: “”
            },
            {
                “Key”: “Donor”,
                “Value”: “”
            },
            {
                “Key”: “Entitlements”,
                “Value”: “”
            },
            {
                “Key”: “IssueDate”,
                “Value”: “”
            },
            {
                “Key”: “ExpiryDate”,
                “Value”: “14/07/2029"
            }
        ],
        “Analysis”: [
            {
                “Key”: “Over18”,
                “Value”: “YES”
            },
            {
                “Key”: “Expired”,
                “Value”: “NO”
            },
            {
                “Key”: “ImageQuality”,
                “Value”: “Bad”
            }
        ],
        “StatusCode”: “200”,
        “StatusMessage”: “Success”
    }
}

Field	Data Type	Description
CountryOfIssue	String	Country of issue
CardType	String	Type code of the document For example PASSPORT, NSW_DRIVERLICENCE, AUS_MEDICARE and etc.
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 MRZOCRResult object (see details here). It contains information like the card type, document type, and document validation.

{
    “CardData”: [
        {
            “Key”: “DocumentType”,
            “Value”: “Passport”
        },
        {
            “Key”: “CountryofIssue”,
            “Value”: “Australia”
        },
        {
            “Key”: “LastName”,
            “Value”: “BUDIMAN”
        },
        {
            “Key”: “FirstName”,
            “Value”: “MATHEW”
        },
        {
            “Key”: “MiddleName”,
            “Value”: “FERNANDO”
        },
        {
            “Key”: “DocumentNumber”,
            “Value”: “N9733796”
        },
        {
            “Key”: “Nationality”,
            “Value”: “Australia”
        },
        {
            “Key”: “DateofBirth”,
            “Value”: “920212”
        },
        {
            “Key”: “Sex”,
            “Value”: “M”
        },
        {
            “Key”: “DateofExpiry”,
            “Value”: “240407”
        },
        {
            “Key”: “PersonalNumber”,
            “Value”: “34984427D”
        }
    ],
    “StatusMessage”: “Success.“,
    “StatusCode”: “200"
}

Field	Data Type	Description
CardType	String	Type code of the document For example PASSPORT, NSW_DRIVERLICENCE, AUS_MEDICARE and etc.
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 Card Sample Results

The code below shows a medicare sample results in an Orbit4MedicareResult 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”: “4189 15134 9",
                “Accuracy”: “100"
            },
            {
                “Key”: “IdentifierNo”,
                “Value”: “4189 1513",
                “Accuracy”: “100"
            },
            {
                “Key”: “IssueNo”,
                “Value”: “9",
                “Accuracy”: “100"
            },
            {
                “Key”: “Checksum”,
                “Value”: “4",
                “Accuracy”: “100"
            },
            {
                “Key”: “User 1",
                “Value”: “DEBORAH B RYAN”,
                “IRN”: “1",
                “Accuracy”: “100"
            },
            {
                “Key”: “User 2",
                “Value”: “STEPHEN O RYAN”,
                “IRN”: “2",
                “Accuracy”: “100"
            },
            {
                “Key”: “User 3",
                “Value”: “JACK O RYAN”,
                “IRN”: “3",
                “Accuracy”: “100"
            },
            {
                “Key”: “User 4",
                “Value”: “ALEXANDER O RYAN”,
                “IRN”: “4",
                “Accuracy”: “100"
            },
            {
                “Key”: “User 5",
                “Value”: “MATILDA B RYAN”,
                “IRN”: “5",
                “Accuracy”: “100"
            },
            {
                “Key”: “ValidTo”,
                “Value”: “04/2019",
                “Accuracy”: “100"
            }
        ],
        “AsfCheck”: [
            {
                “Key”: “Mark”,
                “Value”: “751, 87”,
                “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 For example PASSPORT, NSW_DRIVERLICENCE, AUS_MEDICARE and etc.
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.