API docs by Redocly

Self-hosted API (4.7.0)

Download OpenAPI specification:

Schemas

AdditionalProcessingInfo

missingMandatoryFields
Array of strings or null (FieldType)
Enum: "ADDITIONAL_ADDRESS_INFORMATION" "ADDITIONAL_NAME_INFORMATION" "ADDITIONAL_OPTIONAL_ADDRESS_INFORMATION" "ADDITIONAL_PERSONAL_ID_NUMBER" "ADDRESS" "CLASS_EFFECTIVE_DATE" "CLASS_EXPIRY_DATE" "CONDITIONS" "DATE_OF_BIRTH" "DATE_OF_EXPIRY" "DATE_OF_ISSUE" "DOCUMENT_ADDITIONAL_NUMBER" "DOCUMENT_OPTIONAL_ADDITIONAL_NUMBER" "DOCUMENT_NUMBER" "EMPLOYER" "ENDORSEMENTS" "FATHERS_NAME" "FIRST_NAME" "FULL_NAME" "ISSUING_AUTHORITY" "LAST_NAME" "LICENCE_TYPE" "LOCALIZED_NAME" "MARITAL_STATUS" "MOTHERS_NAME" "MRZ" "NATIONALITY" "PERSONAL_ID_NUMBER" "PLACE_OF_BIRTH" "PROFESSION" "RACE" "RELIGION" "RESIDENTIAL_STATUS" "RESTRICTIONS" "SEX" "VEHICLE_CLASS" "BLOOD_TYPE" "SPONSOR" "VISA_TYPE" "NUMBER_OF_ENTRIES" "DURATION_OF_STAY" "DOCUMENT_SUBTYPE" "REMARKS" "RESIDENCE_PERMIT_TYPE" "MANUFACTURING_YEAR" "VEHICLE_TYPE" "DEPENDENT_DATE_OF_BIRTH" "DEPENDENT_SEX" "DEPENDENT_DOCUMENT_NUMBER" "DEPENDENT_FULL_NAME" "ELIGIBILITY_CATEGORY" "SPECIFIC_DOCUMENT_VALIDITY" "VEHICLE_OWNER" "NATIONAL_INSURANCE_NUMBER" "COUNTRY_CODE" "CERTIFICATE_NUMBER" "MUNICIPALITY_OF_REGISTRATION" "LOCALITY_CODE" "MAIDEN_NAME" "STATE_CODE" "DATE_OF_ENTRY" "MUNICIPALITY_CODE" "POLLING_STATION_CODE" "SECTION_CODE" "REGISTRATION_CENTER_CODE" "STATE_NAME"

List of fields that were expected on the document but were missing.

invalidCharacterFields
Array of strings or null (FieldType)
Enum: "ADDITIONAL_ADDRESS_INFORMATION" "ADDITIONAL_NAME_INFORMATION" "ADDITIONAL_OPTIONAL_ADDRESS_INFORMATION" "ADDITIONAL_PERSONAL_ID_NUMBER" "ADDRESS" "CLASS_EFFECTIVE_DATE" "CLASS_EXPIRY_DATE" "CONDITIONS" "DATE_OF_BIRTH" "DATE_OF_EXPIRY" "DATE_OF_ISSUE" "DOCUMENT_ADDITIONAL_NUMBER" "DOCUMENT_OPTIONAL_ADDITIONAL_NUMBER" "DOCUMENT_NUMBER" "EMPLOYER" "ENDORSEMENTS" "FATHERS_NAME" "FIRST_NAME" "FULL_NAME" "ISSUING_AUTHORITY" "LAST_NAME" "LICENCE_TYPE" "LOCALIZED_NAME" "MARITAL_STATUS" "MOTHERS_NAME" "MRZ" "NATIONALITY" "PERSONAL_ID_NUMBER" "PLACE_OF_BIRTH" "PROFESSION" "RACE" "RELIGION" "RESIDENTIAL_STATUS" "RESTRICTIONS" "SEX" "VEHICLE_CLASS" "BLOOD_TYPE" "SPONSOR" "VISA_TYPE" "NUMBER_OF_ENTRIES" "DURATION_OF_STAY" "DOCUMENT_SUBTYPE" "REMARKS" "RESIDENCE_PERMIT_TYPE" "MANUFACTURING_YEAR" "VEHICLE_TYPE" "DEPENDENT_DATE_OF_BIRTH" "DEPENDENT_SEX" "DEPENDENT_DOCUMENT_NUMBER" "DEPENDENT_FULL_NAME" "ELIGIBILITY_CATEGORY" "SPECIFIC_DOCUMENT_VALIDITY" "VEHICLE_OWNER" "NATIONAL_INSURANCE_NUMBER" "COUNTRY_CODE" "CERTIFICATE_NUMBER" "MUNICIPALITY_OF_REGISTRATION" "LOCALITY_CODE" "MAIDEN_NAME" "STATE_CODE" "DATE_OF_ENTRY" "MUNICIPALITY_CODE" "POLLING_STATION_CODE" "SECTION_CODE" "REGISTRATION_CENTER_CODE" "STATE_NAME"

List of fields that contained characters which were not expected in that field.

extraPresentFields
Array of strings or null (FieldType)
Enum: "ADDITIONAL_ADDRESS_INFORMATION" "ADDITIONAL_NAME_INFORMATION" "ADDITIONAL_OPTIONAL_ADDRESS_INFORMATION" "ADDITIONAL_PERSONAL_ID_NUMBER" "ADDRESS" "CLASS_EFFECTIVE_DATE" "CLASS_EXPIRY_DATE" "CONDITIONS" "DATE_OF_BIRTH" "DATE_OF_EXPIRY" "DATE_OF_ISSUE" "DOCUMENT_ADDITIONAL_NUMBER" "DOCUMENT_OPTIONAL_ADDITIONAL_NUMBER" "DOCUMENT_NUMBER" "EMPLOYER" "ENDORSEMENTS" "FATHERS_NAME" "FIRST_NAME" "FULL_NAME" "ISSUING_AUTHORITY" "LAST_NAME" "LICENCE_TYPE" "LOCALIZED_NAME" "MARITAL_STATUS" "MOTHERS_NAME" "MRZ" "NATIONALITY" "PERSONAL_ID_NUMBER" "PLACE_OF_BIRTH" "PROFESSION" "RACE" "RELIGION" "RESIDENTIAL_STATUS" "RESTRICTIONS" "SEX" "VEHICLE_CLASS" "BLOOD_TYPE" "SPONSOR" "VISA_TYPE" "NUMBER_OF_ENTRIES" "DURATION_OF_STAY" "DOCUMENT_SUBTYPE" "REMARKS" "RESIDENCE_PERMIT_TYPE" "MANUFACTURING_YEAR" "VEHICLE_TYPE" "DEPENDENT_DATE_OF_BIRTH" "DEPENDENT_SEX" "DEPENDENT_DOCUMENT_NUMBER" "DEPENDENT_FULL_NAME" "ELIGIBILITY_CATEGORY" "SPECIFIC_DOCUMENT_VALIDITY" "VEHICLE_OWNER" "NATIONAL_INSURANCE_NUMBER" "COUNTRY_CODE" "CERTIFICATE_NUMBER" "MUNICIPALITY_OF_REGISTRATION" "LOCALITY_CODE" "MAIDEN_NAME" "STATE_CODE" "DATE_OF_ENTRY" "MUNICIPALITY_CODE" "POLLING_STATION_CODE" "SECTION_CODE" "REGISTRATION_CENTER_CODE" "STATE_NAME"

List of fields that weren't expected on the document but were present.

imageExtractionFailures
Array of strings or null (ImageExtractionType)
Enum: "FULL_DOCUMENT" "FACE" "SIGNATURE"

List of failed image extractions.

{
  • "missingMandatoryFields": [
    ],
  • "invalidCharacterFields": [
    ],
  • "extraPresentFields": [
    ],
  • "imageExtractionFailures": [
    ]
}

AddressDetailedInfo

street
string or null

The street address portion of the United States driver license owner.

postalCode
string or null

The postal code address portion of the United States driver license owner.

city
string or null

The city address portion of the United States driver license owner.

jurisdiction
string or null

The jurisdiction code address portion of the United States driver license owner.

{
  • "street": "string",
  • "postalCode": "string",
  • "city": "string",
  • "jurisdiction": "string"
}

AlphabetType

string (AlphabetType)
Enum: "LATIN" "ARABIC" "CYRILLIC" "GREEK"
"LATIN"

Anonymization mode

string (Anonymization mode)
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

"NONE"

AnonymizationSettings

object or null

Parameters of card number anonymization

cardNumberPrefixAnonymizationMode
string or null (Anonymization mode)
Default: "NONE"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

cvvAnonymizationMode
string or null (Anonymization mode)
Default: "NONE"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

ibanAnonymizationMode
string or null (Anonymization mode)
Default: "NONE"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

ownerAnonymizationMode
string or null (Anonymization mode)
Default: "NONE"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

fallbackAnonymization
boolean or null
Default: false

If true, anonymization is applied on all fields of the image if extraction is uncertain. Default FALSE

{
  • "cardNumberAnonymizationSettings": {
    },
  • "cardNumberPrefixAnonymizationMode": "NONE",
  • "cvvAnonymizationMode": "NONE",
  • "ibanAnonymizationMode": "NONE",
  • "ownerAnonymizationMode": "NONE",
  • "fallbackAnonymization": false
}

BarcodeDriverLicenseDetailedInfo

restrictions
string or null

The restrictions to driving privileges for the United States driver license owner.

endorsements
string or null

The additional privileges granted to the United States driver license owner.

vehicleClass
string or null

The type of vehicle the driver license owner has privilege to drive.

conditions
string or null

The driver license conditions.

Array of objects or null (BarcodeVehicleClassInfo)

The additional information on vehicle class.

{
  • "restrictions": "string",
  • "endorsements": "string",
  • "vehicleClass": "string",
  • "conditions": "string",
  • "vehicleClassesInfo": [
    ]
}

BarcodeElement

key
string or null (Barcode element key)
Enum: "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE" "STANDARD_VERSION_NUMBER" "CUSTOMER_FAMILY_NAME" "CUSTOMER_FIRST_NAME" "CUSTOMER_FULL_NAME" "DATE_OF_BIRTH" "SEX" "EYE_COLOR" "ADDRESS_STREET" "ADDRESS_CITY" "ADDRESS_JURISDICTION_CODE" "ADDRESS_POSTAL_CODE" "FULL_ADDRESS" "HEIGHT" "HEIGHT_IN" "HEIGHT_CM" "CUSTOMER_MIDDLE_NAME" "HAIR_COLOR" "NAME_SUFFIX" "AKA_FULL_NAME" "AKA_FAMILY_NAME" "AKA_GIVEN_NAME" "AKA_SUFFIX_NAME" "WEIGHT_RANGE" "WEIGHT_POUNDS" "WEIGHT_KILOGRAMS" "CUSTOMER_ID_NUMBER" "FAMILY_NAME_TRUNCATION" "FIRST_NAME_TRUNCATION" "MIDDLE_NAME_TRUNCATION" "PLACE_OF_BIRTH" "ADDRESS_STREET_2" "RACE_ETHNICITY" "NAME_PREFIX" "COUNTRY_IDENTIFICATION" "RESIDENCE_STREET_ADDRESS" "RESIDENCE_STREET_ADDRESS_2" "RESIDENCE_CITY" "RESIDENCE_JURISDICTION_CODE" "RESIDENCE_POSTAL_CODE" "RESIDENCE_FULL_ADDRESS" "UNDER_18" "UNDER_19" "UNDER_21" "SOCIAL_SECURITY_NUMBER" "AKA_SOCIAL_SECURITY_NUMBER" "AKA_MIDDLE_NAME" "AKA_PREFIX_NAME" "ORGAN_DONOR" "VETERAN" "AKA_DATE_OF_BIRTH" "ISSUER_IDENTIFICATION_NUMBER" "DOCUMENT_EXPIRATION_DATE" "JURISDICTION_VERSION_NUMBER" "JURISDICTION_VEHICLE_CLASS" "JURISDICTION_RESTRICTION_CODES" "JURISDICTION_ENDORSEMENT_CODES" "DOCUMENT_ISSUE_DATE" "FEDERAL_COMMERCIAL_VEHICLE_CODES" "ISSUING_JURISDICTION" "STANDARD_VEHICLE_CLASSIFICATION" "ISSUING_JURISDICTION_NAME" "STANDARD_ENDORSEMENT_CODE" "STANDARD_RESTRICTION_CODE" "JURISDICTION_VEHICLE_CLASSIFICATION_DESCRIPTION" "JURISDICTION_ENDORSMENT_CODE_DESCRIPTION" "JURISDICTION_RESTRICTION_CODE_DESCRIPTION" "INVENTORY_CONTROL_NUMBER" "CARD_REVISION_DATE" "DOCUMENT_DISCRIMINATOR" "LIMITED_DURATION_DOCUMENT" "AUDIT_INFORMATION" "COMPLIANCE_TYPE" "ISSUE_TIMESTAMP" "PERMIT_EXPIRATION_DATE" "PERMIT_IDENTIFIER" "PERMIT_ISSUE_DATE" "NUMBER_OF_DUPLICATES" "HAZMAT_EXPIRATION_DATE" "MEDICAL_INDICATOR" "NON_RESIDENT" "UNIQUE_CUSTOMER_ID" "DATA_DISCRIMINATOR" "DOCUMENT_EXPIRATION_MONTH" "DOCUMENT_NONEXPIRING" "SECURITY_VERSION" "SUB_FIELD_DESIGNATOR" "COUNT"

Additional fields present in the barcode.

value
string or null
{
  • "key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
  • "value": "string"
}

Barcode element key

string (Barcode element key)
Enum: "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE" "STANDARD_VERSION_NUMBER" "CUSTOMER_FAMILY_NAME" "CUSTOMER_FIRST_NAME" "CUSTOMER_FULL_NAME" "DATE_OF_BIRTH" "SEX" "EYE_COLOR" "ADDRESS_STREET" "ADDRESS_CITY" "ADDRESS_JURISDICTION_CODE" "ADDRESS_POSTAL_CODE" "FULL_ADDRESS" "HEIGHT" "HEIGHT_IN" "HEIGHT_CM" "CUSTOMER_MIDDLE_NAME" "HAIR_COLOR" "NAME_SUFFIX" "AKA_FULL_NAME" "AKA_FAMILY_NAME" "AKA_GIVEN_NAME" "AKA_SUFFIX_NAME" "WEIGHT_RANGE" "WEIGHT_POUNDS" "WEIGHT_KILOGRAMS" "CUSTOMER_ID_NUMBER" "FAMILY_NAME_TRUNCATION" "FIRST_NAME_TRUNCATION" "MIDDLE_NAME_TRUNCATION" "PLACE_OF_BIRTH" "ADDRESS_STREET_2" "RACE_ETHNICITY" "NAME_PREFIX" "COUNTRY_IDENTIFICATION" "RESIDENCE_STREET_ADDRESS" "RESIDENCE_STREET_ADDRESS_2" "RESIDENCE_CITY" "RESIDENCE_JURISDICTION_CODE" "RESIDENCE_POSTAL_CODE" "RESIDENCE_FULL_ADDRESS" "UNDER_18" "UNDER_19" "UNDER_21" "SOCIAL_SECURITY_NUMBER" "AKA_SOCIAL_SECURITY_NUMBER" "AKA_MIDDLE_NAME" "AKA_PREFIX_NAME" "ORGAN_DONOR" "VETERAN" "AKA_DATE_OF_BIRTH" "ISSUER_IDENTIFICATION_NUMBER" "DOCUMENT_EXPIRATION_DATE" "JURISDICTION_VERSION_NUMBER" "JURISDICTION_VEHICLE_CLASS" "JURISDICTION_RESTRICTION_CODES" "JURISDICTION_ENDORSEMENT_CODES" "DOCUMENT_ISSUE_DATE" "FEDERAL_COMMERCIAL_VEHICLE_CODES" "ISSUING_JURISDICTION" "STANDARD_VEHICLE_CLASSIFICATION" "ISSUING_JURISDICTION_NAME" "STANDARD_ENDORSEMENT_CODE" "STANDARD_RESTRICTION_CODE" "JURISDICTION_VEHICLE_CLASSIFICATION_DESCRIPTION" "JURISDICTION_ENDORSMENT_CODE_DESCRIPTION" "JURISDICTION_RESTRICTION_CODE_DESCRIPTION" "INVENTORY_CONTROL_NUMBER" "CARD_REVISION_DATE" "DOCUMENT_DISCRIMINATOR" "LIMITED_DURATION_DOCUMENT" "AUDIT_INFORMATION" "COMPLIANCE_TYPE" "ISSUE_TIMESTAMP" "PERMIT_EXPIRATION_DATE" "PERMIT_IDENTIFIER" "PERMIT_ISSUE_DATE" "NUMBER_OF_DUPLICATES" "HAZMAT_EXPIRATION_DATE" "MEDICAL_INDICATOR" "NON_RESIDENT" "UNIQUE_CUSTOMER_ID" "DATA_DISCRIMINATOR" "DOCUMENT_EXPIRATION_MONTH" "DOCUMENT_NONEXPIRING" "SECURITY_VERSION" "SUB_FIELD_DESIGNATOR" "COUNT"

Additional fields present in the barcode.

"BARCODE_ELEMENT_KEY_DOCUMENT_TYPE"

BarcodeEndpointResponse

traceId
string or null
executionId
required
string
finishTime
required
string <date-time>

UTC time after recognition finished.

startTime
required
string <date-time>

UTC time before recognition started.

required
object (BarcodeRecognizerOutput)
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

BarcodeRecognizerOutput

barcodeType
string or null (Barcode type)
Enum: "NONE" "QR_CODE" "UPC_E" "UPC_A" "EAN_8" "EAN_13" "CODE_128" "CODE_39" "ITF" "PDF417_BARCODE"

Type of barcode.

rawData
string or null

Byte array with result of the scan.

stringData
string or null

Retrieves string content of scanned data.

uncertain
boolean or null

Flag indicating uncertain scanning data.

object or null

Points array with coordinates of barcode detection.

recognitionStatus
required
string (Result state)
Enum: "EMPTY" "UNCERTAIN" "VALID" "STAGE_VALID"

Possible states of the Recognizer's result.

{
  • "barcodeType": "NONE",
  • "rawData": "string",
  • "stringData": "string",
  • "uncertain": true,
  • "detectionPoints": {
    },
  • "recognitionStatus": "EMPTY"
}

BarcodeRequest

autoScaleDetection
boolean or null
Default: true

Allow enabling the autodetection of image scale when scanning barcodes. If set to true, prior reading barcode, image scale will be corrected. This enabled correct reading of barcodes on high resolution images but slows down the recognition process. This setting is applied only for Code39 and Code128 barcode scanning. Default TRUE

nullQuietZoneAllowed
boolean or null
Default: false

Set this to true to scan barcodes which don't have quiet zone (white area) around it. Use only if necessary because it slows down the recognition process Default FALSE

readCode39AsExtendedData
boolean or null
Default: false

Enable reading code39 barcode contents as extended data. For more information about code39 extended data (a.k.a. full ASCII mode), see https://en.wikipedia.org/wiki/Code_39#Full_ASCII_Code_39 Default FALSE

scanCode128
boolean or null
Default: false

Set this to true to scan Code 128 1D barcodes. Default FALSE

scanCode39
boolean or null
Default: false

Set this to true to scan Code 39 1D barcodes. Default FALSE

scanEan13
boolean or null
Default: false

Set this to true to scan EAN 13 barcodes. Default FALSE

scanEan8
boolean or null
Default: false

Set this to true to scan EAN8 barcodes. Default FALSE

scanInverse
boolean or null
Default: false

Set this to true to allow scanning barcodes with inverted intensities. This options doubles the frame processing time. Default FALSE

scanItf
boolean or null
Default: false

Set this to true to scan ITF barcodes. Default FALSE

scanPdf417
boolean or null
Default: false

Set this to true to scan Pdf417 barcodes. Default FALSE

scanQrCode
boolean or null
Default: false

Set this to true to scan QR barcodes. Default FALSE

scanUncertain
boolean or null
Default: true

Set this to true to scan even barcode not compliant with standards. For example, malformed PDF417 barcodes which were incorrectly encoded. Use only if necessary because it slows down the recognition process. Default TRUE

scanUpca
boolean or null
Default: false

Set this to true to scan UPCA barcodes. Default FALSE

scanUpce
boolean or null
Default: false

Set this to true to scan UPCE barcodes. Default FALSE

slowerThoroughScan
boolean or null
Default: false

Set this to true to allow slower, but better image processing. Default FALSE

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

traceId
string or null
{
  • "autoScaleDetection": true,
  • "nullQuietZoneAllowed": false,
  • "readCode39AsExtendedData": false,
  • "scanCode128": false,
  • "scanCode39": false,
  • "scanEan13": false,
  • "scanEan8": false,
  • "scanInverse": false,
  • "scanItf": false,
  • "scanPdf417": false,
  • "scanQrCode": false,
  • "scanUncertain": true,
  • "scanUpca": false,
  • "scanUpce": false,
  • "slowerThoroughScan": false,
  • "image": {
    },
  • "traceId": "string"
}

BarcodeResult

rawDataBase64
string or null

The raw bytes contained inside barcode.

stringData
string or null

String representation of data inside barcode.

firstName
string or null

The first name of the document owner.

lastName
string or null

The last name of the document owner.

middleName
string or null

The middle name of the document owner.

fullName
string or null

The full name of the document owner.

additionalNameInformation
string or null

The additional name information of the document owner.

address
string or null

The address of the document owner.

placeOfBirth
string or null

The place of birth of the document owner.

nationality
string or null

The nationality of the documet owner.

race
string or null

The race of the document owner.

religion
string or null

The religion of the document owner.

profession
string or null

The profession of the document owner.

maritalStatus
string or null

The marital status of the document owner.

residentialStatus
string or null

The residential stauts of the document owner.

employer
string or null

The employer of the document owner.

sex
string or null

The sex of the document owner.

object or null
object or null
object or null
documentNumber
string or null

The document number.

personalIdNumber
string or null

The personal identification number.

documentAdditionalNumber
string or null

The additional number of the document.

issuingAuthority
string or null

The issuing authority of the document.

object or null

The details about the address.

object or null

The driver license detailed info.

Array of objects or null (BarcodeElement)

Document specific extended elements that contain all barcode fields in their original form.

parsed
boolean

Boolean that indicates whether the raw barcode data was successfully parsed.

{
  • "rawDataBase64": "string",
  • "stringData": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "fullName": "string",
  • "additionalNameInformation": "string",
  • "address": "string",
  • "placeOfBirth": "string",
  • "nationality": "string",
  • "race": "string",
  • "religion": "string",
  • "profession": "string",
  • "maritalStatus": "string",
  • "residentialStatus": "string",
  • "employer": "string",
  • "sex": "string",
  • "dateOfBirth": {
    },
  • "dateOfIssue": {
    },
  • "dateOfExpiry": {
    },
  • "documentNumber": "string",
  • "personalIdNumber": "string",
  • "documentAdditionalNumber": "string",
  • "issuingAuthority": "string",
  • "addressDetailedInfo": {
    },
  • "driverLicenseDetailedInfo": {
    },
  • "extendedElements": [
    ],
  • "parsed": true
}

Barcode type

string (Barcode type)
Enum: "NONE" "QR_CODE" "UPC_E" "UPC_A" "EAN_8" "EAN_13" "CODE_128" "CODE_39" "ITF" "PDF417_BARCODE"

Type of barcode.

"NONE"

BarcodeVehicleClassInfo

vehicleClass
string or null

The type of vehicle the driver license owner has privilege to drive.

licenceType
string or null

The type of driver licence.

object or null

The date since licence is effective

object or null

The date of expiry of licence.

{
  • "vehicleClass": "string",
  • "licenceType": "string",
  • "effectiveDate": {
    },
  • "expiryDate": {
    }
}

BlinkCardEndpointResponse

traceId
string or null
executionId
required
string
finishTime
required
string <date-time>

UTC time after recognition finished.

startTime
required
string <date-time>

UTC time before recognition started.

required
object (BlinkCardRecognizerOutput)
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

BlinkCard processing status

string (BlinkCard processing status)
Enum: "SUCCESS" "DETECTION_FAILED" "IMAGE_PREPROCESSING_FAILED" "STABILITY_TEST_FAILED" "SCANNING_WRONG_SIDE" "FIELD_IDENTIFICATION_FAILED" "IMAGE_RETURN_FAILED" "UNSUPPORTED_CARD"

Processing status of BlinkCard.

"SUCCESS"

BlinkCardRecognizerOutput

cardIssuer
required
string (Card issuer)
Enum: "ISSUER_OTHER" "ISSUER_AMERICAN_EXPRESS" "ISSUER_CHINA_UNION_PAY" "ISSUER_DINERS" "ISSUER_DISCOVER_CARD" "ISSUER_ELO" "ISSUER_JCB" "ISSUER_MAESTRO" "ISSUER_MASTER_CARD" "ISSUER_RU_PAY" "ISSUER_VERVE" "ISSUER_VISA" "ISSUER_VPAY"

Supported issuing institutions that issued the card to the card holder.

cardNumber
string or null

The payment card number.

cardNumberValid
boolean or null

The payment card number validity

cardNumberPrefix
string or null

The payment card number prefix.

iban
string or null

Payment card's IBAN.

cvv
string or null

Payment card's security code/value.

object or null
owner
string or null

Information about the payment card owner.

firstSideFullDocumentImage
string or null

Full image of the payment card from first side recognition.

secondSideFullDocumentImage
string or null

Full image of the payment card from second side recognition.

firstSideBlurred
boolean or null

Wheater the first scanned side is blurred.

secondSideBlurred
boolean or null

Wheater the second scanned side is blurred.

firstSideAnonymized
boolean or null

Whether the first side of document is anonymized.

secondSideAnonymized
boolean or null

Whether the second side of document is anonymized.

object or null
processingStatus
required
string (BlinkCard processing status)
Enum: "SUCCESS" "DETECTION_FAILED" "IMAGE_PREPROCESSING_FAILED" "STABILITY_TEST_FAILED" "SCANNING_WRONG_SIDE" "FIELD_IDENTIFICATION_FAILED" "IMAGE_RETURN_FAILED" "UNSUPPORTED_CARD"

Processing status of BlinkCard.

scanningFirstSideDone
boolean or null

Whether the scanning of the first side is finished.

recognitionStatus
required
string (Result state)
Enum: "EMPTY" "UNCERTAIN" "VALID" "STAGE_VALID"

Possible states of the Recognizer's result.

{
  • "cardIssuer": "ISSUER_OTHER",
  • "cardNumber": "string",
  • "cardNumberValid": true,
  • "cardNumberPrefix": "string",
  • "iban": "string",
  • "cvv": "string",
  • "expiryDate": {
    },
  • "owner": "string",
  • "firstSideFullDocumentImage": "string",
  • "secondSideFullDocumentImage": "string",
  • "firstSideBlurred": true,
  • "secondSideBlurred": true,
  • "firstSideAnonymized": true,
  • "secondSideAnonymized": true,
  • "documentLivenessCheck": {
    },
  • "processingStatus": "SUCCESS",
  • "scanningFirstSideDone": true,
  • "recognitionStatus": "EMPTY"
}

BlinkCardRequest

extractIban
boolean or null
Default: true

Should extract the payment card's IBAN. Default TRUE

extractExpiryDate
boolean or null
Default: true

Defines whether the expiry date should be extracted. Default TRUE

extractOwner
boolean or null
Default: true

Should extract the card owner information. Default TRUE

extractCvv
boolean or null
Default: true

Defines whether the cvv should be extracted. Default TRUE

returnFullDocumentImage
boolean or null
Default: false

Defines whether full document image should be extracted. Default FALSE

handScaleThreshold
number or null <float>
handDocumentOverlapThreshold
number or null <float>
screenAnalysisMatchLevel
string or null
Enum: "DISABLED" "LEVEL1" "LEVEL2" "LEVEL3" "LEVEL4" "LEVEL5" "LEVEL6" "LEVEL7" "LEVEL8" "LEVEL9" "LEVEL10"
photocopyAnalysisMatchLevel
string or null
Enum: "DISABLED" "LEVEL1" "LEVEL2" "LEVEL3" "LEVEL4" "LEVEL5" "LEVEL6" "LEVEL7" "LEVEL8" "LEVEL9" "LEVEL10"
object or null

Whether sensitive data should be redacted from the result.

imageFormat
string or null (Image Format)
Default: "PNG"
Enum: "JPG" "PNG" "QOI"

Defines return image type. Default PNG

skipFramesWithBlur
boolean or null
Default: true

Defines whether blurred frames filtering is allowed. Default TRUE

allowInvalidCardNumber
boolean or null
Default: false

Defines whether invalid card number is accepted. Default FALSE

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

object or null

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

traceId
string or null
{
  • "extractIban": true,
  • "extractExpiryDate": true,
  • "extractOwner": true,
  • "extractCvv": true,
  • "returnFullDocumentImage": false,
  • "handScaleThreshold": 0.1,
  • "handDocumentOverlapThreshold": 0.1,
  • "screenAnalysisMatchLevel": "DISABLED",
  • "photocopyAnalysisMatchLevel": "DISABLED",
  • "anonymizationSettings": {
    },
  • "imageFormat": "PNG",
  • "skipFramesWithBlur": true,
  • "allowInvalidCardNumber": false,
  • "cardNumberSide": {
    },
  • "otherSide": {
    },
  • "traceId": "string"
}

BlinkIdMultiSideEndpointResponse

traceId
string or null
executionId
required
string
finishTime
required
string <date-time>

UTC time after recognition finished.

startTime
required
string <date-time>

UTC time before recognition started.

required
object (BlinkIdMultiSideRecognizerOutput)
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

BlinkIdMultiSideRecognizerOutput

object or null

The first name of the document owner.

object or null

The last name of the document owner.

object or null

The last name of the document owner.

object or null

The address of the document owner.

object or null
object or null
object or null
object or null

The document number.

object or null

The sex of the document owner.

object or null

The driver license detailed info.

object or null

The blood type of the document owner.

object or null

The sponsor of the document owner.

object or null

Visa type of the document.

object or null

The result of the cropped image transformation with additional details.

object or null

The result of the cropped image transformation with additional details.

object or null

The result of the cropped image transformation with additional details.

object or null

The result of the cropped image transformation with additional details.

object or null

The transcription of the document subtype.

object or null

The remarks on the residence permit.

object or null

The residence permit type.

object or null

The manufacturing year.

object or null

The vehicle type.

object or null

The eligibility category.

object or null

The specific document validity.

Array of objects or null (DependentInfo)
object or null

The vehicle owner.

object or null

The certificate number of the document owner.

object or null

The country code of the document owner.

object or null

The national insurance number of the document owner.

object or null

The additional name information of the document owner.

object or null

The additional address information of the document owner.

object or null

The one more additional address information of the document owner.

object or null

The place of birth of the document owner.

object or null

The nationality of the documet owner.

object or null

The race of the document owner.

object or null

The religion of the document owner.

object or null

The profession of the document owner.

object or null

The marital status of the document owner.

object or null

The residential stauts of the document owner.

object or null

The employer of the document owner.

object or null

The personal identification number.

object or null

The additional number of the document.

object or null

The one more additional number of the document.

object or null

The issuing authority of the document.

object or null

The fathers name of the document owner.

object or null

The mothers name of the document owner.

object or null

The date of entry.

object or null

The locality code.

object or null

The maiden name of the document owner.

object or null

The municipality code.

object or null

The municipality of registration.

object or null

The polling station code.

object or null

The registration center code.

object or null

The section code.

object or null

The state code.

object or null

The state name.

object or null

The data extracted from the machine readable zone.

object or null

The localized name of the document.

object or null

Result of data match check.

dateOfExpiryPermanent
boolean or null

Determines if date of expiry is permanent.

scanningFirstSideDone
boolean or null

Defines whether recognizer has finished scanning first side.

object or null

The additional personal identification number.

object or null

The data extracted from the visual inspection zone.

object or null

The data extracted from the visual inspection zone.

object or null

The data extracted from the barcode.

object or null

Various information obtained by analysing the scanned image.

object or null

Various information obtained by analysing the scanned image.

processingStatus
string or null (Processing status)
Enum: "SUCCESS" "DETECTION_FAILED" "IMAGE_PREPROCESSING_FAILED" "STABILITY_TEST_FAILED" "SCANNING_WRONG_SIDE" "FIELD_IDENTIFICATION_FAILED" "MANDATORY_FIELD_MISSING" "INVALID_CHARACTERS_FOUND" "IMAGE_RETURN_FAILED" "BARCODE_RECOGNITION_FAILED" "MRZ_PARSING_FAILED" "DOCUMENT_FILTERED" "UNSUPPORTED_DOCUMENT" "AWAITING_OTHER_SIDE" "NOT_SCANNED" "BARCODE_DETECTION_FAILED"

Detailed information about the recognition process.

firstSideProcessingStatus
string or null (Processing status)
Enum: "SUCCESS" "DETECTION_FAILED" "IMAGE_PREPROCESSING_FAILED" "STABILITY_TEST_FAILED" "SCANNING_WRONG_SIDE" "FIELD_IDENTIFICATION_FAILED" "MANDATORY_FIELD_MISSING" "INVALID_CHARACTERS_FOUND" "IMAGE_RETURN_FAILED" "BARCODE_RECOGNITION_FAILED" "MRZ_PARSING_FAILED" "DOCUMENT_FILTERED" "UNSUPPORTED_DOCUMENT" "AWAITING_OTHER_SIDE" "NOT_SCANNED" "BARCODE_DETECTION_FAILED"

Detailed information about the recognition process.

secondSideProcessingStatus
string or null (Processing status)
Enum: "SUCCESS" "DETECTION_FAILED" "IMAGE_PREPROCESSING_FAILED" "STABILITY_TEST_FAILED" "SCANNING_WRONG_SIDE" "FIELD_IDENTIFICATION_FAILED" "MANDATORY_FIELD_MISSING" "INVALID_CHARACTERS_FOUND" "IMAGE_RETURN_FAILED" "BARCODE_RECOGNITION_FAILED" "MRZ_PARSING_FAILED" "DOCUMENT_FILTERED" "UNSUPPORTED_DOCUMENT" "AWAITING_OTHER_SIDE" "NOT_SCANNED" "BARCODE_DETECTION_FAILED"

Detailed information about the recognition process.

recognitionMode
string or null (Recognition mode)
Enum: "NONE" "MRZ_ID" "MRZ_VISA" "MRZ_PASSPORT" "PHOTO_ID" "FULL_RECOGNITION" "BARCODE_ID"

Recognition mode used to scan current document.

object or null

The document class information.

recognitionStatus
required
string (Result state)
Enum: "EMPTY" "UNCERTAIN" "VALID" "STAGE_VALID"

Possible states of the Recognizer's result.

object or null

The additional details about the processing info.

object or null

The additional details about the processing info.

isBelowAgeLimit
boolean or null

The indicator if document owner is below age limit provided in the request. Default -1 if ageLimit is not sent in the request.

age
integer or null <int32>

The calculated age of the document owner.

{
  • "firstName": {
    },
  • "lastName": {
    },
  • "fullName": {
    },
  • "address": {
    },
  • "dateOfBirth": {
    },
  • "dateOfIssue": {
    },
  • "dateOfExpiry": {
    },
  • "documentNumber": {
    },
  • "sex": {
    },
  • "driverLicenseDetailedInfo": {
    },
  • "bloodType": {
    },
  • "sponsor": {
    },
  • "visaType": {
    },
  • "fullDocumentFirstSideImage": {
    },
  • "fullDocumentSecondSideImage": {
    },
  • "faceImage": {
    },
  • "signatureImage": {
    },
  • "documentSubtype": {
    },
  • "remarks": {
    },
  • "residencePermitType": {
    },
  • "manufacturingYear": {
    },
  • "vehicleType": {
    },
  • "eligibilityCategory": {
    },
  • "specificDocumentValidity": {
    },
  • "dependentsInfo": [
    ],
  • "vehicleOwner": {
    },
  • "certificateNumber": {
    },
  • "countryCode": {
    },
  • "nationalInsuranceNumber": {
    },
  • "additionalNameInformation": {
    },
  • "additionalAddressInformation": {
    },
  • "additionalOptionalAddressInformation": {
    },
  • "placeOfBirth": {
    },
  • "nationality": {
    },
  • "race": {
    },
  • "religion": {
    },
  • "profession": {
    },
  • "maritalStatus": {
    },
  • "residentialStatus": {
    },
  • "employer": {
    },
  • "personalIdNumber": {
    },
  • "documentAdditionalNumber": {
    },
  • "documentOptionalAdditionalNumber": {
    },
  • "issuingAuthority": {
    },
  • "fathersName": {
    },
  • "mothersName": {
    },
  • "dateOfEntry": {
    },
  • "localityCode": {
    },
  • "maidenName": {
    },
  • "municipalityCode": {
    },
  • "municipalityOfRegistration": {
    },
  • "pollingStationCode": {
    },
  • "registrationCenterCode": {
    },
  • "sectionCode": {
    },
  • "stateCode": {
    },
  • "stateName": {
    },
  • "mrzData": {
    },
  • "localizedName": {
    },
  • "dataMatchResult": {
    },
  • "dateOfExpiryPermanent": true,
  • "scanningFirstSideDone": true,
  • "additionalPersonalIdNumber": {
    },
  • "firstSideViz": {
    },
  • "secondSideViz": {
    },
  • "barcode": {
    },
  • "firstSideImageAnalysisResult": {
    },
  • "secondSideImageAnalysisResult": {
    },
  • "processingStatus": "SUCCESS",
  • "firstSideProcessingStatus": "SUCCESS",
  • "secondSideProcessingStatus": "SUCCESS",
  • "recognitionMode": "NONE",
  • "documentClassInfo": {
    },
  • "recognitionStatus": "EMPTY",
  • "firstSideAdditionalProcessingInfo": {
    },
  • "secondSideAdditionalProcessingInfo": {
    },
  • "isBelowAgeLimit": true,
  • "age": 0
}

BlinkIdMultiSideRequest

returnFullDocumentImage
boolean or null
Default: false

Defines whether full document image should be extracted. Default FALSE

returnFaceImage
boolean or null
Default: false

Defines whether face image should be extracted. Default FALSE

returnSignatureImage
boolean or null
Default: false

Defines whether signature image should be extracted. Default FALSE

skipImagesWithBlur
boolean or null
Default: true

Defines whether blurred frames filtering is allowed. Default TRUE

scanUnsupportedSecondSide
boolean or null
Default: false

Skip back side capture and processing step when back side of the document is not supported. Default FALSE

enableCharacterValidation
boolean or null
Default: true

Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE

enableBarcodeScanOnly
boolean or null
Default: false

This setting allows barcode recognition to proceed even if the initial extraction fails. If the barcode recognition is successful, the recognizer will still end in a valid state. This setting is applicable only to photo frames. For multi-side recognizers, it is permitted only for the back side. Default FALSE

anonymizationMode
string or null (Anonymization mode)
Default: "FULL_RESULT"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

Array of objects or null (DocumentAnonymizationSettings)
Array of objects or null (DocumentRules)
imageFormat
string or null (Image Format)
Default: "PNG"
Enum: "JPG" "PNG" "QOI"

Defines return image type. Default PNG

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

object or null

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

ageLimit
integer or null <int32>

Defines the age limit for age verification.

scanCroppedDocumentImage
boolean or null
Default: false

Configure the recognizer to only work on already cropped and dewarped images. Default FALSE

maxAllowedMismatchesPerField
integer or null <int32>
Default: 0

Configure the number of characters per field that are allowed to be inconsistent in data match. Default 0

allowUncertainFirstSideScan
boolean or null
Default: true

Proceed with scanning the back side even if the front side result is uncertain. Default TRUE

scanPassportDataPageOnly
boolean or null
Default: true

Scan only the data page (page containing MRZ) of the passport.If set to false, it will be required to scan the second page of certain passports. Default TRUE

skipImagesWithInadequateLightingConditions
boolean or null
Default: true

Indicates whether frames with inadequate lighting conditions should be rejected. A value of true means frames with poor lighting conditions will be excluded from further processing to prevent images with inadequate lighting from being used. Default TRUE

skipImagesOccludedByHand
boolean or null
Default: true

Indicates whether frames occluded by hand should be rejected. A value of true means frames occluded by hand will be excluded from further processing to prevent occluded images from being used. This setting is applicable only if scanCroppedDocumentImage is disabled. Default TRUE

traceId
string or null
{
  • "returnFullDocumentImage": false,
  • "returnFaceImage": false,
  • "returnSignatureImage": false,
  • "skipImagesWithBlur": true,
  • "scanUnsupportedSecondSide": false,
  • "enableCharacterValidation": true,
  • "enableBarcodeScanOnly": false,
  • "anonymizationMode": "FULL_RESULT",
  • "customDocumentAnonymizationSettings": [
    ],
  • "customDocumentRules": [
    ],
  • "imageFormat": "PNG",
  • "imageFirstSide": {
    },
  • "imageSecondSide": {
    },
  • "ageLimit": 0,
  • "scanCroppedDocumentImage": false,
  • "maxAllowedMismatchesPerField": 0,
  • "allowUncertainFirstSideScan": true,
  • "scanPassportDataPageOnly": true,
  • "skipImagesWithInadequateLightingConditions": true,
  • "skipImagesOccludedByHand": true,
  • "traceId": "string"
}

BlinkIdSingleSideEndpointResponse

traceId
string or null
executionId
required
string
finishTime
required
string <date-time>

UTC time after recognition finished.

startTime
required
string <date-time>

UTC time before recognition started.

required
object (BlinkIdSingleSideRecognizerOutput)
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

BlinkIdSingleSideRecognizerOutput

object or null

The first name of the document owner.

object or null

The last name of the document owner.

object or null

The full name of the document owner.

object or null

The address of the document owner.

object or null
object or null
object or null
object or null

The document number.

object or null

The sex of the document owner.

object or null

The driver license detailed info.

object or null

The blood type of the document owner.

object or null

The sponsor of the document owner.

object or null

Visa type of the document.

object or null

The result of the cropped image transformation with additional details.

object or null

The result of the cropped image transformation with additional details.

object or null

The result of the cropped image transformation with additional details.

object or null

The transcription of the document subtype.

object or null

The remarks on the residence permit.

object or null

The residence permit type.

object or null

The manufacturing year.

object or null

The vehicle type.

object or null

The eligibility category.

object or null

The specific document validity.

Array of objects or null (DependentInfo)
object or null

The vehicle owner.

object or null

The certificate number of the document owner.

object or null

The country code of the document owner.

object or null

The national insurance number of the document owner.

object or null

The additional name information of the document owner.

object or null

The additional address information of the document owner.

object or null

The one more additional address information of the document owner.

object or null

The place of birth of the document owner.

object or null

The nationality of the documet owner.

object or null

The race of the document owner.

object or null

The religion of the document owner.

object or null

The profession of the document owner.

object or null

The marital status of the document owner.

object or null

The residential stauts of the document owner.

object or null

The employer of the document owner.

object or null

The personal identification number.

object or null

The additional number of the document.

object or null

The one more additional number of the document.

object or null

The issuing authority of the document.

object or null

The fathers name of the document owner.

object or null

The mothers name of the document owner.

object or null

The date of entry.

object or null

The locality code.

object or null

The maiden name of the document owner.

object or null

The municipality code.

object or null

The municipality of registration.

object or null

The polling station code.

object or null

The registration center code.

object or null

The section code.

object or null

The state code.

object or null

The state name.

object or null

The data extracted from the machine readable zone.

object or null

The localized name of the document.

dateOfExpiryPermanent
boolean or null

Determines if date of expiry is permanent.

object or null

The additional personal identification number.

object or null

The data extracted from the visual inspection zone.

object or null

The data extracted from the barcode.

object or null

Various information obtained by analysing the scanned image.

processingStatus
string or null (Processing status)
Enum: "SUCCESS" "DETECTION_FAILED" "IMAGE_PREPROCESSING_FAILED" "STABILITY_TEST_FAILED" "SCANNING_WRONG_SIDE" "FIELD_IDENTIFICATION_FAILED" "MANDATORY_FIELD_MISSING" "INVALID_CHARACTERS_FOUND" "IMAGE_RETURN_FAILED" "BARCODE_RECOGNITION_FAILED" "MRZ_PARSING_FAILED" "DOCUMENT_FILTERED" "UNSUPPORTED_DOCUMENT" "AWAITING_OTHER_SIDE" "NOT_SCANNED" "BARCODE_DETECTION_FAILED"

Detailed information about the recognition process.

recognitionMode
string or null (Recognition mode)
Enum: "NONE" "MRZ_ID" "MRZ_VISA" "MRZ_PASSPORT" "PHOTO_ID" "FULL_RECOGNITION" "BARCODE_ID"

Recognition mode used to scan current document.

object or null

The document class information.

recognitionStatus
required
string (Result state)
Enum: "EMPTY" "UNCERTAIN" "VALID" "STAGE_VALID"

Possible states of the Recognizer's result.

object or null

The additional details about the processing info.

isBelowAgeLimit
boolean or null

The indicator if document owner is below age limit provided in the request. Default -1 if ageLimit is not sent in the request.

age
integer or null <int32>

The calculated age of the document owner.

{
  • "firstName": {
    },
  • "lastName": {
    },
  • "fullName": {
    },
  • "address": {
    },
  • "dateOfBirth": {
    },
  • "dateOfIssue": {
    },
  • "dateOfExpiry": {
    },
  • "documentNumber": {
    },
  • "sex": {
    },
  • "driverLicenseDetailedInfo": {
    },
  • "bloodType": {
    },
  • "sponsor": {
    },
  • "visaType": {
    },
  • "fullDocumentImage": {
    },
  • "faceImage": {
    },
  • "signatureImage": {
    },
  • "documentSubtype": {
    },
  • "remarks": {
    },
  • "residencePermitType": {
    },
  • "manufacturingYear": {
    },
  • "vehicleType": {
    },
  • "eligibilityCategory": {
    },
  • "specificDocumentValidity": {
    },
  • "dependentsInfo": [
    ],
  • "vehicleOwner": {
    },
  • "certificateNumber": {
    },
  • "countryCode": {
    },
  • "nationalInsuranceNumber": {
    },
  • "additionalNameInformation": {
    },
  • "additionalAddressInformation": {
    },
  • "additionalOptionalAddressInformation": {
    },
  • "placeOfBirth": {
    },
  • "nationality": {
    },
  • "race": {
    },
  • "religion": {
    },
  • "profession": {
    },
  • "maritalStatus": {
    },
  • "residentialStatus": {
    },
  • "employer": {
    },
  • "personalIdNumber": {
    },
  • "documentAdditionalNumber": {
    },
  • "documentOptionalAdditionalNumber": {
    },
  • "issuingAuthority": {
    },
  • "fathersName": {
    },
  • "mothersName": {
    },
  • "dateOfEntry": {
    },
  • "localityCode": {
    },
  • "maidenName": {
    },
  • "municipalityCode": {
    },
  • "municipalityOfRegistration": {
    },
  • "pollingStationCode": {
    },
  • "registrationCenterCode": {
    },
  • "sectionCode": {
    },
  • "stateCode": {
    },
  • "stateName": {
    },
  • "mrzData": {
    },
  • "localizedName": {
    },
  • "dateOfExpiryPermanent": true,
  • "additionalPersonalIdNumber": {
    },
  • "viz": {
    },
  • "barcode": {
    },
  • "imageAnalysisResult": {
    },
  • "processingStatus": "SUCCESS",
  • "recognitionMode": "NONE",
  • "documentClassInfo": {
    },
  • "recognitionStatus": "EMPTY",
  • "additionalProcessingInfo": {
    },
  • "isBelowAgeLimit": true,
  • "age": 0
}

BlinkIdSingleSideRequest

returnFullDocumentImage
boolean or null
Default: false

Defines whether full document image should be extracted. Default FALSE

returnFaceImage
boolean or null
Default: false

Defines whether face image should be extracted. Default FALSE

returnSignatureImage
boolean or null
Default: false

Defines whether signature image should be extracted. Default FALSE

skipImagesWithBlur
boolean or null
Default: true

Defines whether blurred frames filtering is allowed. Default TRUE

enableCharacterValidation
boolean or null
Default: true

Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE

enableBarcodeScanOnly
boolean or null
Default: false

This setting allows barcode recognition to proceed even if the initial extraction fails. If the barcode recognition is successful, the recognizer will still end in a valid state. This setting is applicable only to photo frames. For multi-side recognizers, it is permitted only for the back side. Default FALSE

anonymizationMode
string or null (Anonymization mode)
Default: "FULL_RESULT"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

Array of objects or null (DocumentAnonymizationSettings)
Array of objects or null (DocumentRules)
imageFormat
string or null (Image Format)
Default: "PNG"
Enum: "JPG" "PNG" "QOI"

Defines return image type. Default PNG

ageLimit
integer or null <int32>

Defines the age limit for age verification.

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

scanCroppedDocumentImage
boolean or null
Default: false

Configure the recognizer to only work on already cropped and dewarped images. Default FALSE

skipImagesWithInadequateLightingConditions
boolean or null
Default: false

Indicates whether frames with inadequate lighting conditions should be rejected. A value of true means frames with poor lighting conditions will be excluded from further processing to prevent images with inadequate lighting from being used. Default FALSE

skipImagesOccludedByHand
boolean or null
Default: false

Indicates whether frames occluded by hand should be rejected. A value of true means frames occluded by hand will be excluded from further processing to prevent occluded images from being used. This setting is applicable only if scanCroppedDocumentImage is disabled. Default FALSE

traceId
string or null
{
  • "returnFullDocumentImage": false,
  • "returnFaceImage": false,
  • "returnSignatureImage": false,
  • "skipImagesWithBlur": true,
  • "enableCharacterValidation": true,
  • "enableBarcodeScanOnly": false,
  • "anonymizationMode": "FULL_RESULT",
  • "customDocumentAnonymizationSettings": [
    ],
  • "customDocumentRules": [
    ],
  • "imageFormat": "PNG",
  • "ageLimit": 0,
  • "image": {
    },
  • "scanCroppedDocumentImage": false,
  • "skipImagesWithInadequateLightingConditions": false,
  • "skipImagesOccludedByHand": false,
  • "traceId": "string"
}

Card issuer

string (Card issuer)
Enum: "ISSUER_OTHER" "ISSUER_AMERICAN_EXPRESS" "ISSUER_CHINA_UNION_PAY" "ISSUER_DINERS" "ISSUER_DISCOVER_CARD" "ISSUER_ELO" "ISSUER_JCB" "ISSUER_MAESTRO" "ISSUER_MASTER_CARD" "ISSUER_RU_PAY" "ISSUER_VERVE" "ISSUER_VISA" "ISSUER_VPAY"

Supported issuing institutions that issued the card to the card holder.

"ISSUER_OTHER"

CardNumberAnonymizationSettings

anonymizationMode
string or null (Anonymization mode)
Default: "NONE"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

prefixDigitsVisible
integer or null <int32>
Default: 0

Defines how many digits at the beginning of the card number remain visible after anonymization. Default 0

suffixDigitsVisible
integer or null <int32>
Default: 0

Defines how many digits at the end of the card number remain visible after anonymization. Default 0

{
  • "anonymizationMode": "NONE",
  • "prefixDigitsVisible": 0,
  • "suffixDigitsVisible": 0
}

CheckResult

string (CheckResult)
Enum: "NOT_PERFORMED" "PASS" "FAIL"
"NOT_PERFORMED"

Country

string (Country)
Enum: "COUNTRY_NONE" "COUNTRY_ALBANIA" "COUNTRY_ALGERIA" "COUNTRY_ARGENTINA" "COUNTRY_AUSTRALIA" "COUNTRY_AUSTRIA" "COUNTRY_AZERBAIJAN" "COUNTRY_BAHRAIN" "COUNTRY_BANGLADESH" "COUNTRY_BELGIUM" "COUNTRY_BOSNIA_AND_HERZEGOVINA" "COUNTRY_BRUNEI" "COUNTRY_BULGARIA" "COUNTRY_CAMBODIA" "COUNTRY_CANADA" "COUNTRY_CHILE" "COUNTRY_COLOMBIA" "COUNTRY_COSTA_RICA" "COUNTRY_CROATIA" "COUNTRY_CYPRUS" "COUNTRY_CZECHIA" "COUNTRY_DENMARK" "COUNTRY_DOMINICAN_REPUBLIC" "COUNTRY_EGYPT" "COUNTRY_ESTONIA" "COUNTRY_FINLAND" "COUNTRY_FRANCE" "COUNTRY_GEORGIA" "COUNTRY_GERMANY" "COUNTRY_GHANA" "COUNTRY_GREECE" "COUNTRY_GUATEMALA" "COUNTRY_HONG_KONG" "COUNTRY_HUNGARY" "COUNTRY_INDIA" "COUNTRY_INDONESIA" "COUNTRY_IRELAND" "COUNTRY_ISRAEL" "COUNTRY_ITALY" "COUNTRY_JORDAN" "COUNTRY_KAZAKHSTAN" "COUNTRY_KENYA" "COUNTRY_KOSOVO" "COUNTRY_KUWAIT" "COUNTRY_LATVIA" "COUNTRY_LITHUANIA" "COUNTRY_MALAYSIA" "COUNTRY_MALDIVES" "COUNTRY_MALTA" "COUNTRY_MAURITIUS" "COUNTRY_MEXICO" "COUNTRY_MOROCCO" "COUNTRY_NETHERLANDS" "COUNTRY_NEW_ZEALAND" "COUNTRY_NIGERIA" "COUNTRY_PAKISTAN" "COUNTRY_PANAMA" "COUNTRY_PARAGUAY" "COUNTRY_PHILIPPINES" "COUNTRY_POLAND" "COUNTRY_PORTUGAL" "COUNTRY_PUERTO_RICO" "COUNTRY_QATAR" "COUNTRY_ROMANIA" "COUNTRY_RUSSIA" "COUNTRY_SAUDI_ARABIA" "COUNTRY_SERBIA" "COUNTRY_SINGAPORE" "COUNTRY_SLOVAKIA" "COUNTRY_SLOVENIA" "COUNTRY_SOUTH_AFRICA" "COUNTRY_SPAIN" "COUNTRY_SWEDEN" "COUNTRY_SWITZERLAND" "COUNTRY_TAIWAN" "COUNTRY_THAILAND" "COUNTRY_TUNISIA" "COUNTRY_TURKEY" "COUNTRY_UAE" "COUNTRY_UGANDA" "COUNTRY_UK" "COUNTRY_UKRAINE" "COUNTRY_USA" "COUNTRY_VIETNAM" "COUNTRY_BRAZIL" "COUNTRY_NORWAY" "COUNTRY_OMAN" "COUNTRY_ECUADOR" "COUNTRY_EL_SALVADOR" "COUNTRY_SRI_LANKA" "COUNTRY_PERU" "COUNTRY_URUGUAY" "COUNTRY_BAHAMAS" "COUNTRY_BERMUDA" "COUNTRY_BOLIVIA" "COUNTRY_CHINA" "COUNTRY_EUROPEAN_UNION" "COUNTRY_HAITI" "COUNTRY_HONDURAS" "COUNTRY_ICELAND" "COUNTRY_JAPAN" "COUNTRY_LUXEMBOURG" "COUNTRY_MONTENEGRO" "COUNTRY_NICARAGUA" "COUNTRY_SOUTH_KOREA" "COUNTRY_VENEZUELA" "COUNTRY_AFGHANISTAN" "COUNTRY_ALAND_ISLANDS" "COUNTRY_AMERICAN_SAMOA" "COUNTRY_ANDORRA" "COUNTRY_ANGOLA" "COUNTRY_ANGUILLA" "COUNTRY_ANTARCTICA" "COUNTRY_ANTIGUA_AND_BARBUDA" "COUNTRY_ARMENIA" "COUNTRY_ARUBA" "COUNTRY_BAILIWICK_OF_GUERNSEY" "COUNTRY_BAILIWICK_OF_JERSEY" "COUNTRY_BARBADOS" "COUNTRY_BELARUS" "COUNTRY_BELIZE" "COUNTRY_BENIN" "COUNTRY_BHUTAN" "COUNTRY_BONAIRE_SAINT_EUSTATIUS_AND_SABA" "COUNTRY_BOTSWANA" "COUNTRY_BOUVET_ISLAND" "COUNTRY_BRITISH_INDIAN_OCEAN_TERRITORY" "COUNTRY_BURKINA_FASO" "COUNTRY_BURUNDI" "COUNTRY_CAMEROON" "COUNTRY_CAPE_VERDE" "COUNTRY_CARIBBEAN_NETHERLANDS" "COUNTRY_CAYMAN_ISLANDS" "COUNTRY_CENTRAL_AFRICAN_REPUBLIC" "COUNTRY_CHAD" "COUNTRY_CHRISTMAS_ISLAND" "COUNTRY_COCOS_ISLANDS" "COUNTRY_COMOROS" "COUNTRY_CONGO" "COUNTRY_COOK_ISLANDS" "COUNTRY_CUBA" "COUNTRY_CURACAO" "COUNTRY_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "COUNTRY_DJIBOUTI" "COUNTRY_DOMINICA" "COUNTRY_EAST_TIMOR" "COUNTRY_EQUATORIAL_GUINEA" "COUNTRY_ERITREA" "COUNTRY_ETHIOPIA" "COUNTRY_FALKLAND_ISLANDS" "COUNTRY_FAROE_ISLANDS" "COUNTRY_FEDERATED_STATES_OF_MICRONESIA" "COUNTRY_FIJI" "COUNTRY_FRENCH_GUIANA" "COUNTRY_FRENCH_POLYNESIA" "COUNTRY_FRENCH_SOUTHERN_TERRITORIES" "COUNTRY_GABON" "COUNTRY_GAMBIA" "COUNTRY_GIBRALTAR" "COUNTRY_GREENLAND" "COUNTRY_GRENADA" "COUNTRY_GUADELOUPE" "COUNTRY_GUAM" "COUNTRY_GUINEA" "COUNTRY_GUINEA_BISSAU" "COUNTRY_GUYANA" "COUNTRY_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "COUNTRY_IRAN" "COUNTRY_IRAQ" "COUNTRY_ISLE_OF_MAN" "COUNTRY_IVORY_COAST" "COUNTRY_JAMAICA" "COUNTRY_KIRIBATI" "COUNTRY_KYRGYZSTAN" "COUNTRY_LAOS" "COUNTRY_LEBANON" "COUNTRY_LESOTHO" "COUNTRY_LIBERIA" "COUNTRY_LIBYA" "COUNTRY_LIECHTENSTEIN" "COUNTRY_MACAU" "COUNTRY_MADAGASCAR" "COUNTRY_MALAWI" "COUNTRY_MALI" "COUNTRY_MARSHALL_ISLANDS" "COUNTRY_MARTINIQUE" "COUNTRY_MAURITANIA" "COUNTRY_MAYOTTE" "COUNTRY_MOLDOVA" "COUNTRY_MONACO" "COUNTRY_MONGOLIA" "COUNTRY_MONTSERRAT" "COUNTRY_MOZAMBIQUE" "COUNTRY_MYANMAR" "COUNTRY_NAMIBIA" "COUNTRY_NAURU" "COUNTRY_NEPAL" "COUNTRY_NEW_CALEDONIA" "COUNTRY_NIGER" "COUNTRY_NIUE" "COUNTRY_NORFOLK_ISLAND" "COUNTRY_NORTHERN_CYPRUS" "COUNTRY_NORTHERN_MARIANA_ISLANDS" "COUNTRY_NORTH_KOREA" "COUNTRY_NORTH_MACEDONIA" "COUNTRY_PALAU" "COUNTRY_PALESTINE" "COUNTRY_PAPUA_NEW_GUINEA" "COUNTRY_PITCAIRN" "COUNTRY_REUNION" "COUNTRY_RWANDA" "COUNTRY_SAINT_BARTHELEMY" "COUNTRY_SAINT_HELENA_ASCENSION_AND_TRISTIAN_DA_CUNHA" "COUNTRY_SAINT_KITTS_AND_NEVIS" "COUNTRY_SAINT_LUCIA" "COUNTRY_SAINT_MARTIN" "COUNTRY_SAINT_PIERRE_AND_MIQUELON" "COUNTRY_SAINT_VINCENT_AND_THE_GRENADINES" "COUNTRY_SAMOA" "COUNTRY_SAN_MARINO" "COUNTRY_SAO_TOME_AND_PRINCIPE" "COUNTRY_SENEGAL" "COUNTRY_SEYCHELLES" "COUNTRY_SIERRA_LEONE" "COUNTRY_SINT_MAARTEN" "COUNTRY_SOLOMON_ISLANDS" "COUNTRY_SOMALIA" "COUNTRY_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "COUNTRY_SOUTH_SUDAN" "COUNTRY_SUDAN" "COUNTRY_SURINAME" "COUNTRY_SVALBARD_AND_JAN_MAYEN" "COUNTRY_ESWATINI" "COUNTRY_SYRIA" "COUNTRY_TAJIKISTAN" "COUNTRY_TANZANIA" "COUNTRY_TOGO" "COUNTRY_TOKELAU" "COUNTRY_TONGA" "COUNTRY_TRINIDAD_AND_TOBAGO" "COUNTRY_TURKMENISTAN" "COUNTRY_TURKS_AND_CAICOS_ISLANDS" "COUNTRY_TUVALU" "COUNTRY_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "COUNTRY_UZBEKISTAN" "COUNTRY_VANUATU" "COUNTRY_VATICAN_CITY" "COUNTRY_VIRGIN_ISLANDS_BRITISH" "COUNTRY_VIRGIN_ISLANDS_US" "COUNTRY_WALLIS_AND_FUTUNA" "COUNTRY_WESTERN_SAHARA" "COUNTRY_YEMEN" "COUNTRY_YUGOSLAVIA" "COUNTRY_ZAMBIA" "COUNTRY_ZIMBABWE" "COUNTRY_SCHENGEN_AREA"

Document country.

"COUNTRY_NONE"

CroppedImageResult

image
required
string

The cropped image.

{
  • "image": "string"
}

DataMatchResult

dateOfBirth
string or null (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

dateOfExpiry
required
string (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

documentNumber
string or null (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

documentAdditionalNumber
string or null (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

documentOptionalAdditionalNumber
string or null (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

personalIdNumber
string or null (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

dataMatchResult
string or null (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

{
  • "dateOfBirth": "NOT_PERFORMED",
  • "dateOfExpiry": "NOT_PERFORMED",
  • "documentNumber": "NOT_PERFORMED",
  • "documentAdditionalNumber": "NOT_PERFORMED",
  • "documentOptionalAdditionalNumber": "NOT_PERFORMED",
  • "personalIdNumber": "NOT_PERFORMED",
  • "dataMatchResult": "NOT_PERFORMED"
}

Data match state

string (Data match state)
Enum: "NOT_PERFORMED" "FAILED" "SUCCESS"

We currently check document number, date of expiry, date of birth and date of issue fields.

"NOT_PERFORMED"

Date

day
integer or null <int32>

Day in month

month
integer or null <int32>

Month in year

year
integer or null <int32>

Year

successfullyParsed
boolean or null

True if date was successfully parsed

filledByDomainKnowledge
boolean or null

True if date was filled by domain knowledge

originalString
string or null

String used in date parsing

{
  • "day": 0,
  • "month": 0,
  • "year": 0,
  • "successfullyParsed": true,
  • "filledByDomainKnowledge": true,
  • "originalString": "string"
}

DateResult

day
integer or null <int32>

Day in month

month
integer or null <int32>

Month in year

year
integer or null <int32>

Year

successfullyParsed
boolean or null

True if date was successfully parsed

filledByDomainKnowledge
boolean or null

True if date was filled by domain knowledge

object or null

String used in date parsing

{
  • "day": 0,
  • "month": 0,
  • "year": 0,
  • "successfullyParsed": true,
  • "filledByDomainKnowledge": true,
  • "originalString": {
    }
}

DefaultResponse

message
string or null

Exception message

traceId
string or null

Provided identifier

executionId
required
string

Unique execution identifier

{
  • "message": "string",
  • "traceId": "string",
  • "executionId": "string"
}

DependentInfo

object or null

The date of birth of the dependent.

object or null

The sex or gender of the dependent.

object or null

The document number of the dependent.

object or null

The full name of the dependent.

{
  • "dateOfBirth": {
    },
  • "sex": {
    },
  • "documentNumber": {
    },
  • "fullName": {
    }
}

DetailedCroppedImageResult

image
required
string

The cropped image.

object or null

Location of the image. Coordinates are relative to the dewarped image.

side
string or null (Scanning side)
Enum: "FIRST" "SECOND"

Represents the sides of the document that can be scanned.

{
  • "image": "string",
  • "location": {
    },
  • "side": "FIRST"
}

DetailedFieldType

fieldType
string or null
Enum: "ADDITIONAL_ADDRESS_INFORMATION" "ADDITIONAL_NAME_INFORMATION" "ADDITIONAL_OPTIONAL_ADDRESS_INFORMATION" "ADDITIONAL_PERSONAL_ID_NUMBER" "ADDRESS" "CLASS_EFFECTIVE_DATE" "CLASS_EXPIRY_DATE" "CONDITIONS" "DATE_OF_BIRTH" "DATE_OF_EXPIRY" "DATE_OF_ISSUE" "DOCUMENT_ADDITIONAL_NUMBER" "DOCUMENT_OPTIONAL_ADDITIONAL_NUMBER" "DOCUMENT_NUMBER" "EMPLOYER" "ENDORSEMENTS" "FATHERS_NAME" "FIRST_NAME" "FULL_NAME" "ISSUING_AUTHORITY" "LAST_NAME" "LICENCE_TYPE" "LOCALIZED_NAME" "MARITAL_STATUS" "MOTHERS_NAME" "MRZ" "NATIONALITY" "PERSONAL_ID_NUMBER" "PLACE_OF_BIRTH" "PROFESSION" "RACE" "RELIGION" "RESIDENTIAL_STATUS" "RESTRICTIONS" "SEX" "VEHICLE_CLASS" "BLOOD_TYPE" "SPONSOR" "VISA_TYPE" "NUMBER_OF_ENTRIES" "DURATION_OF_STAY" "DOCUMENT_SUBTYPE" "REMARKS" "RESIDENCE_PERMIT_TYPE" "MANUFACTURING_YEAR" "VEHICLE_TYPE" "DEPENDENT_DATE_OF_BIRTH" "DEPENDENT_SEX" "DEPENDENT_DOCUMENT_NUMBER" "DEPENDENT_FULL_NAME" "ELIGIBILITY_CATEGORY" "SPECIFIC_DOCUMENT_VALIDITY" "VEHICLE_OWNER" "NATIONAL_INSURANCE_NUMBER" "COUNTRY_CODE" "CERTIFICATE_NUMBER" "MUNICIPALITY_OF_REGISTRATION" "LOCALITY_CODE" "MAIDEN_NAME" "STATE_CODE" "DATE_OF_ENTRY" "MUNICIPALITY_CODE" "POLLING_STATION_CODE" "SECTION_CODE" "REGISTRATION_CENTER_CODE" "STATE_NAME"

Field type

alphabetType
string or null
Enum: "LATIN" "ARABIC" "CYRILLIC" "GREEK"

Alphabet type

{
  • "fieldType": "ADDITIONAL_ADDRESS_INFORMATION",
  • "alphabetType": "LATIN"
}

DetectionPoints

Array of objects or null (Points)
{
  • "points": [
    ]
}

Dimensions

width
number or null <float>
height
number or null <float>
{
  • "width": 0.1,
  • "height": 0.1
}

DocumentAnonymizationSettings

object or null

Specified fields will be anonymized if filter conditions are met.

fields
required
Array of strings (FieldType)
Items Enum: "ADDITIONAL_ADDRESS_INFORMATION" "ADDITIONAL_NAME_INFORMATION" "ADDITIONAL_OPTIONAL_ADDRESS_INFORMATION" "ADDITIONAL_PERSONAL_ID_NUMBER" "ADDRESS" "CLASS_EFFECTIVE_DATE" "CLASS_EXPIRY_DATE" "CONDITIONS" "DATE_OF_BIRTH" "DATE_OF_EXPIRY" "DATE_OF_ISSUE" "DOCUMENT_ADDITIONAL_NUMBER" "DOCUMENT_OPTIONAL_ADDITIONAL_NUMBER" "DOCUMENT_NUMBER" "EMPLOYER" "ENDORSEMENTS" "FATHERS_NAME" "FIRST_NAME" "FULL_NAME" "ISSUING_AUTHORITY" "LAST_NAME" "LICENCE_TYPE" "LOCALIZED_NAME" "MARITAL_STATUS" "MOTHERS_NAME" "MRZ" "NATIONALITY" "PERSONAL_ID_NUMBER" "PLACE_OF_BIRTH" "PROFESSION" "RACE" "RELIGION" "RESIDENTIAL_STATUS" "RESTRICTIONS" "SEX" "VEHICLE_CLASS" "BLOOD_TYPE" "SPONSOR" "VISA_TYPE" "NUMBER_OF_ENTRIES" "DURATION_OF_STAY" "DOCUMENT_SUBTYPE" "REMARKS" "RESIDENCE_PERMIT_TYPE" "MANUFACTURING_YEAR" "VEHICLE_TYPE" "DEPENDENT_DATE_OF_BIRTH" "DEPENDENT_SEX" "DEPENDENT_DOCUMENT_NUMBER" "DEPENDENT_FULL_NAME" "ELIGIBILITY_CATEGORY" "SPECIFIC_DOCUMENT_VALIDITY" "VEHICLE_OWNER" "NATIONAL_INSURANCE_NUMBER" "COUNTRY_CODE" "CERTIFICATE_NUMBER" "MUNICIPALITY_OF_REGISTRATION" "LOCALITY_CODE" "MAIDEN_NAME" "STATE_CODE" "DATE_OF_ENTRY" "MUNICIPALITY_CODE" "POLLING_STATION_CODE" "SECTION_CODE" "REGISTRATION_CENTER_CODE" "STATE_NAME"

Fields to be anonymized.

object or null

If set, document number will be partially anonymized. Otherwise, document number anonymization settings will not be taken into account during anonymization.

{
  • "documentFilter": {
    },
  • "fields": [
    ],
  • "documentNumberAnonymizationSettings": {
    }
}

DocumentClassInfo

country
string or null (Country)
Enum: "COUNTRY_NONE" "COUNTRY_ALBANIA" "COUNTRY_ALGERIA" "COUNTRY_ARGENTINA" "COUNTRY_AUSTRALIA" "COUNTRY_AUSTRIA" "COUNTRY_AZERBAIJAN" "COUNTRY_BAHRAIN" "COUNTRY_BANGLADESH" "COUNTRY_BELGIUM" "COUNTRY_BOSNIA_AND_HERZEGOVINA" "COUNTRY_BRUNEI" "COUNTRY_BULGARIA" "COUNTRY_CAMBODIA" "COUNTRY_CANADA" "COUNTRY_CHILE" "COUNTRY_COLOMBIA" "COUNTRY_COSTA_RICA" "COUNTRY_CROATIA" "COUNTRY_CYPRUS" "COUNTRY_CZECHIA" "COUNTRY_DENMARK" "COUNTRY_DOMINICAN_REPUBLIC" "COUNTRY_EGYPT" "COUNTRY_ESTONIA" "COUNTRY_FINLAND" "COUNTRY_FRANCE" "COUNTRY_GEORGIA" "COUNTRY_GERMANY" "COUNTRY_GHANA" "COUNTRY_GREECE" "COUNTRY_GUATEMALA" "COUNTRY_HONG_KONG" "COUNTRY_HUNGARY" "COUNTRY_INDIA" "COUNTRY_INDONESIA" "COUNTRY_IRELAND" "COUNTRY_ISRAEL" "COUNTRY_ITALY" "COUNTRY_JORDAN" "COUNTRY_KAZAKHSTAN" "COUNTRY_KENYA" "COUNTRY_KOSOVO" "COUNTRY_KUWAIT" "COUNTRY_LATVIA" "COUNTRY_LITHUANIA" "COUNTRY_MALAYSIA" "COUNTRY_MALDIVES" "COUNTRY_MALTA" "COUNTRY_MAURITIUS" "COUNTRY_MEXICO" "COUNTRY_MOROCCO" "COUNTRY_NETHERLANDS" "COUNTRY_NEW_ZEALAND" "COUNTRY_NIGERIA" "COUNTRY_PAKISTAN" "COUNTRY_PANAMA" "COUNTRY_PARAGUAY" "COUNTRY_PHILIPPINES" "COUNTRY_POLAND" "COUNTRY_PORTUGAL" "COUNTRY_PUERTO_RICO" "COUNTRY_QATAR" "COUNTRY_ROMANIA" "COUNTRY_RUSSIA" "COUNTRY_SAUDI_ARABIA" "COUNTRY_SERBIA" "COUNTRY_SINGAPORE" "COUNTRY_SLOVAKIA" "COUNTRY_SLOVENIA" "COUNTRY_SOUTH_AFRICA" "COUNTRY_SPAIN" "COUNTRY_SWEDEN" "COUNTRY_SWITZERLAND" "COUNTRY_TAIWAN" "COUNTRY_THAILAND" "COUNTRY_TUNISIA" "COUNTRY_TURKEY" "COUNTRY_UAE" "COUNTRY_UGANDA" "COUNTRY_UK" "COUNTRY_UKRAINE" "COUNTRY_USA" "COUNTRY_VIETNAM" "COUNTRY_BRAZIL" "COUNTRY_NORWAY" "COUNTRY_OMAN" "COUNTRY_ECUADOR" "COUNTRY_EL_SALVADOR" "COUNTRY_SRI_LANKA" "COUNTRY_PERU" "COUNTRY_URUGUAY" "COUNTRY_BAHAMAS" "COUNTRY_BERMUDA" "COUNTRY_BOLIVIA" "COUNTRY_CHINA" "COUNTRY_EUROPEAN_UNION" "COUNTRY_HAITI" "COUNTRY_HONDURAS" "COUNTRY_ICELAND" "COUNTRY_JAPAN" "COUNTRY_LUXEMBOURG" "COUNTRY_MONTENEGRO" "COUNTRY_NICARAGUA" "COUNTRY_SOUTH_KOREA" "COUNTRY_VENEZUELA" "COUNTRY_AFGHANISTAN" "COUNTRY_ALAND_ISLANDS" "COUNTRY_AMERICAN_SAMOA" "COUNTRY_ANDORRA" "COUNTRY_ANGOLA" "COUNTRY_ANGUILLA" "COUNTRY_ANTARCTICA" "COUNTRY_ANTIGUA_AND_BARBUDA" "COUNTRY_ARMENIA" "COUNTRY_ARUBA" "COUNTRY_BAILIWICK_OF_GUERNSEY" "COUNTRY_BAILIWICK_OF_JERSEY" "COUNTRY_BARBADOS" "COUNTRY_BELARUS" "COUNTRY_BELIZE" "COUNTRY_BENIN" "COUNTRY_BHUTAN" "COUNTRY_BONAIRE_SAINT_EUSTATIUS_AND_SABA" "COUNTRY_BOTSWANA" "COUNTRY_BOUVET_ISLAND" "COUNTRY_BRITISH_INDIAN_OCEAN_TERRITORY" "COUNTRY_BURKINA_FASO" "COUNTRY_BURUNDI" "COUNTRY_CAMEROON" "COUNTRY_CAPE_VERDE" "COUNTRY_CARIBBEAN_NETHERLANDS" "COUNTRY_CAYMAN_ISLANDS" "COUNTRY_CENTRAL_AFRICAN_REPUBLIC" "COUNTRY_CHAD" "COUNTRY_CHRISTMAS_ISLAND" "COUNTRY_COCOS_ISLANDS" "COUNTRY_COMOROS" "COUNTRY_CONGO" "COUNTRY_COOK_ISLANDS" "COUNTRY_CUBA" "COUNTRY_CURACAO" "COUNTRY_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "COUNTRY_DJIBOUTI" "COUNTRY_DOMINICA" "COUNTRY_EAST_TIMOR" "COUNTRY_EQUATORIAL_GUINEA" "COUNTRY_ERITREA" "COUNTRY_ETHIOPIA" "COUNTRY_FALKLAND_ISLANDS" "COUNTRY_FAROE_ISLANDS" "COUNTRY_FEDERATED_STATES_OF_MICRONESIA" "COUNTRY_FIJI" "COUNTRY_FRENCH_GUIANA" "COUNTRY_FRENCH_POLYNESIA" "COUNTRY_FRENCH_SOUTHERN_TERRITORIES" "COUNTRY_GABON" "COUNTRY_GAMBIA" "COUNTRY_GIBRALTAR" "COUNTRY_GREENLAND" "COUNTRY_GRENADA" "COUNTRY_GUADELOUPE" "COUNTRY_GUAM" "COUNTRY_GUINEA" "COUNTRY_GUINEA_BISSAU" "COUNTRY_GUYANA" "COUNTRY_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "COUNTRY_IRAN" "COUNTRY_IRAQ" "COUNTRY_ISLE_OF_MAN" "COUNTRY_IVORY_COAST" "COUNTRY_JAMAICA" "COUNTRY_KIRIBATI" "COUNTRY_KYRGYZSTAN" "COUNTRY_LAOS" "COUNTRY_LEBANON" "COUNTRY_LESOTHO" "COUNTRY_LIBERIA" "COUNTRY_LIBYA" "COUNTRY_LIECHTENSTEIN" "COUNTRY_MACAU" "COUNTRY_MADAGASCAR" "COUNTRY_MALAWI" "COUNTRY_MALI" "COUNTRY_MARSHALL_ISLANDS" "COUNTRY_MARTINIQUE" "COUNTRY_MAURITANIA" "COUNTRY_MAYOTTE" "COUNTRY_MOLDOVA" "COUNTRY_MONACO" "COUNTRY_MONGOLIA" "COUNTRY_MONTSERRAT" "COUNTRY_MOZAMBIQUE" "COUNTRY_MYANMAR" "COUNTRY_NAMIBIA" "COUNTRY_NAURU" "COUNTRY_NEPAL" "COUNTRY_NEW_CALEDONIA" "COUNTRY_NIGER" "COUNTRY_NIUE" "COUNTRY_NORFOLK_ISLAND" "COUNTRY_NORTHERN_CYPRUS" "COUNTRY_NORTHERN_MARIANA_ISLANDS" "COUNTRY_NORTH_KOREA" "COUNTRY_NORTH_MACEDONIA" "COUNTRY_PALAU" "COUNTRY_PALESTINE" "COUNTRY_PAPUA_NEW_GUINEA" "COUNTRY_PITCAIRN" "COUNTRY_REUNION" "COUNTRY_RWANDA" "COUNTRY_SAINT_BARTHELEMY" "COUNTRY_SAINT_HELENA_ASCENSION_AND_TRISTIAN_DA_CUNHA" "COUNTRY_SAINT_KITTS_AND_NEVIS" "COUNTRY_SAINT_LUCIA" "COUNTRY_SAINT_MARTIN" "COUNTRY_SAINT_PIERRE_AND_MIQUELON" "COUNTRY_SAINT_VINCENT_AND_THE_GRENADINES" "COUNTRY_SAMOA" "COUNTRY_SAN_MARINO" "COUNTRY_SAO_TOME_AND_PRINCIPE" "COUNTRY_SENEGAL" "COUNTRY_SEYCHELLES" "COUNTRY_SIERRA_LEONE" "COUNTRY_SINT_MAARTEN" "COUNTRY_SOLOMON_ISLANDS" "COUNTRY_SOMALIA" "COUNTRY_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "COUNTRY_SOUTH_SUDAN" "COUNTRY_SUDAN" "COUNTRY_SURINAME" "COUNTRY_SVALBARD_AND_JAN_MAYEN" "COUNTRY_ESWATINI" "COUNTRY_SYRIA" "COUNTRY_TAJIKISTAN" "COUNTRY_TANZANIA" "COUNTRY_TOGO" "COUNTRY_TOKELAU" "COUNTRY_TONGA" "COUNTRY_TRINIDAD_AND_TOBAGO" "COUNTRY_TURKMENISTAN" "COUNTRY_TURKS_AND_CAICOS_ISLANDS" "COUNTRY_TUVALU" "COUNTRY_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "COUNTRY_UZBEKISTAN" "COUNTRY_VANUATU" "COUNTRY_VATICAN_CITY" "COUNTRY_VIRGIN_ISLANDS_BRITISH" "COUNTRY_VIRGIN_ISLANDS_US" "COUNTRY_WALLIS_AND_FUTUNA" "COUNTRY_WESTERN_SAHARA" "COUNTRY_YEMEN" "COUNTRY_YUGOSLAVIA" "COUNTRY_ZAMBIA" "COUNTRY_ZIMBABWE" "COUNTRY_SCHENGEN_AREA"

Document country.

region
string or null (Region)
Enum: "REGION_NONE" "REGION_ALABAMA" "REGION_ALASKA" "REGION_ALBERTA" "REGION_ARIZONA" "REGION_ARKANSAS" "REGION_AUSTRALIAN_CAPITAL_TERRITORY" "REGION_BRITISH_COLUMBIA" "REGION_CALIFORNIA" "REGION_COLORADO" "REGION_CONNECTICUT" "REGION_DELAWARE" "REGION_DISTRICT_OF_COLUMBIA" "REGION_FLORIDA" "REGION_GEORGIA" "REGION_HAWAII" "REGION_IDAHO" "REGION_ILLINOIS" "REGION_INDIANA" "REGION_IOWA" "REGION_KANSAS" "REGION_KENTUCKY" "REGION_LOUISIANA" "REGION_MAINE" "REGION_MANITOBA" "REGION_MARYLAND" "REGION_MASSACHUSETTS" "REGION_MICHIGAN" "REGION_MINNESOTA" "REGION_MISSISSIPPI" "REGION_MISSOURI" "REGION_MONTANA" "REGION_NEBRASKA" "REGION_NEVADA" "REGION_NEW_BRUNSWICK" "REGION_NEW_HAMPSHIRE" "REGION_NEW_JERSEY" "REGION_NEW_MEXICO" "REGION_NEW_SOUTH_WALES" "REGION_NEW_YORK" "REGION_NORTHERN_TERRITORY" "REGION_NORTH_CAROLINA" "REGION_NORTH_DAKOTA" "REGION_NOVA_SCOTIA" "REGION_OHIO" "REGION_OKLAHOMA" "REGION_ONTARIO" "REGION_OREGON" "REGION_PENNSYLVANIA" "REGION_QUEBEC" "REGION_QUEENSLAND" "REGION_RHODE_ISLAND" "REGION_SASKATCHEWAN" "REGION_SOUTH_AUSTRALIA" "REGION_SOUTH_CAROLINA" "REGION_SOUTH_DAKOTA" "REGION_TASMANIA" "REGION_TENNESSEE" "REGION_TEXAS" "REGION_UTAH" "REGION_VERMONT" "REGION_VICTORIA" "REGION_VIRGINIA" "REGION_WASHINGTON" "REGION_WESTERN_AUSTRALIA" "REGION_WEST_VIRGINIA" "REGION_WISCONSIN" "REGION_WYOMING" "REGION_YUKON" "REGION_CIUDAD_DE_MEXICO" "REGION_JALISCO" "REGION_NEWFOUNDLAND_AND_LABRADOR" "REGION_NUEVO_LEON" "REGION_BAJA_CALIFORNIA" "REGION_CHIHUAHUA" "REGION_GUANAJUATO" "REGION_GUERRERO" "REGION_MEXICO" "REGION_MICHOACAN" "REGION_NEW_YORK_CITY" "REGION_TAMAULIPAS" "REGION_VERACRUZ" "REGION_CHIAPAS" "REGION_COAHUILA" "REGION_DURANGO" "REGION_GUERRERO_COCULA" "REGION_GUERRERO_JUCHITAN" "REGION_GUERRERO_TEPECOACUILCO" "REGION_GUERRERO_TLACOAPA" "REGION_GUJARAT" "REGION_HIDALGO" "REGION_KARNATAKA" "REGION_KERALA" "REGION_KHYBER_PAKHTUNKHWA" "REGION_MADHYA_PRADESH" "REGION_MAHARASHTRA" "REGION_MORELOS" "REGION_NAYARIT" "REGION_OAXACA" "REGION_PUEBLA" "REGION_PUNJAB" "REGION_QUERETARO" "REGION_SAN_LUIS_POTOSI" "REGION_SINALOA" "REGION_SONORA" "REGION_TABASCO" "REGION_TAMIL_NADU" "REGION_YUCATAN" "REGION_ZACATECAS" "REGION_AGUASCALIENTES" "REGION_BAJA_CALIFORNIA_SUR" "REGION_CAMPECHE" "REGION_COLIMA" "REGION_QUINTANA_ROO_BENITO_JUAREZ" "REGION_QUINTANA_ROO" "REGION_QUINTANA_ROO_SOLIDARIDAD" "REGION_TLAXCALA" "REGION_QUINTANA_ROO_COZUMEL" "REGION_SAO_PAOLO" "REGION_RIO_DE_JANEIRO" "REGION_RIO_GRANDE_DO_SUL" "REGION_NORTHWEST_TERRITORIES" "REGION_NUNAVUT" "REGION_PRINCE_EDWARD_ISLAND" "REGION_DISTRITO_FEDERAL" "REGION_MARANHAO" "REGION_MATO_GROSSO" "REGION_MINAS_GERAIS" "REGION_PARA" "REGION_PARANA" "REGION_PERNAMBUCO" "REGION_SANTA_CATARINA" "REGION_ANDHRA_PRADESH" "REGION_CEARA" "REGION_GOIAS" "REGION_GUERRERO_ACAPULCO_DE_JUAREZ" "REGION_HARYANA" "REGION_SERGIPE" "REGION_ALAGOAS" "REGION_BANGSAMORO" "REGION_TELANGANA"

Document region.

type
string or null (Type)
Enum: "TYPE_NONE" "TYPE_CONSULAR_ID" "TYPE_DL" "TYPE_DL_PUBLIC_SERVICES_CARD" "TYPE_EMPLOYMENT_PASS" "TYPE_FIN_CARD" "TYPE_ID" "TYPE_MULTIPURPOSE_ID" "TYPE_MyKad" "TYPE_MyKid" "TYPE_MyPR" "TYPE_MyTentera" "TYPE_PAN_CARD" "TYPE_PROFESSIONAL_ID" "TYPE_PUBLIC_SERVICES_CARD" "TYPE_RESIDENCE_PERMIT" "TYPE_RESIDENT_ID" "TYPE_TEMPORARY_RESIDENCE_PERMIT" "TYPE_VOTER_ID" "TYPE_WORK_PERMIT" "TYPE_iKAD" "TYPE_MILITARY_ID" "TYPE_MyKAS" "TYPE_SOCIAL_SECURITY_CARD" "TYPE_HEALTH_INSURANCE_CARD" "TYPE_PASSPORT" "TYPE_S_PASS" "TYPE_ADDRESS_CARD" "TYPE_ALIEN_ID" "TYPE_ALIEN_PASSPORT" "TYPE_GREEN_CARD" "TYPE_MINORS_ID" "TYPE_POSTAL_ID" "TYPE_PROFESSIONAL_DL" "TYPE_TAX_ID" "TYPE_WEAPON_PERMIT" "TYPE_VISA" "TYPE_BORDER_CROSSING_CARD" "TYPE_DRIVER_CARD" "TYPE_GLOBAL_ENTRY_CARD" "TYPE_MyPolis" "TYPE_NEXUS_CARD" "TYPE_PASSPORT_CARD" "TYPE_PROOF_OF_AGE_CARD" "TYPE_REFUGEE_ID" "TYPE_TRIBAL_ID" "TYPE_VETERAN_ID" "TYPE_CITIZENSHIP_CERTIFICATE" "TYPE_MY_NUMBER_CARD" "TYPE_CONSULAR_PASSPORT" "TYPE_MINORS_PASSPORT" "TYPE_MINORS_PUBLIC_SERVICES_CARD" "TYPE_DRIVING_PRIVILEGE_CARD" "TYPE_ASYLUM_REQUEST" "TYPE_DRIVER_QUALIFICATION_CARD" "TYPE_PROVISIONAL_DL" "TYPE_REFUGEE_PASSPORT" "TYPE_SPECIAL_ID" "TYPE_UNIFORMED_SERVICES_ID" "TYPE_IMMIGRANT_VISA" "TYPE_CONSULAR_VOTER_ID" "TYPE_TWIC_CARD" "TYPE_EXIT_ENTRY_PERMIT" "TYPE_MAINLAND_TRAVEL_PERMIT_TAIWAN" "TYPE_NBI_CLEARANCE" "TYPE_PROOF_OF_REGISTRATION" "TYPE_TEMPORARY_PROTECTION_PERMIT" "TYPE_AFGHAN_CITIZEN_CARD" "TYPE_EID" "TYPE_PASS" "TYPE_SIS_ID" "TYPE_ASIC_CARD" "TYPE_BIDOON_CARD" "TYPE_INTERIM_HEALTH_INSURANCE_CARD" "TYPE_NON_VOTER_ID" "TYPE_RECIPROCAL_HEALTH_INSURANCE_CARD" "TYPE_VEHICLE_REGISTRATION" "TYPE_ESAAD_CARD" "TYPE_REGISTRATION_CERTIFICATE" "TYPE_MEDICAL_MARIJUANA_ID" "TYPE_NON_CARD_TRIBAL_ID" "TYPE_DIPLOMATIC_ID" "TYPE_EMERGENCY_PASSPORT" "TYPE_TEMPORARY_PASSPORT" "TYPE_METIS_FEDERATION_CARD" "TYPE_ADR_CERTIFICATE"

Document type.

countryName
string or null

The name of the country that issued the scanned document.

isoAlpha3CountryCode
string or null

The 3 letter ISO code of the country that issued the scanned document.

isoAlpha2CountryCode
string or null

The 2 letter ISO code of the country that issued the scanned document.

isoNumericCountryCode
string or null

The ISO numeric code of the country that issued the scanned document.

{
  • "country": "COUNTRY_NONE",
  • "region": "REGION_NONE",
  • "type": "TYPE_NONE",
  • "countryName": "string",
  • "isoAlpha3CountryCode": "string",
  • "isoAlpha2CountryCode": "string",
  • "isoNumericCountryCode": "string"
}

DocumentFilter

country
string or null (Country)
Enum: "COUNTRY_NONE" "COUNTRY_ALBANIA" "COUNTRY_ALGERIA" "COUNTRY_ARGENTINA" "COUNTRY_AUSTRALIA" "COUNTRY_AUSTRIA" "COUNTRY_AZERBAIJAN" "COUNTRY_BAHRAIN" "COUNTRY_BANGLADESH" "COUNTRY_BELGIUM" "COUNTRY_BOSNIA_AND_HERZEGOVINA" "COUNTRY_BRUNEI" "COUNTRY_BULGARIA" "COUNTRY_CAMBODIA" "COUNTRY_CANADA" "COUNTRY_CHILE" "COUNTRY_COLOMBIA" "COUNTRY_COSTA_RICA" "COUNTRY_CROATIA" "COUNTRY_CYPRUS" "COUNTRY_CZECHIA" "COUNTRY_DENMARK" "COUNTRY_DOMINICAN_REPUBLIC" "COUNTRY_EGYPT" "COUNTRY_ESTONIA" "COUNTRY_FINLAND" "COUNTRY_FRANCE" "COUNTRY_GEORGIA" "COUNTRY_GERMANY" "COUNTRY_GHANA" "COUNTRY_GREECE" "COUNTRY_GUATEMALA" "COUNTRY_HONG_KONG" "COUNTRY_HUNGARY" "COUNTRY_INDIA" "COUNTRY_INDONESIA" "COUNTRY_IRELAND" "COUNTRY_ISRAEL" "COUNTRY_ITALY" "COUNTRY_JORDAN" "COUNTRY_KAZAKHSTAN" "COUNTRY_KENYA" "COUNTRY_KOSOVO" "COUNTRY_KUWAIT" "COUNTRY_LATVIA" "COUNTRY_LITHUANIA" "COUNTRY_MALAYSIA" "COUNTRY_MALDIVES" "COUNTRY_MALTA" "COUNTRY_MAURITIUS" "COUNTRY_MEXICO" "COUNTRY_MOROCCO" "COUNTRY_NETHERLANDS" "COUNTRY_NEW_ZEALAND" "COUNTRY_NIGERIA" "COUNTRY_PAKISTAN" "COUNTRY_PANAMA" "COUNTRY_PARAGUAY" "COUNTRY_PHILIPPINES" "COUNTRY_POLAND" "COUNTRY_PORTUGAL" "COUNTRY_PUERTO_RICO" "COUNTRY_QATAR" "COUNTRY_ROMANIA" "COUNTRY_RUSSIA" "COUNTRY_SAUDI_ARABIA" "COUNTRY_SERBIA" "COUNTRY_SINGAPORE" "COUNTRY_SLOVAKIA" "COUNTRY_SLOVENIA" "COUNTRY_SOUTH_AFRICA" "COUNTRY_SPAIN" "COUNTRY_SWEDEN" "COUNTRY_SWITZERLAND" "COUNTRY_TAIWAN" "COUNTRY_THAILAND" "COUNTRY_TUNISIA" "COUNTRY_TURKEY" "COUNTRY_UAE" "COUNTRY_UGANDA" "COUNTRY_UK" "COUNTRY_UKRAINE" "COUNTRY_USA" "COUNTRY_VIETNAM" "COUNTRY_BRAZIL" "COUNTRY_NORWAY" "COUNTRY_OMAN" "COUNTRY_ECUADOR" "COUNTRY_EL_SALVADOR" "COUNTRY_SRI_LANKA" "COUNTRY_PERU" "COUNTRY_URUGUAY" "COUNTRY_BAHAMAS" "COUNTRY_BERMUDA" "COUNTRY_BOLIVIA" "COUNTRY_CHINA" "COUNTRY_EUROPEAN_UNION" "COUNTRY_HAITI" "COUNTRY_HONDURAS" "COUNTRY_ICELAND" "COUNTRY_JAPAN" "COUNTRY_LUXEMBOURG" "COUNTRY_MONTENEGRO" "COUNTRY_NICARAGUA" "COUNTRY_SOUTH_KOREA" "COUNTRY_VENEZUELA" "COUNTRY_AFGHANISTAN" "COUNTRY_ALAND_ISLANDS" "COUNTRY_AMERICAN_SAMOA" "COUNTRY_ANDORRA" "COUNTRY_ANGOLA" "COUNTRY_ANGUILLA" "COUNTRY_ANTARCTICA" "COUNTRY_ANTIGUA_AND_BARBUDA" "COUNTRY_ARMENIA" "COUNTRY_ARUBA" "COUNTRY_BAILIWICK_OF_GUERNSEY" "COUNTRY_BAILIWICK_OF_JERSEY" "COUNTRY_BARBADOS" "COUNTRY_BELARUS" "COUNTRY_BELIZE" "COUNTRY_BENIN" "COUNTRY_BHUTAN" "COUNTRY_BONAIRE_SAINT_EUSTATIUS_AND_SABA" "COUNTRY_BOTSWANA" "COUNTRY_BOUVET_ISLAND" "COUNTRY_BRITISH_INDIAN_OCEAN_TERRITORY" "COUNTRY_BURKINA_FASO" "COUNTRY_BURUNDI" "COUNTRY_CAMEROON" "COUNTRY_CAPE_VERDE" "COUNTRY_CARIBBEAN_NETHERLANDS" "COUNTRY_CAYMAN_ISLANDS" "COUNTRY_CENTRAL_AFRICAN_REPUBLIC" "COUNTRY_CHAD" "COUNTRY_CHRISTMAS_ISLAND" "COUNTRY_COCOS_ISLANDS" "COUNTRY_COMOROS" "COUNTRY_CONGO" "COUNTRY_COOK_ISLANDS" "COUNTRY_CUBA" "COUNTRY_CURACAO" "COUNTRY_DEMOCRATIC_REPUBLIC_OF_THE_CONGO" "COUNTRY_DJIBOUTI" "COUNTRY_DOMINICA" "COUNTRY_EAST_TIMOR" "COUNTRY_EQUATORIAL_GUINEA" "COUNTRY_ERITREA" "COUNTRY_ETHIOPIA" "COUNTRY_FALKLAND_ISLANDS" "COUNTRY_FAROE_ISLANDS" "COUNTRY_FEDERATED_STATES_OF_MICRONESIA" "COUNTRY_FIJI" "COUNTRY_FRENCH_GUIANA" "COUNTRY_FRENCH_POLYNESIA" "COUNTRY_FRENCH_SOUTHERN_TERRITORIES" "COUNTRY_GABON" "COUNTRY_GAMBIA" "COUNTRY_GIBRALTAR" "COUNTRY_GREENLAND" "COUNTRY_GRENADA" "COUNTRY_GUADELOUPE" "COUNTRY_GUAM" "COUNTRY_GUINEA" "COUNTRY_GUINEA_BISSAU" "COUNTRY_GUYANA" "COUNTRY_HEARD_ISLAND_AND_MCDONALD_ISLANDS" "COUNTRY_IRAN" "COUNTRY_IRAQ" "COUNTRY_ISLE_OF_MAN" "COUNTRY_IVORY_COAST" "COUNTRY_JAMAICA" "COUNTRY_KIRIBATI" "COUNTRY_KYRGYZSTAN" "COUNTRY_LAOS" "COUNTRY_LEBANON" "COUNTRY_LESOTHO" "COUNTRY_LIBERIA" "COUNTRY_LIBYA" "COUNTRY_LIECHTENSTEIN" "COUNTRY_MACAU" "COUNTRY_MADAGASCAR" "COUNTRY_MALAWI" "COUNTRY_MALI" "COUNTRY_MARSHALL_ISLANDS" "COUNTRY_MARTINIQUE" "COUNTRY_MAURITANIA" "COUNTRY_MAYOTTE" "COUNTRY_MOLDOVA" "COUNTRY_MONACO" "COUNTRY_MONGOLIA" "COUNTRY_MONTSERRAT" "COUNTRY_MOZAMBIQUE" "COUNTRY_MYANMAR" "COUNTRY_NAMIBIA" "COUNTRY_NAURU" "COUNTRY_NEPAL" "COUNTRY_NEW_CALEDONIA" "COUNTRY_NIGER" "COUNTRY_NIUE" "COUNTRY_NORFOLK_ISLAND" "COUNTRY_NORTHERN_CYPRUS" "COUNTRY_NORTHERN_MARIANA_ISLANDS" "COUNTRY_NORTH_KOREA" "COUNTRY_NORTH_MACEDONIA" "COUNTRY_PALAU" "COUNTRY_PALESTINE" "COUNTRY_PAPUA_NEW_GUINEA" "COUNTRY_PITCAIRN" "COUNTRY_REUNION" "COUNTRY_RWANDA" "COUNTRY_SAINT_BARTHELEMY" "COUNTRY_SAINT_HELENA_ASCENSION_AND_TRISTIAN_DA_CUNHA" "COUNTRY_SAINT_KITTS_AND_NEVIS" "COUNTRY_SAINT_LUCIA" "COUNTRY_SAINT_MARTIN" "COUNTRY_SAINT_PIERRE_AND_MIQUELON" "COUNTRY_SAINT_VINCENT_AND_THE_GRENADINES" "COUNTRY_SAMOA" "COUNTRY_SAN_MARINO" "COUNTRY_SAO_TOME_AND_PRINCIPE" "COUNTRY_SENEGAL" "COUNTRY_SEYCHELLES" "COUNTRY_SIERRA_LEONE" "COUNTRY_SINT_MAARTEN" "COUNTRY_SOLOMON_ISLANDS" "COUNTRY_SOMALIA" "COUNTRY_SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS" "COUNTRY_SOUTH_SUDAN" "COUNTRY_SUDAN" "COUNTRY_SURINAME" "COUNTRY_SVALBARD_AND_JAN_MAYEN" "COUNTRY_ESWATINI" "COUNTRY_SYRIA" "COUNTRY_TAJIKISTAN" "COUNTRY_TANZANIA" "COUNTRY_TOGO" "COUNTRY_TOKELAU" "COUNTRY_TONGA" "COUNTRY_TRINIDAD_AND_TOBAGO" "COUNTRY_TURKMENISTAN" "COUNTRY_TURKS_AND_CAICOS_ISLANDS" "COUNTRY_TUVALU" "COUNTRY_UNITED_STATES_MINOR_OUTLYING_ISLANDS" "COUNTRY_UZBEKISTAN" "COUNTRY_VANUATU" "COUNTRY_VATICAN_CITY" "COUNTRY_VIRGIN_ISLANDS_BRITISH" "COUNTRY_VIRGIN_ISLANDS_US" "COUNTRY_WALLIS_AND_FUTUNA" "COUNTRY_WESTERN_SAHARA" "COUNTRY_YEMEN" "COUNTRY_YUGOSLAVIA" "COUNTRY_ZAMBIA" "COUNTRY_ZIMBABWE" "COUNTRY_SCHENGEN_AREA"

Document country.

region
string or null (Region)
Enum: "REGION_NONE" "REGION_ALABAMA" "REGION_ALASKA" "REGION_ALBERTA" "REGION_ARIZONA" "REGION_ARKANSAS" "REGION_AUSTRALIAN_CAPITAL_TERRITORY" "REGION_BRITISH_COLUMBIA" "REGION_CALIFORNIA" "REGION_COLORADO" "REGION_CONNECTICUT" "REGION_DELAWARE" "REGION_DISTRICT_OF_COLUMBIA" "REGION_FLORIDA" "REGION_GEORGIA" "REGION_HAWAII" "REGION_IDAHO" "REGION_ILLINOIS" "REGION_INDIANA" "REGION_IOWA" "REGION_KANSAS" "REGION_KENTUCKY" "REGION_LOUISIANA" "REGION_MAINE" "REGION_MANITOBA" "REGION_MARYLAND" "REGION_MASSACHUSETTS" "REGION_MICHIGAN" "REGION_MINNESOTA" "REGION_MISSISSIPPI" "REGION_MISSOURI" "REGION_MONTANA" "REGION_NEBRASKA" "REGION_NEVADA" "REGION_NEW_BRUNSWICK" "REGION_NEW_HAMPSHIRE" "REGION_NEW_JERSEY" "REGION_NEW_MEXICO" "REGION_NEW_SOUTH_WALES" "REGION_NEW_YORK" "REGION_NORTHERN_TERRITORY" "REGION_NORTH_CAROLINA" "REGION_NORTH_DAKOTA" "REGION_NOVA_SCOTIA" "REGION_OHIO" "REGION_OKLAHOMA" "REGION_ONTARIO" "REGION_OREGON" "REGION_PENNSYLVANIA" "REGION_QUEBEC" "REGION_QUEENSLAND" "REGION_RHODE_ISLAND" "REGION_SASKATCHEWAN" "REGION_SOUTH_AUSTRALIA" "REGION_SOUTH_CAROLINA" "REGION_SOUTH_DAKOTA" "REGION_TASMANIA" "REGION_TENNESSEE" "REGION_TEXAS" "REGION_UTAH" "REGION_VERMONT" "REGION_VICTORIA" "REGION_VIRGINIA" "REGION_WASHINGTON" "REGION_WESTERN_AUSTRALIA" "REGION_WEST_VIRGINIA" "REGION_WISCONSIN" "REGION_WYOMING" "REGION_YUKON" "REGION_CIUDAD_DE_MEXICO" "REGION_JALISCO" "REGION_NEWFOUNDLAND_AND_LABRADOR" "REGION_NUEVO_LEON" "REGION_BAJA_CALIFORNIA" "REGION_CHIHUAHUA" "REGION_GUANAJUATO" "REGION_GUERRERO" "REGION_MEXICO" "REGION_MICHOACAN" "REGION_NEW_YORK_CITY" "REGION_TAMAULIPAS" "REGION_VERACRUZ" "REGION_CHIAPAS" "REGION_COAHUILA" "REGION_DURANGO" "REGION_GUERRERO_COCULA" "REGION_GUERRERO_JUCHITAN" "REGION_GUERRERO_TEPECOACUILCO" "REGION_GUERRERO_TLACOAPA" "REGION_GUJARAT" "REGION_HIDALGO" "REGION_KARNATAKA" "REGION_KERALA" "REGION_KHYBER_PAKHTUNKHWA" "REGION_MADHYA_PRADESH" "REGION_MAHARASHTRA" "REGION_MORELOS" "REGION_NAYARIT" "REGION_OAXACA" "REGION_PUEBLA" "REGION_PUNJAB" "REGION_QUERETARO" "REGION_SAN_LUIS_POTOSI" "REGION_SINALOA" "REGION_SONORA" "REGION_TABASCO" "REGION_TAMIL_NADU" "REGION_YUCATAN" "REGION_ZACATECAS" "REGION_AGUASCALIENTES" "REGION_BAJA_CALIFORNIA_SUR" "REGION_CAMPECHE" "REGION_COLIMA" "REGION_QUINTANA_ROO_BENITO_JUAREZ" "REGION_QUINTANA_ROO" "REGION_QUINTANA_ROO_SOLIDARIDAD" "REGION_TLAXCALA" "REGION_QUINTANA_ROO_COZUMEL" "REGION_SAO_PAOLO" "REGION_RIO_DE_JANEIRO" "REGION_RIO_GRANDE_DO_SUL" "REGION_NORTHWEST_TERRITORIES" "REGION_NUNAVUT" "REGION_PRINCE_EDWARD_ISLAND" "REGION_DISTRITO_FEDERAL" "REGION_MARANHAO" "REGION_MATO_GROSSO" "REGION_MINAS_GERAIS" "REGION_PARA" "REGION_PARANA" "REGION_PERNAMBUCO" "REGION_SANTA_CATARINA" "REGION_ANDHRA_PRADESH" "REGION_CEARA" "REGION_GOIAS" "REGION_GUERRERO_ACAPULCO_DE_JUAREZ" "REGION_HARYANA" "REGION_SERGIPE" "REGION_ALAGOAS" "REGION_BANGSAMORO" "REGION_TELANGANA"

Document region.

type
string or null (Type)
Enum: "TYPE_NONE" "TYPE_CONSULAR_ID" "TYPE_DL" "TYPE_DL_PUBLIC_SERVICES_CARD" "TYPE_EMPLOYMENT_PASS" "TYPE_FIN_CARD" "TYPE_ID" "TYPE_MULTIPURPOSE_ID" "TYPE_MyKad" "TYPE_MyKid" "TYPE_MyPR" "TYPE_MyTentera" "TYPE_PAN_CARD" "TYPE_PROFESSIONAL_ID" "TYPE_PUBLIC_SERVICES_CARD" "TYPE_RESIDENCE_PERMIT" "TYPE_RESIDENT_ID" "TYPE_TEMPORARY_RESIDENCE_PERMIT" "TYPE_VOTER_ID" "TYPE_WORK_PERMIT" "TYPE_iKAD" "TYPE_MILITARY_ID" "TYPE_MyKAS" "TYPE_SOCIAL_SECURITY_CARD" "TYPE_HEALTH_INSURANCE_CARD" "TYPE_PASSPORT" "TYPE_S_PASS" "TYPE_ADDRESS_CARD" "TYPE_ALIEN_ID" "TYPE_ALIEN_PASSPORT" "TYPE_GREEN_CARD" "TYPE_MINORS_ID" "TYPE_POSTAL_ID" "TYPE_PROFESSIONAL_DL" "TYPE_TAX_ID" "TYPE_WEAPON_PERMIT" "TYPE_VISA" "TYPE_BORDER_CROSSING_CARD" "TYPE_DRIVER_CARD" "TYPE_GLOBAL_ENTRY_CARD" "TYPE_MyPolis" "TYPE_NEXUS_CARD" "TYPE_PASSPORT_CARD" "TYPE_PROOF_OF_AGE_CARD" "TYPE_REFUGEE_ID" "TYPE_TRIBAL_ID" "TYPE_VETERAN_ID" "TYPE_CITIZENSHIP_CERTIFICATE" "TYPE_MY_NUMBER_CARD" "TYPE_CONSULAR_PASSPORT" "TYPE_MINORS_PASSPORT" "TYPE_MINORS_PUBLIC_SERVICES_CARD" "TYPE_DRIVING_PRIVILEGE_CARD" "TYPE_ASYLUM_REQUEST" "TYPE_DRIVER_QUALIFICATION_CARD" "TYPE_PROVISIONAL_DL" "TYPE_REFUGEE_PASSPORT" "TYPE_SPECIAL_ID" "TYPE_UNIFORMED_SERVICES_ID" "TYPE_IMMIGRANT_VISA" "TYPE_CONSULAR_VOTER_ID" "TYPE_TWIC_CARD" "TYPE_EXIT_ENTRY_PERMIT" "TYPE_MAINLAND_TRAVEL_PERMIT_TAIWAN" "TYPE_NBI_CLEARANCE" "TYPE_PROOF_OF_REGISTRATION" "TYPE_TEMPORARY_PROTECTION_PERMIT" "TYPE_AFGHAN_CITIZEN_CARD" "TYPE_EID" "TYPE_PASS" "TYPE_SIS_ID" "TYPE_ASIC_CARD" "TYPE_BIDOON_CARD" "TYPE_INTERIM_HEALTH_INSURANCE_CARD" "TYPE_NON_VOTER_ID" "TYPE_RECIPROCAL_HEALTH_INSURANCE_CARD" "TYPE_VEHICLE_REGISTRATION" "TYPE_ESAAD_CARD" "TYPE_REGISTRATION_CERTIFICATE" "TYPE_MEDICAL_MARIJUANA_ID" "TYPE_NON_CARD_TRIBAL_ID" "TYPE_DIPLOMATIC_ID" "TYPE_EMERGENCY_PASSPORT" "TYPE_TEMPORARY_PASSPORT" "TYPE_METIS_FEDERATION_CARD" "TYPE_ADR_CERTIFICATE"

Document type.

{
  • "country": "COUNTRY_NONE",
  • "region": "REGION_NONE",
  • "type": "TYPE_NONE"
}

Document image color status

string (Document image color status)
Enum: "NOT_AVAILABLE" "BLACK_AND_WHITE" "COLOR"

The color status determined from scanned image.

"NOT_AVAILABLE"

DocumentLivenessCheck

object or null
object or null
{
  • "front": {
    },
  • "back": {
    }
}

DocumentLivenessSingleSideCheckResult

object or null
object or null
handPresenceCheck
string or null
Enum: "NOT_PERFORMED" "PASS" "FAIL"
{
  • "screenCheck": {
    },
  • "photocopyCheck": {
    },
  • "handPresenceCheck": "NOT_PERFORMED"
}

DocumentNumberAnonymizationSettings

prefixDigitsVisible
integer or null <int32>

Defines how many digits at the beginning of the document number remain visible after anonymization.

suffixDigitsVisible
integer or null <int32>

Defines how many digits at the end of the document number remain visible after anonymization.

{
  • "prefixDigitsVisible": 0,
  • "suffixDigitsVisible": 0
}

Card orientation

string (Card orientation)
Enum: "HORIZONTAL" "VERTICAL" "NOT_AVAILABLE"

Orientation determined from the scanned image.

"HORIZONTAL"

Card rotation

string (Card rotation)
Enum: "NOT_AVAILABLE" "ZERO" "CLOCKWISE_90" "COUNTER_CLOCKWISE_90" "UPSIDE_DOWN"

Rotation determined from the scanned image.

"NOT_AVAILABLE"

DocumentRules

object or null

Specified fields will be anonymized if filter conditions are met.

Array of objects or null (DetailedFieldType)

Fields to overrule our class field rules.

{
  • "documentFilter": {
    },
  • "fields": [
    ]
}

DriverLicenseDetailedInfo

object or null

The restrictions to driving privileges for the United States driver license owner.

object or null

The additional privileges granted to the United States driver license owner.

object or null

The type of vehicle the driver license owner has privilege to drive.

object or null

The driver license conditions.

Array of objects or null (VehicleClassInfo)

The additional information on vehicle class.

{
  • "restrictions": {
    },
  • "endorsements": {
    },
  • "vehicleClass": {
    },
  • "conditions": {
    },
  • "vehicleClassesInfo": [
    ]
}

FieldType

string (FieldType)
Enum: "ADDITIONAL_ADDRESS_INFORMATION" "ADDITIONAL_NAME_INFORMATION" "ADDITIONAL_OPTIONAL_ADDRESS_INFORMATION" "ADDITIONAL_PERSONAL_ID_NUMBER" "ADDRESS" "CLASS_EFFECTIVE_DATE" "CLASS_EXPIRY_DATE" "CONDITIONS" "DATE_OF_BIRTH" "DATE_OF_EXPIRY" "DATE_OF_ISSUE" "DOCUMENT_ADDITIONAL_NUMBER" "DOCUMENT_OPTIONAL_ADDITIONAL_NUMBER" "DOCUMENT_NUMBER" "EMPLOYER" "ENDORSEMENTS" "FATHERS_NAME" "FIRST_NAME" "FULL_NAME" "ISSUING_AUTHORITY" "LAST_NAME" "LICENCE_TYPE" "LOCALIZED_NAME" "MARITAL_STATUS" "MOTHERS_NAME" "MRZ" "NATIONALITY" "PERSONAL_ID_NUMBER" "PLACE_OF_BIRTH" "PROFESSION" "RACE" "RELIGION" "RESIDENTIAL_STATUS" "RESTRICTIONS" "SEX" "VEHICLE_CLASS" "BLOOD_TYPE" "SPONSOR" "VISA_TYPE" "NUMBER_OF_ENTRIES" "DURATION_OF_STAY" "DOCUMENT_SUBTYPE" "REMARKS" "RESIDENCE_PERMIT_TYPE" "MANUFACTURING_YEAR" "VEHICLE_TYPE" "DEPENDENT_DATE_OF_BIRTH" "DEPENDENT_SEX" "DEPENDENT_DOCUMENT_NUMBER" "DEPENDENT_FULL_NAME" "ELIGIBILITY_CATEGORY" "SPECIFIC_DOCUMENT_VALIDITY" "VEHICLE_OWNER" "NATIONAL_INSURANCE_NUMBER" "COUNTRY_CODE" "CERTIFICATE_NUMBER" "MUNICIPALITY_OF_REGISTRATION" "LOCALITY_CODE" "MAIDEN_NAME" "STATE_CODE" "DATE_OF_ENTRY" "MUNICIPALITY_CODE" "POLLING_STATION_CODE" "SECTION_CODE" "REGISTRATION_CENTER_CODE" "STATE_NAME"
"ADDITIONAL_ADDRESS_INFORMATION"

HealthCheckType

string (HealthCheckType)
Enum: "LIVENESS" "READINESS"
"LIVENESS"

HealthResult

name
string
object (HealthStatus)
details
any
{
  • "name": "string",
  • "status": {
    },
  • "details": null
}

HealthStatus

name
required
string
description
required
string or null
operational
required
boolean or null
severity
required
integer or null <int32>
{
  • "name": "string",
  • "description": "string",
  • "operational": true,
  • "severity": 0
}

Image analysis detection status

string (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

"NOT_AVAILABLE"

Image analysis lighting status

string (Image analysis lighting status)
Enum: "NOT_AVAILABLE" "TOO_BRIGHT" "TOO_DARK" "NORMAL"

Lighting status determined from the scanned image.

"NOT_AVAILABLE"

ImageAnalysisResult

blurDetectionStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

glareDetectionStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

documentImageColorStatus
string or null (Document image color status)
Enum: "NOT_AVAILABLE" "BLACK_AND_WHITE" "COLOR"

The color status determined from scanned image.

documentImageMoireStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

faceDetectionStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

mrzDetectionStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

barcodeDetectionStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

documentOrientation
string or null (Card orientation)
Enum: "HORIZONTAL" "VERTICAL" "NOT_AVAILABLE"

Orientation determined from the scanned image.

documentRotation
string or null (Card rotation)
Enum: "NOT_AVAILABLE" "ZERO" "CLOCKWISE_90" "COUNTER_CLOCKWISE_90" "UPSIDE_DOWN"

Rotation determined from the scanned image.

realIDDetectionStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

documentHandOcclusionStatus
string or null (Image analysis detection status)
Enum: "NOT_AVAILABLE" "NOT_DETECTED" "DETECTED"

Detection status determined from the scanned image.

documentLightingStatus
string or null (Image analysis lighting status)
Enum: "NOT_AVAILABLE" "TOO_BRIGHT" "TOO_DARK" "NORMAL"

Lighting status determined from the scanned image.

{
  • "blurDetectionStatus": "NOT_AVAILABLE",
  • "glareDetectionStatus": "NOT_AVAILABLE",
  • "documentImageColorStatus": "NOT_AVAILABLE",
  • "documentImageMoireStatus": "NOT_AVAILABLE",
  • "faceDetectionStatus": "NOT_AVAILABLE",
  • "mrzDetectionStatus": "NOT_AVAILABLE",
  • "barcodeDetectionStatus": "NOT_AVAILABLE",
  • "documentOrientation": "HORIZONTAL",
  • "documentRotation": "NOT_AVAILABLE",
  • "realIDDetectionStatus": "NOT_AVAILABLE",
  • "documentHandOcclusionStatus": "NOT_AVAILABLE",
  • "documentLightingStatus": "NOT_AVAILABLE"
}

ImageExtractionType

string (ImageExtractionType)
Enum: "FULL_DOCUMENT" "FACE" "SIGNATURE"
"FULL_DOCUMENT"

Image Format

string (Image Format)
Enum: "JPG" "PNG" "QOI"
"JPG"

ImageSource

imageUrl
string or null

Url string of the image.

imageBase64
string or null

Base64 string of the image.

{
  • "imageUrl": "string",
  • "imageBase64": "string"
}

LocationInfo

object or null
object or null
side
string or null (Scanning side)
Enum: "FIRST" "SECOND"

Represents the sides of the document that can be scanned.

{
  • "topLeftCorner": {
    },
  • "dimensions": {
    },
  • "side": "FIRST"
}

MatchLevel

string (MatchLevel)
Enum: "DISABLED" "LEVEL1" "LEVEL2" "LEVEL3" "LEVEL4" "LEVEL5" "LEVEL6" "LEVEL7" "LEVEL8" "LEVEL9" "LEVEL10"
"DISABLED"

MicroblinkEndpointRequest

object (MicroblinkEndpointRequest)
{ }

Mrtd document type

string (Mrtd document type)
Enum: "UNKNOWN" "IDENTITY_CARD" "PASSPORT" "VISA" "GREEN_CARD" "MALAYSIAN_PASS_IMM13P" "DRIVER_LICENSE" "INTERNATIONAL_TRAVEL_DOCUMENT" "BORDER_CROSSING_CARD"

Possible types of Machine Readable Travel Documents (MRTDs).

"UNKNOWN"

MrzResult

rawMrzString
string or null

The entire Machine Readable Zone text from ID. This string is usually used for parsing other elements. NOTE: This string is available only if OCR result was parsed successfully.

documentCode
string or null

The document code. Document code contains two characters. For MRTD the first character shall be A, C or I. The second character shall be discretion of the issuing State or organization except that V shall not be used, and C shall not be used after A except in the crew member certificate. On machine-readable passports (MRP) first character shall be P to designate an MRP. One additional letter may be used, at the discretion of the issuing State or organization, to designate a particular MRP. If the second character position is not used for this purpose, it shall be filled by the filter character <.

issuer
string or null

Three-letter or two-letter code which indicate the issuing State. Three-letter codes are based on Aplha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.

documentNumber
string or null

The document number. Document number contains up to 9 characters. Element does not exist on US Green Card. To see which document was scanned use documentType property.

opt1
string or null

The first optional data. Contains empty string if not available. Element does not exist on US Green Card. To see which document was scanned use the documentType property.

opt2
string or null

The second optional data. Contains empty string if not available. Element does not exist on Passports and Visas. To see which document was scanned use the documentType property.

gender
string or null

The gender of the card holder. Gender is specified by use of the single initial, capital letter F for female, M for male or < for unspecified.

nationality
string or null

The nationality of the holder represented by a three-letter or two-letter code. Three-letter codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.

primaryId
string or null

The primary indentifier. If there is more than one component, they are separated with space.

secondaryId
string or null

The secondary identifier. If there is more than one component, they are separated with space.

verified
boolean or null

True if all check digits inside MRZ are correct, false otherwise.

object or null
object or null
documentType
string or null (Mrtd document type)
Enum: "UNKNOWN" "IDENTITY_CARD" "PASSPORT" "VISA" "GREEN_CARD" "MALAYSIAN_PASS_IMM13P" "DRIVER_LICENSE" "INTERNATIONAL_TRAVEL_DOCUMENT" "BORDER_CROSSING_CARD"

Possible types of Machine Readable Travel Documents (MRTDs).

issuerName
string or null

Returns full issuer name that is expanded from the three-letter or two-letter code which indicate the issuing State.

nationalityName
string or null

Returns full nationality of the holder, which is expanded from the three-letter or two-letter nationality code.

{
  • "rawMrzString": "string",
  • "documentCode": "string",
  • "issuer": "string",
  • "documentNumber": "string",
  • "opt1": "string",
  • "opt2": "string",
  • "gender": "string",
  • "nationality": "string",
  • "primaryId": "string",
  • "secondaryId": "string",
  • "verified": true,
  • "dateOfBirth": {
    },
  • "dateOfExpiry": {
    },
  • "documentType": "UNKNOWN",
  • "issuerName": "string",
  • "nationalityName": "string"
}

Point2df

x
number or null <float>
y
number or null <float>
{
  • "x": 0.1,
  • "y": 0.1
}

Points

x
integer or null <int32>

X coordinate of a point.

y
integer or null <int32>

Y coordinate of a point.

{
  • "x": 0,
  • "y": 0
}

Processing status

string (Processing status)
Enum: "SUCCESS" "DETECTION_FAILED" "IMAGE_PREPROCESSING_FAILED" "STABILITY_TEST_FAILED" "SCANNING_WRONG_SIDE" "FIELD_IDENTIFICATION_FAILED" "MANDATORY_FIELD_MISSING" "INVALID_CHARACTERS_FOUND" "IMAGE_RETURN_FAILED" "BARCODE_RECOGNITION_FAILED" "MRZ_PARSING_FAILED" "DOCUMENT_FILTERED" "UNSUPPORTED_DOCUMENT" "AWAITING_OTHER_SIDE" "NOT_SCANNED" "BARCODE_DETECTION_FAILED"

Detailed information about the recognition process.

"SUCCESS"

Recognition mode

string (Recognition mode)
Enum: "NONE" "MRZ_ID" "MRZ_VISA" "MRZ_PASSPORT" "PHOTO_ID" "FULL_RECOGNITION" "BARCODE_ID"

Recognition mode used to scan current document.

"NONE"

RectangleF

object or null
object or null
{
  • "topLeftCorner": {
    },
  • "dimensions": {
    }
}

Region

string (Region)
Enum: "REGION_NONE" "REGION_ALABAMA" "REGION_ALASKA" "REGION_ALBERTA" "REGION_ARIZONA" "REGION_ARKANSAS" "REGION_AUSTRALIAN_CAPITAL_TERRITORY" "REGION_BRITISH_COLUMBIA" "REGION_CALIFORNIA" "REGION_COLORADO" "REGION_CONNECTICUT" "REGION_DELAWARE" "REGION_DISTRICT_OF_COLUMBIA" "REGION_FLORIDA" "REGION_GEORGIA" "REGION_HAWAII" "REGION_IDAHO" "REGION_ILLINOIS" "REGION_INDIANA" "REGION_IOWA" "REGION_KANSAS" "REGION_KENTUCKY" "REGION_LOUISIANA" "REGION_MAINE" "REGION_MANITOBA" "REGION_MARYLAND" "REGION_MASSACHUSETTS" "REGION_MICHIGAN" "REGION_MINNESOTA" "REGION_MISSISSIPPI" "REGION_MISSOURI" "REGION_MONTANA" "REGION_NEBRASKA" "REGION_NEVADA" "REGION_NEW_BRUNSWICK" "REGION_NEW_HAMPSHIRE" "REGION_NEW_JERSEY" "REGION_NEW_MEXICO" "REGION_NEW_SOUTH_WALES" "REGION_NEW_YORK" "REGION_NORTHERN_TERRITORY" "REGION_NORTH_CAROLINA" "REGION_NORTH_DAKOTA" "REGION_NOVA_SCOTIA" "REGION_OHIO" "REGION_OKLAHOMA" "REGION_ONTARIO" "REGION_OREGON" "REGION_PENNSYLVANIA" "REGION_QUEBEC" "REGION_QUEENSLAND" "REGION_RHODE_ISLAND" "REGION_SASKATCHEWAN" "REGION_SOUTH_AUSTRALIA" "REGION_SOUTH_CAROLINA" "REGION_SOUTH_DAKOTA" "REGION_TASMANIA" "REGION_TENNESSEE" "REGION_TEXAS" "REGION_UTAH" "REGION_VERMONT" "REGION_VICTORIA" "REGION_VIRGINIA" "REGION_WASHINGTON" "REGION_WESTERN_AUSTRALIA" "REGION_WEST_VIRGINIA" "REGION_WISCONSIN" "REGION_WYOMING" "REGION_YUKON" "REGION_CIUDAD_DE_MEXICO" "REGION_JALISCO" "REGION_NEWFOUNDLAND_AND_LABRADOR" "REGION_NUEVO_LEON" "REGION_BAJA_CALIFORNIA" "REGION_CHIHUAHUA" "REGION_GUANAJUATO" "REGION_GUERRERO" "REGION_MEXICO" "REGION_MICHOACAN" "REGION_NEW_YORK_CITY" "REGION_TAMAULIPAS" "REGION_VERACRUZ" "REGION_CHIAPAS" "REGION_COAHUILA" "REGION_DURANGO" "REGION_GUERRERO_COCULA" "REGION_GUERRERO_JUCHITAN" "REGION_GUERRERO_TEPECOACUILCO" "REGION_GUERRERO_TLACOAPA" "REGION_GUJARAT" "REGION_HIDALGO" "REGION_KARNATAKA" "REGION_KERALA" "REGION_KHYBER_PAKHTUNKHWA" "REGION_MADHYA_PRADESH" "REGION_MAHARASHTRA" "REGION_MORELOS" "REGION_NAYARIT" "REGION_OAXACA" "REGION_PUEBLA" "REGION_PUNJAB" "REGION_QUERETARO" "REGION_SAN_LUIS_POTOSI" "REGION_SINALOA" "REGION_SONORA" "REGION_TABASCO" "REGION_TAMIL_NADU" "REGION_YUCATAN" "REGION_ZACATECAS" "REGION_AGUASCALIENTES" "REGION_BAJA_CALIFORNIA_SUR" "REGION_CAMPECHE" "REGION_COLIMA" "REGION_QUINTANA_ROO_BENITO_JUAREZ" "REGION_QUINTANA_ROO" "REGION_QUINTANA_ROO_SOLIDARIDAD" "REGION_TLAXCALA" "REGION_QUINTANA_ROO_COZUMEL" "REGION_SAO_PAOLO" "REGION_RIO_DE_JANEIRO" "REGION_RIO_GRANDE_DO_SUL" "REGION_NORTHWEST_TERRITORIES" "REGION_NUNAVUT" "REGION_PRINCE_EDWARD_ISLAND" "REGION_DISTRITO_FEDERAL" "REGION_MARANHAO" "REGION_MATO_GROSSO" "REGION_MINAS_GERAIS" "REGION_PARA" "REGION_PARANA" "REGION_PERNAMBUCO" "REGION_SANTA_CATARINA" "REGION_ANDHRA_PRADESH" "REGION_CEARA" "REGION_GOIAS" "REGION_GUERRERO_ACAPULCO_DE_JUAREZ" "REGION_HARYANA" "REGION_SERGIPE" "REGION_ALAGOAS" "REGION_BANGSAMORO" "REGION_TELANGANA"

Document region.

"REGION_NONE"

Result state

string (Result state)
Enum: "EMPTY" "UNCERTAIN" "VALID" "STAGE_VALID"

Possible states of the Recognizer's result.

"EMPTY"

Scanning side

string (Scanning side)
Enum: "FIRST" "SECOND"

Represents the sides of the document that can be scanned.

"FIRST"

StringResult

latin
string or null

The result of recognition in latin.

object or null

The location latin recognition.

cyrillic
string or null

The result of recognition in cyrillic.

object or null

The location cyrillic recognition.

arabic
string or null

The result of recognition in arabic.

object or null

The location arabic recognition.

greek
string or null

The result of recognition in greek.

object or null

The location greek recognition.

{
  • "latin": "string",
  • "latinLocation": {
    },
  • "cyrillic": "string",
  • "cyrillicLocation": {
    },
  • "arabic": "string",
  • "arabicLocation": {
    },
  • "greek": "string",
  • "greekLocation": {
    }
}

TieredCheck

result
string or null
Enum: "NOT_PERFORMED" "PASS" "FAIL"
matchLevel
string or null
Enum: "DISABLED" "LEVEL1" "LEVEL2" "LEVEL3" "LEVEL4" "LEVEL5" "LEVEL6" "LEVEL7" "LEVEL8" "LEVEL9" "LEVEL10"
{
  • "result": "NOT_PERFORMED",
  • "matchLevel": "DISABLED"
}

Type

string (Type)
Enum: "TYPE_NONE" "TYPE_CONSULAR_ID" "TYPE_DL" "TYPE_DL_PUBLIC_SERVICES_CARD" "TYPE_EMPLOYMENT_PASS" "TYPE_FIN_CARD" "TYPE_ID" "TYPE_MULTIPURPOSE_ID" "TYPE_MyKad" "TYPE_MyKid" "TYPE_MyPR" "TYPE_MyTentera" "TYPE_PAN_CARD" "TYPE_PROFESSIONAL_ID" "TYPE_PUBLIC_SERVICES_CARD" "TYPE_RESIDENCE_PERMIT" "TYPE_RESIDENT_ID" "TYPE_TEMPORARY_RESIDENCE_PERMIT" "TYPE_VOTER_ID" "TYPE_WORK_PERMIT" "TYPE_iKAD" "TYPE_MILITARY_ID" "TYPE_MyKAS" "TYPE_SOCIAL_SECURITY_CARD" "TYPE_HEALTH_INSURANCE_CARD" "TYPE_PASSPORT" "TYPE_S_PASS" "TYPE_ADDRESS_CARD" "TYPE_ALIEN_ID" "TYPE_ALIEN_PASSPORT" "TYPE_GREEN_CARD" "TYPE_MINORS_ID" "TYPE_POSTAL_ID" "TYPE_PROFESSIONAL_DL" "TYPE_TAX_ID" "TYPE_WEAPON_PERMIT" "TYPE_VISA" "TYPE_BORDER_CROSSING_CARD" "TYPE_DRIVER_CARD" "TYPE_GLOBAL_ENTRY_CARD" "TYPE_MyPolis" "TYPE_NEXUS_CARD" "TYPE_PASSPORT_CARD" "TYPE_PROOF_OF_AGE_CARD" "TYPE_REFUGEE_ID" "TYPE_TRIBAL_ID" "TYPE_VETERAN_ID" "TYPE_CITIZENSHIP_CERTIFICATE" "TYPE_MY_NUMBER_CARD" "TYPE_CONSULAR_PASSPORT" "TYPE_MINORS_PASSPORT" "TYPE_MINORS_PUBLIC_SERVICES_CARD" "TYPE_DRIVING_PRIVILEGE_CARD" "TYPE_ASYLUM_REQUEST" "TYPE_DRIVER_QUALIFICATION_CARD" "TYPE_PROVISIONAL_DL" "TYPE_REFUGEE_PASSPORT" "TYPE_SPECIAL_ID" "TYPE_UNIFORMED_SERVICES_ID" "TYPE_IMMIGRANT_VISA" "TYPE_CONSULAR_VOTER_ID" "TYPE_TWIC_CARD" "TYPE_EXIT_ENTRY_PERMIT" "TYPE_MAINLAND_TRAVEL_PERMIT_TAIWAN" "TYPE_NBI_CLEARANCE" "TYPE_PROOF_OF_REGISTRATION" "TYPE_TEMPORARY_PROTECTION_PERMIT" "TYPE_AFGHAN_CITIZEN_CARD" "TYPE_EID" "TYPE_PASS" "TYPE_SIS_ID" "TYPE_ASIC_CARD" "TYPE_BIDOON_CARD" "TYPE_INTERIM_HEALTH_INSURANCE_CARD" "TYPE_NON_VOTER_ID" "TYPE_RECIPROCAL_HEALTH_INSURANCE_CARD" "TYPE_VEHICLE_REGISTRATION" "TYPE_ESAAD_CARD" "TYPE_REGISTRATION_CERTIFICATE" "TYPE_MEDICAL_MARIJUANA_ID" "TYPE_NON_CARD_TRIBAL_ID" "TYPE_DIPLOMATIC_ID" "TYPE_EMERGENCY_PASSPORT" "TYPE_TEMPORARY_PASSPORT" "TYPE_METIS_FEDERATION_CARD" "TYPE_ADR_CERTIFICATE"

Document type.

"TYPE_NONE"

VIZResult

object or null

The first name of the document owner.

object or null

The last name of the document owner.

object or null

The full name of the document owner.

object or null

The transcription of the document subtype.

object or null

The remarks on the residence permit.

object or null

The residence permit type.

object or null

The manufacturing year.

object or null

The vehicle type.

object or null

The eligibility category.

object or null

The specific document validity.

Array of objects or null (DependentInfo)
object or null

The vehicle owner.

object or null

The vehicle owner.

object or null

The certificate number of the document owner.

object or null

The country code of the document owner.

object or null

The additional name information number of the document owner.

object or null

The localized name of the document.

object or null

The address of the document owner.

object or null

The additional address information of the document owner.

object or null

The one more additional address information of the document owner.

object or null

The place of birth of the document owner.

object or null

The nationality of the documet owner.

object or null

The race of the document owner.

object or null

The religion of the document owner.

object or null

The profession of the document owner.

object or null

The marital status of the document owner.

object or null

The residential stauts of the document owner.

object or null

The employer of the document owner.

object or null

The sex of the document owner.

object or null
object or null
object or null
dateOfExpiryPermanent
boolean or null

Determines if date of expiry is permanent.

object or null

The document number.

object or null

The personal identification number.

object or null

The additional number of the document.

object or null

The additional personal identification number.

object or null

The one more additional number of the document.

object or null

The issuing authority of the document.

object or null

The fathers name of the document owner.

object or null

The mothers name of the document owner.

object or null

The date of entry.

object or null

The locality code.

object or null

The maiden name of the document owner.

object or null

The municipality code.

object or null

The municipality of registration.

object or null

The polling station code.

object or null

The registration center code.

object or null

The section code.

object or null

The state code.

object or null

The state name.

object or null

The driver license detailed info.

object or null

The blood type of the document owner.

object or null

The sponsor of the document owner.

object or null

Visa type of the document.

{
  • "firstName": {
    },
  • "lastName": {
    },
  • "fullName": {
    },
  • "documentSubtype": {
    },
  • "remarks": {
    },
  • "residencePermitType": {
    },
  • "manufacturingYear": {
    },
  • "vehicleType": {
    },
  • "eligibilityCategory": {
    },
  • "specificDocumentValidity": {
    },
  • "dependentsInfo": [
    ],
  • "vehicleOwner": {
    },
  • "certificateNumber": {
    },
  • "countryCode": {
    },
  • "nationalInsuranceNumber": {
    },
  • "additionalNameInformation": {
    },
  • "localizedName": {
    },
  • "address": {
    },
  • "additionalAddressInformation": {
    },
  • "additionalOptionalAddressInformation": {
    },
  • "placeOfBirth": {
    },
  • "nationality": {
    },
  • "race": {
    },
  • "religion": {
    },
  • "profession": {
    },
  • "maritalStatus": {
    },
  • "residentialStatus": {
    },
  • "employer": {
    },
  • "sex": {
    },
  • "dateOfBirth": {
    },
  • "dateOfIssue": {
    },
  • "dateOfExpiry": {
    },
  • "dateOfExpiryPermanent": true,
  • "documentNumber": {
    },
  • "personalIdNumber": {
    },
  • "documentAdditionalNumber": {
    },
  • "additionalPersonalIdNumber": {
    },
  • "documentOptionalAdditionalNumber": {
    },
  • "issuingAuthority": {
    },
  • "fathersName": {
    },
  • "mothersName": {
    },
  • "dateOfEntry": {
    },
  • "localityCode": {
    },
  • "maidenName": {
    },
  • "municipalityCode": {
    },
  • "municipalityOfRegistration": {
    },
  • "pollingStationCode": {
    },
  • "registrationCenterCode": {
    },
  • "sectionCode": {
    },
  • "stateCode": {
    },
  • "stateName": {
    },
  • "driverLicenseDetailedInfo": {
    },
  • "bloodType": {
    },
  • "sponsor": {
    },
  • "visaType": {
    }
}

VehicleClassInfo

object or null

The type of vehicle the driver license owner has privilege to drive.

object or null

The type of driver licence.

object or null

The date since licence is effective

object or null

The date of expiry of licence.

{
  • "vehicleClass": {
    },
  • "licenceType": {
    },
  • "effectiveDate": {
    },
  • "expiryDate": {
    }
}

healthProxy

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Recognition endpoints

Barcode

header Parameters
X-ClientCustomerId
string or null
mb-api-key
string or null
Request Body schema: application/json
required
autoScaleDetection
boolean or null
Default: true

Allow enabling the autodetection of image scale when scanning barcodes. If set to true, prior reading barcode, image scale will be corrected. This enabled correct reading of barcodes on high resolution images but slows down the recognition process. This setting is applied only for Code39 and Code128 barcode scanning. Default TRUE

nullQuietZoneAllowed
boolean or null
Default: false

Set this to true to scan barcodes which don't have quiet zone (white area) around it. Use only if necessary because it slows down the recognition process Default FALSE

readCode39AsExtendedData
boolean or null
Default: false

Enable reading code39 barcode contents as extended data. For more information about code39 extended data (a.k.a. full ASCII mode), see https://en.wikipedia.org/wiki/Code_39#Full_ASCII_Code_39 Default FALSE

scanCode128
boolean or null
Default: false

Set this to true to scan Code 128 1D barcodes. Default FALSE

scanCode39
boolean or null
Default: false

Set this to true to scan Code 39 1D barcodes. Default FALSE

scanEan13
boolean or null
Default: false

Set this to true to scan EAN 13 barcodes. Default FALSE

scanEan8
boolean or null
Default: false

Set this to true to scan EAN8 barcodes. Default FALSE

scanInverse
boolean or null
Default: false

Set this to true to allow scanning barcodes with inverted intensities. This options doubles the frame processing time. Default FALSE

scanItf
boolean or null
Default: false

Set this to true to scan ITF barcodes. Default FALSE

scanPdf417
boolean or null
Default: false

Set this to true to scan Pdf417 barcodes. Default FALSE

scanQrCode
boolean or null
Default: false

Set this to true to scan QR barcodes. Default FALSE

scanUncertain
boolean or null
Default: true

Set this to true to scan even barcode not compliant with standards. For example, malformed PDF417 barcodes which were incorrectly encoded. Use only if necessary because it slows down the recognition process. Default TRUE

scanUpca
boolean or null
Default: false

Set this to true to scan UPCA barcodes. Default FALSE

scanUpce
boolean or null
Default: false

Set this to true to scan UPCE barcodes. Default FALSE

slowerThoroughScan
boolean or null
Default: false

Set this to true to allow slower, but better image processing. Default FALSE

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

traceId
string or null

Responses

Request samples

Content type
application/json
{
  • "autoScaleDetection": true,
  • "nullQuietZoneAllowed": false,
  • "readCode39AsExtendedData": false,
  • "scanCode128": false,
  • "scanCode39": false,
  • "scanEan13": false,
  • "scanEan8": false,
  • "scanInverse": false,
  • "scanItf": false,
  • "scanPdf417": false,
  • "scanQrCode": false,
  • "scanUncertain": true,
  • "scanUpca": false,
  • "scanUpce": false,
  • "slowerThoroughScan": false,
  • "image": {
    },
  • "traceId": "string"
}

Response samples

Content type
application/json
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

Blink Card

Request Body schema: application/json
required
extractIban
boolean or null
Default: true

Should extract the payment card's IBAN. Default TRUE

extractExpiryDate
boolean or null
Default: true

Defines whether the expiry date should be extracted. Default TRUE

extractOwner
boolean or null
Default: true

Should extract the card owner information. Default TRUE

extractCvv
boolean or null
Default: true

Defines whether the cvv should be extracted. Default TRUE

returnFullDocumentImage
boolean or null
Default: false

Defines whether full document image should be extracted. Default FALSE

handScaleThreshold
number or null <float>
handDocumentOverlapThreshold
number or null <float>
screenAnalysisMatchLevel
string or null
Enum: "DISABLED" "LEVEL1" "LEVEL2" "LEVEL3" "LEVEL4" "LEVEL5" "LEVEL6" "LEVEL7" "LEVEL8" "LEVEL9" "LEVEL10"
photocopyAnalysisMatchLevel
string or null
Enum: "DISABLED" "LEVEL1" "LEVEL2" "LEVEL3" "LEVEL4" "LEVEL5" "LEVEL6" "LEVEL7" "LEVEL8" "LEVEL9" "LEVEL10"
object or null

Whether sensitive data should be redacted from the result.

imageFormat
string or null (Image Format)
Default: "PNG"
Enum: "JPG" "PNG" "QOI"

Defines return image type. Default PNG

skipFramesWithBlur
boolean or null
Default: true

Defines whether blurred frames filtering is allowed. Default TRUE

allowInvalidCardNumber
boolean or null
Default: false

Defines whether invalid card number is accepted. Default FALSE

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

object or null

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

traceId
string or null

Responses

Request samples

Content type
application/json
{
  • "extractIban": true,
  • "extractExpiryDate": true,
  • "extractOwner": true,
  • "extractCvv": true,
  • "returnFullDocumentImage": false,
  • "handScaleThreshold": 0.1,
  • "handDocumentOverlapThreshold": 0.1,
  • "screenAnalysisMatchLevel": "DISABLED",
  • "photocopyAnalysisMatchLevel": "DISABLED",
  • "anonymizationSettings": {
    },
  • "imageFormat": "PNG",
  • "skipFramesWithBlur": true,
  • "allowInvalidCardNumber": false,
  • "cardNumberSide": {
    },
  • "otherSide": {
    },
  • "traceId": "string"
}

Response samples

Content type
application/json
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

BlinkIdMultiSide

Scanning both sides of supported documents or MRZ on passports, visas and other documents.

header Parameters
X-ClientCustomerId
string or null
mb-api-key
string or null
Request Body schema: application/json
required
returnFullDocumentImage
boolean or null
Default: false

Defines whether full document image should be extracted. Default FALSE

returnFaceImage
boolean or null
Default: false

Defines whether face image should be extracted. Default FALSE

returnSignatureImage
boolean or null
Default: false

Defines whether signature image should be extracted. Default FALSE

skipImagesWithBlur
boolean or null
Default: true

Defines whether blurred frames filtering is allowed. Default TRUE

scanUnsupportedSecondSide
boolean or null
Default: false

Skip back side capture and processing step when back side of the document is not supported. Default FALSE

enableCharacterValidation
boolean or null
Default: true

Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE

enableBarcodeScanOnly
boolean or null
Default: false

This setting allows barcode recognition to proceed even if the initial extraction fails. If the barcode recognition is successful, the recognizer will still end in a valid state. This setting is applicable only to photo frames. For multi-side recognizers, it is permitted only for the back side. Default FALSE

anonymizationMode
string or null (Anonymization mode)
Default: "FULL_RESULT"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

Array of objects or null (DocumentAnonymizationSettings)
Array of objects or null (DocumentRules)
imageFormat
string or null (Image Format)
Default: "PNG"
Enum: "JPG" "PNG" "QOI"

Defines return image type. Default PNG

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

object or null

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

ageLimit
integer or null <int32>

Defines the age limit for age verification.

scanCroppedDocumentImage
boolean or null
Default: false

Configure the recognizer to only work on already cropped and dewarped images. Default FALSE

maxAllowedMismatchesPerField
integer or null <int32>
Default: 0

Configure the number of characters per field that are allowed to be inconsistent in data match. Default 0

allowUncertainFirstSideScan
boolean or null
Default: true

Proceed with scanning the back side even if the front side result is uncertain. Default TRUE

scanPassportDataPageOnly
boolean or null
Default: true

Scan only the data page (page containing MRZ) of the passport.If set to false, it will be required to scan the second page of certain passports. Default TRUE

skipImagesWithInadequateLightingConditions
boolean or null
Default: true

Indicates whether frames with inadequate lighting conditions should be rejected. A value of true means frames with poor lighting conditions will be excluded from further processing to prevent images with inadequate lighting from being used. Default TRUE

skipImagesOccludedByHand
boolean or null
Default: true

Indicates whether frames occluded by hand should be rejected. A value of true means frames occluded by hand will be excluded from further processing to prevent occluded images from being used. This setting is applicable only if scanCroppedDocumentImage is disabled. Default TRUE

traceId
string or null

Responses

Request samples

Content type
application/json
{
  • "returnFullDocumentImage": false,
  • "returnFaceImage": false,
  • "returnSignatureImage": false,
  • "skipImagesWithBlur": true,
  • "scanUnsupportedSecondSide": false,
  • "enableCharacterValidation": true,
  • "enableBarcodeScanOnly": false,
  • "anonymizationMode": "FULL_RESULT",
  • "customDocumentAnonymizationSettings": [
    ],
  • "customDocumentRules": [
    ],
  • "imageFormat": "PNG",
  • "imageFirstSide": {
    },
  • "imageSecondSide": {
    },
  • "ageLimit": 0,
  • "scanCroppedDocumentImage": false,
  • "maxAllowedMismatchesPerField": 0,
  • "allowUncertainFirstSideScan": true,
  • "scanPassportDataPageOnly": true,
  • "skipImagesWithInadequateLightingConditions": true,
  • "skipImagesOccludedByHand": true,
  • "traceId": "string"
}

Response samples

Content type
application/json
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

BlinkIdSingleSide

Scanning the front side of supported documents or MRZ on passports, visas and other documents.

header Parameters
X-ClientCustomerId
string or null
mb-api-key
string or null
Request Body schema: application/json
required
returnFullDocumentImage
boolean or null
Default: false

Defines whether full document image should be extracted. Default FALSE

returnFaceImage
boolean or null
Default: false

Defines whether face image should be extracted. Default FALSE

returnSignatureImage
boolean or null
Default: false

Defines whether signature image should be extracted. Default FALSE

skipImagesWithBlur
boolean or null
Default: true

Defines whether blurred frames filtering is allowed. Default TRUE

enableCharacterValidation
boolean or null
Default: true

Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE

enableBarcodeScanOnly
boolean or null
Default: false

This setting allows barcode recognition to proceed even if the initial extraction fails. If the barcode recognition is successful, the recognizer will still end in a valid state. This setting is applicable only to photo frames. For multi-side recognizers, it is permitted only for the back side. Default FALSE

anonymizationMode
string or null (Anonymization mode)
Default: "FULL_RESULT"
Enum: "NONE" "IMAGE_ONLY" "RESULT_FIELDS_ONLY" "FULL_RESULT"

Level of anonymization performed on recognizer result.

Array of objects or null (DocumentAnonymizationSettings)
Array of objects or null (DocumentRules)
imageFormat
string or null (Image Format)
Default: "PNG"
Enum: "JPG" "PNG" "QOI"

Defines return image type. Default PNG

ageLimit
integer or null <int32>

Defines the age limit for age verification.

required
object (ImageSource)

Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined.

scanCroppedDocumentImage
boolean or null
Default: false

Configure the recognizer to only work on already cropped and dewarped images. Default FALSE

skipImagesWithInadequateLightingConditions
boolean or null
Default: false

Indicates whether frames with inadequate lighting conditions should be rejected. A value of true means frames with poor lighting conditions will be excluded from further processing to prevent images with inadequate lighting from being used. Default FALSE

skipImagesOccludedByHand
boolean or null
Default: false

Indicates whether frames occluded by hand should be rejected. A value of true means frames occluded by hand will be excluded from further processing to prevent occluded images from being used. This setting is applicable only if scanCroppedDocumentImage is disabled. Default FALSE

traceId
string or null

Responses

Request samples

Content type
application/json
{
  • "returnFullDocumentImage": false,
  • "returnFaceImage": false,
  • "returnSignatureImage": false,
  • "skipImagesWithBlur": true,
  • "enableCharacterValidation": true,
  • "enableBarcodeScanOnly": false,
  • "anonymizationMode": "FULL_RESULT",
  • "customDocumentAnonymizationSettings": [
    ],
  • "customDocumentRules": [
    ],
  • "imageFormat": "PNG",
  • "ageLimit": 0,
  • "image": {
    },
  • "scanCroppedDocumentImage": false,
  • "skipImagesWithInadequateLightingConditions": false,
  • "skipImagesOccludedByHand": false,
  • "traceId": "string"
}

Response samples

Content type
application/json
{
  • "traceId": "string",
  • "executionId": "string",
  • "finishTime": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "data": {
    }
}

Management Endpoints

getHealth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getHealth_1

path Parameters
selector
required
string (HealthCheckType)
Enum: "LIVENESS" "READINESS"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getInfo

Responses

Response samples

Content type
application/json
[
  • { }
]