{
"openapi": "3.0.1",
"info": {
"title": "Self-hosted API",
"version": "5.1.0"
},
"paths": {
"/${microblink.health.custom.url}": {
"get": {
"operationId": "healthProxy",
"responses": {
"200": {
"description": "healthProxy 200 response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthResult"
}
}
}
}
}
}
}
},
"/barcode": {
"post": {
"tags": [
"Recognition endpoints"
],
"summary": "Barcode",
"operationId": "recognize",
"parameters": [
{
"name": "X-ClientCustomerId",
"in": "header",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "mb-api-key",
"in": "header",
"schema": {
"type": "string",
"nullable": true
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BarcodeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BarcodeEndpointResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
}
}
}
},
"/blinkcard": {
"post": {
"tags": [
"Recognition endpoints"
],
"summary": "Blink Card",
"operationId": "recognize_1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlinkCardRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlinkCardEndpointResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
}
}
}
},
"/blinkid-multi-side": {
"post": {
"tags": [
"Recognition endpoints"
],
"summary": "BlinkIdMultiSide",
"description": "Scanning both sides of [supported](https://github.com/BlinkID/blinkid-android/blob/master/documentation/BlinkIDRecognizer.md) documents or MRZ on passports, visas and other documents.",
"operationId": "recognize_2",
"parameters": [
{
"name": "X-ClientCustomerId",
"in": "header",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "mb-api-key",
"in": "header",
"schema": {
"type": "string",
"nullable": true
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlinkIdMultiSideRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlinkIdMultiSideEndpointResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
}
}
}
},
"/blinkid-single-side": {
"post": {
"tags": [
"Recognition endpoints"
],
"summary": "BlinkIdSingleSide",
"description": "Scanning the front side of [supported](https://github.com/BlinkID/blinkid-android/blob/master/documentation/BlinkIDRecognizer.md) documents or MRZ on passports, visas and other documents.",
"operationId": "recognize_3",
"parameters": [
{
"name": "X-ClientCustomerId",
"in": "header",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "mb-api-key",
"in": "header",
"schema": {
"type": "string",
"nullable": true
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlinkIdSingleSideRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlinkIdSingleSideEndpointResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DefaultResponse"
}
}
}
}
}
}
},
"/health": {
"get": {
"tags": [
"Management Endpoints"
],
"operationId": "getHealth",
"responses": {
"200": {
"description": "getHealth 200 response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthResult"
}
}
}
}
}
}
}
},
"/health/{selector}": {
"get": {
"tags": [
"Management Endpoints"
],
"operationId": "getHealth_1",
"parameters": [
{
"name": "selector",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/HealthCheckType"
}
}
],
"responses": {
"200": {
"description": "getHealth_1 200 response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthResult"
}
}
}
}
}
}
}
},
"/info": {
"get": {
"tags": [
"Management Endpoints"
],
"operationId": "getInfo",
"responses": {
"200": {
"description": "getInfo 200 response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AdditionalProcessingInfo": {
"type": "object",
"properties": {
"missingMandatoryFields": {
"type": "array",
"description": "List of fields that were expected on the document but were missing.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/FieldType"
}
},
"invalidCharacterFields": {
"type": "array",
"description": "List of fields that contained characters which were not expected in that field.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/FieldType"
}
},
"extraPresentFields": {
"type": "array",
"description": "List of fields that weren't expected on the document but were present.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/FieldType"
}
},
"imageExtractionFailures": {
"type": "array",
"description": "List of failed image extractions.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ImageExtractionType"
}
}
},
"description": "The additional details about the processing info."
},
"AddressDetailedInfo": {
"type": "object",
"properties": {
"street": {
"type": "string",
"description": "The street address portion of the United States driver license owner.",
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The postal code address portion of the United States driver license owner.",
"nullable": true
},
"city": {
"type": "string",
"description": "The city address portion of the United States driver license owner.",
"nullable": true
},
"jurisdiction": {
"type": "string",
"description": "The jurisdiction code address portion of the United States driver license owner.",
"nullable": true
}
},
"description": "The details about the address."
},
"AlphabetType": {
"type": "string",
"enum": [
"LATIN",
"ARABIC",
"CYRILLIC",
"GREEK"
]
},
"AnonymizationMode": {
"title": "Anonymization mode",
"type": "string",
"description": "Level of anonymization performed on recognizer result.",
"enum": [
"NONE",
"IMAGE_ONLY",
"RESULT_FIELDS_ONLY",
"FULL_RESULT"
]
},
"AnonymizationSettings": {
"type": "object",
"properties": {
"cardNumberAnonymizationSettings": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardNumberAnonymizationSettings"
},
{
"type": "CardNumberAnonymizationSettings",
"description": "Defines the parameters of card number anonymization.",
"allOf": [
{
"$ref": "#/components/schemas/CardNumberAnonymizationSettings"
}
]
}
]
},
"cardNumberPrefixAnonymizationMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
},
{
"type": "AnonymizationMode",
"description": "Defines the mode of card number prefix anonymization. Default NONE",
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
}
],
"default": "NONE"
}
]
},
"cvvAnonymizationMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
},
{
"type": "AnonymizationMode",
"description": "Defines the mode of CVV anonymization. Default NONE",
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
}
],
"default": "NONE"
}
]
},
"ibanAnonymizationMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
},
{
"type": "AnonymizationMode",
"description": "Defines the mode of IBAN anonymization. Default NONE",
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
}
],
"default": "NONE"
}
]
},
"cardholderAnonymizationMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
},
{
"type": "AnonymizationMode",
"description": "Defines the mode of cardholder anonymization. Default NONE",
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
}
],
"default": "NONE"
}
]
}
},
"description": "Whether sensitive data should be redacted from the result."
},
"BarcodeDriverLicenseDetailedInfo": {
"type": "object",
"properties": {
"restrictions": {
"type": "string",
"description": "The restrictions to driving privileges for the United States driver license owner.",
"nullable": true
},
"endorsements": {
"type": "string",
"description": "The additional privileges granted to the United States driver license owner.",
"nullable": true
},
"vehicleClass": {
"type": "string",
"description": "The type of vehicle the driver license owner has privilege to drive.",
"nullable": true
},
"conditions": {
"type": "string",
"description": "The driver license conditions.",
"nullable": true
},
"vehicleClassesInfo": {
"type": "array",
"description": "The additional information on vehicle class.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/BarcodeVehicleClassInfo"
}
}
},
"description": "The driver license detailed info."
},
"BarcodeElement": {
"type": "object",
"properties": {
"key": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/BarcodeElementKey"
}
]
},
"value": {
"type": "string",
"nullable": true
}
}
},
"BarcodeElementKey": {
"title": "Barcode element key",
"type": "string",
"description": "Additional fields present in the barcode.",
"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"
]
},
"BarcodeEndpointResponse": {
"required": [
"data",
"executionId",
"finishTime",
"startTime"
],
"type": "object",
"properties": {
"traceId": {
"type": "string",
"nullable": true
},
"executionId": {
"type": "string"
},
"finishTime": {
"type": "string",
"description": "UTC time after recognition finished.",
"format": "date-time"
},
"startTime": {
"type": "string",
"description": "UTC time before recognition started.",
"format": "date-time"
},
"data": {
"$ref": "#/components/schemas/BarcodeRecognizerOutput"
}
},
"description": "Response for Barcode."
},
"BarcodeRecognizerOutput": {
"required": [
"recognitionStatus"
],
"type": "object",
"properties": {
"barcodeType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/BarcodeType"
}
]
},
"rawData": {
"type": "string",
"description": "Byte array with result of the scan.",
"nullable": true
},
"stringData": {
"type": "string",
"description": "Retrieves string content of scanned data.",
"nullable": true
},
"uncertain": {
"type": "boolean",
"description": "Flag indicating uncertain scanning data.",
"nullable": true
},
"detectionPoints": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DetectionPoints"
}
]
},
"recognitionStatus": {
"$ref": "#/components/schemas/ResultState"
}
}
},
"BarcodeRequest": {
"required": [
"image"
],
"type": "object",
"properties": {
"autoScaleDetection": {
"type": "boolean",
"description": "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",
"nullable": true,
"default": true
},
"nullQuietZoneAllowed": {
"type": "boolean",
"description": "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",
"nullable": true,
"default": false
},
"readCode39AsExtendedData": {
"type": "boolean",
"description": "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",
"nullable": true,
"default": false
},
"scanCode128": {
"type": "boolean",
"description": "Set this to true to scan Code 128 1D barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanCode39": {
"type": "boolean",
"description": "Set this to true to scan Code 39 1D barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanEan13": {
"type": "boolean",
"description": "Set this to true to scan EAN 13 barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanEan8": {
"type": "boolean",
"description": "Set this to true to scan EAN8 barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanInverse": {
"type": "boolean",
"description": "Set this to true to allow scanning barcodes with inverted intensities. This options doubles the frame processing time. Default FALSE",
"nullable": true,
"default": false
},
"scanItf": {
"type": "boolean",
"description": "Set this to true to scan ITF barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanPdf417": {
"type": "boolean",
"description": "Set this to true to scan Pdf417 barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanQrCode": {
"type": "boolean",
"description": "Set this to true to scan QR barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanUncertain": {
"type": "boolean",
"description": "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",
"nullable": true,
"default": true
},
"scanUpca": {
"type": "boolean",
"description": "Set this to true to scan UPCA barcodes. Default FALSE",
"nullable": true,
"default": false
},
"scanUpce": {
"type": "boolean",
"description": "Set this to true to scan UPCE barcodes. Default FALSE",
"nullable": true,
"default": false
},
"slowerThoroughScan": {
"type": "boolean",
"description": "Set this to true to allow slower, but better image processing. Default FALSE",
"nullable": true,
"default": false
},
"image": {
"$ref": "#/components/schemas/ImageSource"
},
"traceId": {
"type": "string",
"nullable": true
}
},
"description": "Request body for Barcode recognition.",
"allOf": [
{
"$ref": "#/components/schemas/MicroblinkEndpointRequest"
}
]
},
"BarcodeResult": {
"type": "object",
"properties": {
"rawDataBase64": {
"type": "string",
"description": "The raw bytes contained inside barcode.",
"nullable": true
},
"stringData": {
"type": "string",
"description": "String representation of data inside barcode.",
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the document owner.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "The last name of the document owner.",
"nullable": true
},
"middleName": {
"type": "string",
"description": "The middle name of the document owner.",
"nullable": true
},
"fullName": {
"type": "string",
"description": "The full name of the document owner.",
"nullable": true
},
"additionalNameInformation": {
"type": "string",
"description": "The additional name information of the document owner.",
"nullable": true
},
"address": {
"type": "string",
"description": "The address of the document owner.",
"nullable": true
},
"placeOfBirth": {
"type": "string",
"description": "The place of birth of the document owner.",
"nullable": true
},
"nationality": {
"type": "string",
"description": "The nationality of the documet owner.",
"nullable": true
},
"race": {
"type": "string",
"description": "The race of the document owner.",
"nullable": true
},
"religion": {
"type": "string",
"description": "The religion of the document owner.",
"nullable": true
},
"profession": {
"type": "string",
"description": "The profession of the document owner.",
"nullable": true
},
"maritalStatus": {
"type": "string",
"description": "The marital status of the document owner.",
"nullable": true
},
"residentialStatus": {
"type": "string",
"description": "The residential stauts of the document owner.",
"nullable": true
},
"employer": {
"type": "string",
"description": "The employer of the document owner.",
"nullable": true
},
"sex": {
"type": "string",
"description": "The sex of the document owner.",
"nullable": true
},
"dateOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
}
]
},
"dateOfIssue": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
}
]
},
"dateOfExpiry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
}
]
},
"documentNumber": {
"type": "string",
"description": "The document number.",
"nullable": true
},
"personalIdNumber": {
"type": "string",
"description": "The personal identification number.",
"nullable": true
},
"documentAdditionalNumber": {
"type": "string",
"description": "The additional number of the document.",
"nullable": true
},
"issuingAuthority": {
"type": "string",
"description": "The issuing authority of the document.",
"nullable": true
},
"addressDetailedInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AddressDetailedInfo"
}
]
},
"driverLicenseDetailedInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/BarcodeDriverLicenseDetailedInfo"
}
]
},
"extendedElements": {
"type": "array",
"description": "Document specific extended elements that contain all barcode fields in their original form.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/BarcodeElement"
}
},
"parsed": {
"type": "boolean",
"description": "Boolean that indicates whether the raw barcode data was successfully parsed."
}
},
"description": "The data extracted from the barcode."
},
"BarcodeType": {
"title": "Barcode type",
"type": "string",
"description": "Type of barcode.",
"enum": [
"NONE",
"QR_CODE",
"UPC_E",
"UPC_A",
"EAN_8",
"EAN_13",
"CODE_128",
"CODE_39",
"ITF",
"PDF417_BARCODE"
]
},
"BarcodeVehicleClassInfo": {
"type": "object",
"properties": {
"vehicleClass": {
"type": "string",
"description": "The type of vehicle the driver license owner has privilege to drive.",
"nullable": true
},
"licenceType": {
"type": "string",
"description": "The type of driver licence.",
"nullable": true
},
"effectiveDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date since licence is effective"
}
]
},
"expiryDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
},
{
"description": "The date of expiry of licence."
}
]
}
},
"description": "The additional information on vehicle class."
},
"BlinkCardEndpointResponse": {
"required": [
"data",
"executionId",
"finishTime",
"startTime"
],
"type": "object",
"properties": {
"traceId": {
"type": "string",
"nullable": true
},
"executionId": {
"type": "string"
},
"finishTime": {
"type": "string",
"description": "UTC time after recognition finished.",
"format": "date-time"
},
"startTime": {
"type": "string",
"description": "UTC time before recognition started.",
"format": "date-time"
},
"data": {
"$ref": "#/components/schemas/BlinkCardRecognizerOutput"
}
},
"description": "Response for BlinkCard."
},
"BlinkCardProcessingStatus": {
"title": "BlinkCard processing status",
"type": "string",
"description": "Processing status of BlinkCard.",
"enum": [
"SUCCESS",
"DETECTION_FAILED",
"IMAGE_PREPROCESSING_FAILED",
"STABILITY_TEST_FAILED",
"SCANNING_WRONG_SIDE",
"FIELD_IDENTIFICATION_FAILED",
"IMAGE_RETURN_FAILED",
"AWAITING_OTHER_SIDE",
"NOT_SCANNED",
"FRAME_NOT_FOCUSED"
]
},
"BlinkCardRecognizerOutput": {
"required": [
"issuingNetwork",
"processingStatus",
"recognitionStatus"
],
"type": "object",
"properties": {
"issuingNetwork": {
"$ref": "#/components/schemas/CardIssuer"
},
"cardNumber": {
"type": "string",
"description": "The payment card number.",
"nullable": true
},
"cardNumberValid": {
"type": "boolean",
"description": "The payment card number validity",
"nullable": true
},
"cardNumberPrefix": {
"type": "string",
"description": "The payment card number prefix.",
"nullable": true
},
"iban": {
"type": "string",
"description": "Payment card's IBAN.",
"nullable": true
},
"cvv": {
"type": "string",
"description": "Payment card's security code/value.",
"nullable": true
},
"expiryDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
}
]
},
"cardholderName": {
"type": "string",
"description": "Information about the payment card owner.",
"nullable": true
},
"fundingType": {
"type": "string",
"description": "Funding type of the payment card.",
"nullable": true
},
"cardCategory": {
"type": "string",
"description": "Card category.",
"nullable": true
},
"issuerName": {
"type": "string",
"description": "Card issuer name.",
"nullable": true
},
"issuerCountryCode": {
"type": "string",
"description": "Card issuer country code.",
"nullable": true
},
"issuerCountry": {
"type": "string",
"description": "Card issuer country.",
"nullable": true
},
"firstSideFullCardImage": {
"type": "string",
"description": "Full image of the payment card from first side recognition.",
"nullable": true
},
"secondSideFullCardImage": {
"type": "string",
"description": "Full image of the payment card from second side recognition.",
"nullable": true
},
"firstSideBlurDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardImageAnalysisDetectionStatus"
},
{
"description": "Blur detection status for the first scanned side."
}
]
},
"secondSideBlurDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardImageAnalysisDetectionStatus"
},
{
"description": "Blur detection status for the second scanned side."
}
]
},
"firstSideAnonymized": {
"type": "boolean",
"description": "Whether the first side of document is anonymized.",
"nullable": true
},
"secondSideAnonymized": {
"type": "boolean",
"description": "Whether the second side of document is anonymized.",
"nullable": true
},
"firstSideCardLivenessResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardLivenessCheckResult"
},
{
"description": "Card liveness check result for the first side."
}
]
},
"secondSideCardLivenessResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardLivenessCheckResult"
},
{
"description": "Card liveness check result for the second side."
}
]
},
"processingStatus": {
"$ref": "#/components/schemas/BlinkCardProcessingStatus"
},
"scanningFirstSideDone": {
"type": "boolean",
"description": "Whether the scanning of the first side is finished.",
"nullable": true
},
"recognitionStatus": {
"$ref": "#/components/schemas/ResultState"
}
}
},
"BlinkCardRequest": {
"required": [
"cardNumberSide"
],
"type": "object",
"properties": {
"extractIban": {
"type": "boolean",
"description": "Should extract the payment card's IBAN. Default TRUE",
"nullable": true,
"default": true
},
"extractExpiryDate": {
"type": "boolean",
"description": "Defines whether the expiry date should be extracted. Default TRUE",
"nullable": true,
"default": true
},
"extractCardholderName": {
"type": "boolean",
"description": "Should extract the card owner information. Default TRUE",
"nullable": true,
"default": true
},
"extractCvv": {
"type": "boolean",
"description": "Defines whether the cvv should be extracted. Default TRUE",
"nullable": true,
"default": true
},
"returnFullCardImage": {
"type": "boolean",
"description": "Defines whether full document image should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"handToCardSizeRatio": {
"type": "number",
"format": "float",
"nullable": true
},
"handCardOverlapThreshold": {
"type": "number",
"format": "float",
"nullable": true
},
"enableCardHeldInHandCheck": {
"type": "boolean",
"description": "Defines whether card-held-in-hand check should be enabled. Default TRUE",
"nullable": true,
"default": true
},
"screenCheckStrictnessLevel": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StrictnessLevel"
}
]
},
"photocopyCheckStrictnessLevel": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StrictnessLevel"
}
]
},
"anonymizationSettings": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationSettings"
}
]
},
"imageFormat": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageFormat"
},
{
"description": "Defines return image type. Default PNG",
"default": "PNG"
}
]
},
"skipImagesWithBlur": {
"type": "boolean",
"description": "Defines whether blurred frames filtering is allowed. Default TRUE",
"nullable": true,
"default": true
},
"extractInvalidCardNumber": {
"type": "boolean",
"description": "Defines whether invalid card number should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"cardNumberSide": {
"$ref": "#/components/schemas/ImageSource"
},
"otherSide": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageSource"
}
]
},
"traceId": {
"type": "string",
"nullable": true
}
},
"description": "Request body for Blink Card recognition.",
"allOf": [
{
"$ref": "#/components/schemas/MicroblinkEndpointRequest"
}
]
},
"BlinkIdMultiSideEndpointResponse": {
"required": [
"data",
"executionId",
"finishTime",
"startTime"
],
"type": "object",
"properties": {
"traceId": {
"type": "string",
"nullable": true
},
"executionId": {
"type": "string"
},
"finishTime": {
"type": "string",
"description": "UTC time after recognition finished.",
"format": "date-time"
},
"startTime": {
"type": "string",
"description": "UTC time before recognition started.",
"format": "date-time"
},
"data": {
"$ref": "#/components/schemas/BlinkIdMultiSideRecognizerOutput"
}
},
"description": "Response for BlinkIdMultiSide."
},
"BlinkIdMultiSideRecognizerOutput": {
"required": [
"recognitionStatus"
],
"type": "object",
"properties": {
"firstName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The first name of the document owner."
}
]
},
"lastName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The last name of the document owner."
}
]
},
"fullName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The last name of the document owner."
}
]
},
"address": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The address of the document owner."
}
]
},
"dateOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"dateOfIssue": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"dateOfExpiry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"documentNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The document number."
}
]
},
"sex": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The sex of the document owner."
}
]
},
"driverLicenseDetailedInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DriverLicenseDetailedInfo"
}
]
},
"bloodType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The blood type of the document owner."
}
]
},
"sponsor": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The sponsor of the document owner."
}
]
},
"visaType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "Visa type of the document."
}
]
},
"fullDocumentFirstSideImage": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CroppedImageResult"
},
{
"description": "The full document front image."
}
]
},
"fullDocumentSecondSideImage": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CroppedImageResult"
},
{
"description": "The full document front image."
}
]
},
"faceImage": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DetailedCroppedImageResult"
},
{
"description": "The face image."
}
]
},
"signatureImage": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DetailedCroppedImageResult"
},
{
"description": "The signature image."
}
]
},
"documentSubtype": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The transcription of the document subtype."
}
]
},
"remarks": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The remarks on the residence permit."
}
]
},
"residencePermitType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The residence permit type."
}
]
},
"manufacturingYear": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The manufacturing year."
}
]
},
"vehicleType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": " The vehicle type."
}
]
},
"eligibilityCategory": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The eligibility category."
}
]
},
"specificDocumentValidity": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The specific document validity."
}
]
},
"dependentsInfo": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DependentInfo"
}
},
"parentsInfo": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ParentInfo"
}
},
"vehicleOwner": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The vehicle owner."
}
]
},
"certificateNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The certificate number of the document owner."
}
]
},
"countryCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The country code of the document owner."
}
]
},
"nationalInsuranceNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The national insurance number of the document owner."
}
]
},
"additionalNameInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional name information of the document owner."
}
]
},
"additionalAddressInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional address information of the document owner."
}
]
},
"additionalOptionalAddressInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The one more additional address information of the document owner."
}
]
},
"placeOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The place of birth of the document owner."
}
]
},
"nationality": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The nationality of the documet owner."
}
]
},
"race": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The race of the document owner."
}
]
},
"religion": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The religion of the document owner."
}
]
},
"profession": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The profession of the document owner."
}
]
},
"maritalStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The marital status of the document owner."
}
]
},
"residentialStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The residential stauts of the document owner."
}
]
},
"employer": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The employer of the document owner."
}
]
},
"personalIdNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The personal identification number."
}
]
},
"documentAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional number of the document."
}
]
},
"documentOptionalAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The one more additional number of the document."
}
]
},
"issuingAuthority": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The issuing authority of the document."
}
]
},
"fathersName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The fathers name of the document owner."
}
]
},
"mothersName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The mothers name of the document owner."
}
]
},
"dateOfEntry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The date of entry."
}
]
},
"effectiveDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The effective date."
}
]
},
"localityCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The locality code."
}
]
},
"husbandName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The husband name of the document owner."
}
]
},
"legalStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The legal status of the document owner."
}
]
},
"socialSecurityStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The social security status of the document owner."
}
]
},
"workRestriction": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The work restriction of the document owner."
}
]
},
"maidenName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The maiden name of the document owner."
}
]
},
"municipalityCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The municipality code."
}
]
},
"municipalityOfRegistration": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The municipality of registration."
}
]
},
"pollingStationCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The polling station code."
}
]
},
"registrationCenterCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The registration center code."
}
]
},
"sectionCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The section code."
}
]
},
"stateCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The state code."
}
]
},
"stateName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The state name."
}
]
},
"mrzData": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/MrzResult"
}
]
},
"localizedName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The localized name of the document."
}
]
},
"dataMatchResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DataMatchResult"
}
]
},
"dateOfExpiryPermanent": {
"type": "boolean",
"description": "Determines if date of expiry is permanent.",
"nullable": true
},
"scanningFirstSideDone": {
"type": "boolean",
"description": "Defines whether recognizer has finished scanning first side.",
"nullable": true
},
"additionalPersonalIdNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional personal identification number."
}
]
},
"cardAccessNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "Numeric code used to establish secure electronic access to the embedded contactless chip. "
}
]
},
"firstSideViz": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/VIZResult"
}
]
},
"secondSideViz": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/VIZResult"
}
]
},
"barcode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/BarcodeResult"
}
]
},
"firstSideImageAnalysisResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisResult"
}
]
},
"secondSideImageAnalysisResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisResult"
}
]
},
"processingStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ProcessingStatus"
}
]
},
"firstSideProcessingStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ProcessingStatus"
}
]
},
"secondSideProcessingStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ProcessingStatus"
}
]
},
"recognitionMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/RecognitionMode"
}
]
},
"documentClassInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentClassInfo"
}
]
},
"recognitionStatus": {
"$ref": "#/components/schemas/ResultState"
},
"firstSideAdditionalProcessingInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AdditionalProcessingInfo"
}
]
},
"secondSideAdditionalProcessingInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AdditionalProcessingInfo"
}
]
},
"isBelowAgeLimit": {
"type": "boolean",
"description": "The indicator if document owner is below age limit provided in the request. Default -1 if ageLimit is not sent in the request.",
"nullable": true
},
"age": {
"type": "integer",
"description": "The calculated age of the document owner.",
"format": "int32",
"nullable": true
}
}
},
"BlinkIdMultiSideRequest": {
"required": [
"imageFirstSide"
],
"type": "object",
"properties": {
"returnFullDocumentImage": {
"type": "boolean",
"description": "Defines whether full document image should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"returnFaceImage": {
"type": "boolean",
"description": "Defines whether face image should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"returnSignatureImage": {
"type": "boolean",
"description": "Defines whether signature image should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"skipImagesWithBlur": {
"type": "boolean",
"description": "Defines whether blurred frames filtering is allowed. Default TRUE",
"nullable": true,
"default": true
},
"scanUnsupportedSecondSide": {
"type": "boolean",
"description": "Skip back side capture and processing step when back side of the document is not supported. Default FALSE",
"nullable": true,
"default": false
},
"enableCharacterValidation": {
"type": "boolean",
"description": "Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE",
"nullable": true,
"default": true
},
"enableBarcodeScanOnly": {
"type": "boolean",
"description": "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",
"nullable": true,
"default": false
},
"anonymizationMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
},
{
"type": "AnonymizationMode",
"description": "Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT",
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
}
],
"default": "FULL_RESULT"
}
]
},
"customDocumentAnonymizationSettings": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DocumentAnonymizationSettings"
}
},
"customDocumentRules": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DocumentRules"
}
},
"imageFormat": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageFormat"
},
{
"description": "Defines return image type. Default PNG",
"default": "PNG"
}
]
},
"imageFirstSide": {
"$ref": "#/components/schemas/ImageSource"
},
"imageSecondSide": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageSource"
}
]
},
"ageLimit": {
"type": "integer",
"description": "Defines the age limit for age verification.",
"format": "int32",
"nullable": true
},
"scanCroppedDocumentImage": {
"type": "boolean",
"description": "Configure the recognizer to only work on already cropped and dewarped images. Default FALSE",
"nullable": true,
"default": false
},
"maxAllowedMismatchesPerField": {
"type": "integer",
"description": "Configure the number of characters per field that are allowed to be inconsistent in data match. Default 0",
"format": "int32",
"nullable": true,
"default": 0
},
"allowUncertainFirstSideScan": {
"type": "boolean",
"description": "Proceed with scanning the back side even if the front side result is uncertain. Default TRUE",
"nullable": true,
"default": true
},
"scanPassportDataPageOnly": {
"type": "boolean",
"description": "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",
"nullable": true,
"default": true
},
"skipImagesWithInadequateLightingConditions": {
"type": "boolean",
"description": "Indicates whether frames with inadequate lighting conditions should be rejected.\n A value of `true` means frames with poor lighting conditions will be excluded from\n further processing to prevent images with inadequate lighting from being used. Default TRUE",
"nullable": true,
"default": true
},
"skipImagesOccludedByHand": {
"type": "boolean",
"description": "Indicates whether frames occluded by hand should be rejected.\n A value of `true` means frames occluded by hand will be excluded from\n further processing to prevent occluded images from being used.\n This setting is applicable only if `scanCroppedDocumentImage` is disabled. Default TRUE",
"nullable": true,
"default": true
},
"traceId": {
"type": "string",
"nullable": true
}
},
"description": "Request body for Blink Id Combined recognition.",
"allOf": [
{
"$ref": "#/components/schemas/MicroblinkEndpointRequest"
}
]
},
"BlinkIdSingleSideEndpointResponse": {
"required": [
"data",
"executionId",
"finishTime",
"startTime"
],
"type": "object",
"properties": {
"traceId": {
"type": "string",
"nullable": true
},
"executionId": {
"type": "string"
},
"finishTime": {
"type": "string",
"description": "UTC time after recognition finished.",
"format": "date-time"
},
"startTime": {
"type": "string",
"description": "UTC time before recognition started.",
"format": "date-time"
},
"data": {
"$ref": "#/components/schemas/BlinkIdSingleSideRecognizerOutput"
}
},
"description": "Response for BlinkId."
},
"BlinkIdSingleSideRecognizerOutput": {
"required": [
"recognitionStatus"
],
"type": "object",
"properties": {
"firstName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The first name of the document owner."
}
]
},
"lastName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The last name of the document owner."
}
]
},
"fullName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The full name of the document owner."
}
]
},
"address": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The address of the document owner."
}
]
},
"dateOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"dateOfIssue": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"dateOfExpiry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"documentNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The document number."
}
]
},
"sex": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The sex of the document owner."
}
]
},
"driverLicenseDetailedInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DriverLicenseDetailedInfo"
}
]
},
"bloodType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The blood type of the document owner."
}
]
},
"sponsor": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The sponsor of the document owner."
}
]
},
"visaType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "Visa type of the document."
}
]
},
"fullDocumentImage": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CroppedImageResult"
},
{
"description": "The full document image."
}
]
},
"faceImage": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DetailedCroppedImageResult"
},
{
"description": "The face image."
}
]
},
"signatureImage": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DetailedCroppedImageResult"
},
{
"description": "The signature image."
}
]
},
"documentSubtype": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The transcription of the document subtype."
}
]
},
"remarks": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The remarks on the residence permit."
}
]
},
"residencePermitType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The residence permit type."
}
]
},
"manufacturingYear": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The manufacturing year."
}
]
},
"vehicleType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": " The vehicle type."
}
]
},
"eligibilityCategory": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The eligibility category."
}
]
},
"specificDocumentValidity": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The specific document validity."
}
]
},
"dependentsInfo": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DependentInfo"
}
},
"parentsInfo": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ParentInfo"
}
},
"vehicleOwner": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The vehicle owner."
}
]
},
"certificateNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The certificate number of the document owner."
}
]
},
"countryCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The country code of the document owner."
}
]
},
"nationalInsuranceNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The national insurance number of the document owner."
}
]
},
"additionalNameInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional name information of the document owner."
}
]
},
"additionalAddressInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional address information of the document owner."
}
]
},
"additionalOptionalAddressInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The one more additional address information of the document owner."
}
]
},
"placeOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The place of birth of the document owner."
}
]
},
"nationality": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The nationality of the documet owner."
}
]
},
"race": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The race of the document owner."
}
]
},
"religion": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The religion of the document owner."
}
]
},
"profession": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The profession of the document owner."
}
]
},
"maritalStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The marital status of the document owner."
}
]
},
"residentialStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The residential stauts of the document owner."
}
]
},
"employer": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The employer of the document owner."
}
]
},
"personalIdNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The personal identification number."
}
]
},
"documentAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional number of the document."
}
]
},
"documentOptionalAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The one more additional number of the document."
}
]
},
"issuingAuthority": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The issuing authority of the document."
}
]
},
"fathersName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The fathers name of the document owner."
}
]
},
"mothersName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The mothers name of the document owner."
}
]
},
"dateOfEntry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The date of entry."
}
]
},
"effectiveDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The effective date."
}
]
},
"localityCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The locality code."
}
]
},
"husbandName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The husband name of the document owner."
}
]
},
"legalStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The legal status of the document owner."
}
]
},
"socialSecurityStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The social security status of the document owner."
}
]
},
"workRestriction": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The work restriction of the document owner."
}
]
},
"maidenName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The maiden name of the document owner."
}
]
},
"municipalityCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The municipality code."
}
]
},
"municipalityOfRegistration": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The municipality of registration."
}
]
},
"pollingStationCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The polling station code."
}
]
},
"registrationCenterCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The registration center code."
}
]
},
"sectionCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The section code."
}
]
},
"stateCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The state code."
}
]
},
"stateName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The state name."
}
]
},
"mrzData": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/MrzResult"
}
]
},
"localizedName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The localized name of the document."
}
]
},
"dateOfExpiryPermanent": {
"type": "boolean",
"description": "Determines if date of expiry is permanent.",
"nullable": true
},
"additionalPersonalIdNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional personal identification number."
}
]
},
"cardAccessNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "Numeric code used to establish secure electronic access to the embedded contactless chip. "
}
]
},
"viz": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/VIZResult"
}
]
},
"barcode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/BarcodeResult"
}
]
},
"imageAnalysisResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisResult"
}
]
},
"processingStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ProcessingStatus"
}
]
},
"recognitionMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/RecognitionMode"
}
]
},
"documentClassInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentClassInfo"
}
]
},
"recognitionStatus": {
"$ref": "#/components/schemas/ResultState"
},
"additionalProcessingInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AdditionalProcessingInfo"
}
]
},
"isBelowAgeLimit": {
"type": "boolean",
"description": "The indicator if document owner is below age limit provided in the request. Default -1 if ageLimit is not sent in the request.",
"nullable": true
},
"age": {
"type": "integer",
"description": "The calculated age of the document owner.",
"format": "int32",
"nullable": true
}
}
},
"BlinkIdSingleSideRequest": {
"required": [
"image"
],
"type": "object",
"properties": {
"returnFullDocumentImage": {
"type": "boolean",
"description": "Defines whether full document image should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"returnFaceImage": {
"type": "boolean",
"description": "Defines whether face image should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"returnSignatureImage": {
"type": "boolean",
"description": "Defines whether signature image should be extracted. Default FALSE",
"nullable": true,
"default": false
},
"skipImagesWithBlur": {
"type": "boolean",
"description": "Defines whether blurred frames filtering is allowed. Default TRUE",
"nullable": true,
"default": true
},
"enableCharacterValidation": {
"type": "boolean",
"description": "Whether result characters validation is performed. If a result member contains invalid character, the result state cannot be valid. Default TRUE",
"nullable": true,
"default": true
},
"enableBarcodeScanOnly": {
"type": "boolean",
"description": "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",
"nullable": true,
"default": false
},
"anonymizationMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
},
{
"type": "AnonymizationMode",
"description": "Whether sensitive data should be removed from images, result fields or both. The setting only applies to certain documents. Default FULL_RESULT",
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
}
],
"default": "FULL_RESULT"
}
]
},
"customDocumentAnonymizationSettings": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DocumentAnonymizationSettings"
}
},
"customDocumentRules": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DocumentRules"
}
},
"imageFormat": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageFormat"
},
{
"description": "Defines return image type. Default PNG",
"default": "PNG"
}
]
},
"ageLimit": {
"type": "integer",
"description": "Defines the age limit for age verification.",
"format": "int32",
"nullable": true
},
"image": {
"$ref": "#/components/schemas/ImageSource"
},
"scanCroppedDocumentImage": {
"type": "boolean",
"description": "Configure the recognizer to only work on already cropped and dewarped images. Default FALSE",
"nullable": true,
"default": false
},
"skipImagesWithInadequateLightingConditions": {
"type": "boolean",
"description": "Indicates whether frames with inadequate lighting conditions should be rejected.\n A value of `true` means frames with poor lighting conditions will be excluded from\n further processing to prevent images with inadequate lighting from being used. Default FALSE",
"nullable": true,
"default": false
},
"skipImagesOccludedByHand": {
"type": "boolean",
"description": "Indicates whether frames occluded by hand should be rejected.\n A value of `true` means frames occluded by hand will be excluded from\n further processing to prevent occluded images from being used.\n This setting is applicable only if `scanCroppedDocumentImage` is disabled. Default FALSE",
"nullable": true,
"default": false
},
"traceId": {
"type": "string",
"nullable": true
}
},
"description": "Request body for Blink Id recognition.",
"allOf": [
{
"$ref": "#/components/schemas/MicroblinkEndpointRequest"
}
]
},
"CardCheckResult": {
"type": "string",
"enum": [
"NOT_AVAILABLE",
"PASS",
"FAIL"
]
},
"CardImageAnalysisDetectionStatus": {
"type": "string",
"enum": [
"NOT_AVAILABLE",
"NOT_DETECTED",
"DETECTED"
]
},
"CardIssuer": {
"title": "Card issuer",
"type": "string",
"description": "Supported issuing institutions that issued the card to the card holder.",
"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"
]
},
"CardLivenessCheckResult": {
"type": "object",
"properties": {
"screenCheckResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardCheckResult"
},
{
"description": "Result of screen check."
}
]
},
"photocopyCheckResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardCheckResult"
},
{
"description": "Result of photocopy check."
}
]
},
"cardHeldInHandCheckResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/CardCheckResult"
},
{
"description": "Result of card-held-in-hand check."
}
]
}
},
"description": "Result of card liveness checks."
},
"CardNumberAnonymizationSettings": {
"type": "object",
"properties": {
"anonymizationMode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
},
{
"type": "AnonymizationMode",
"description": "Defines the mode of card number anonymization. Default NONE",
"allOf": [
{
"$ref": "#/components/schemas/AnonymizationMode"
}
],
"default": "NONE"
}
]
},
"prefixDigitsVisible": {
"type": "integer",
"description": "Defines how many digits at the beginning of the card number remain visible after anonymization. Default 0",
"format": "int32",
"nullable": true,
"default": 0
},
"suffixDigitsVisible": {
"type": "integer",
"description": "Defines how many digits at the end of the card number remain visible after anonymization. Default 0",
"format": "int32",
"nullable": true,
"default": 0
}
},
"description": "Parameters of card number anonymization"
},
"Country": {
"title": "Country",
"type": "string",
"description": "Document 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_WALLIS_AND_FUTUNA",
"COUNTRY_WESTERN_SAHARA",
"COUNTRY_YEMEN",
"COUNTRY_YUGOSLAVIA",
"COUNTRY_ZAMBIA",
"COUNTRY_ZIMBABWE",
"COUNTRY_SCHENGEN_AREA",
"COUNTRY_SAINT_THOMAS_AND_PRINCE",
"COUNTRY_VIRGIN_ISLANDS_OF_THE_UNITED_STATES"
]
},
"CroppedImageResult": {
"required": [
"image"
],
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "The cropped image."
}
},
"description": "The result of the cropped image transformation with additional details."
},
"DataMatchResult": {
"required": [
"dateOfExpiry"
],
"type": "object",
"properties": {
"dateOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DataMatchState"
},
{
"description": "The result of data match on date of birth field."
}
]
},
"dateOfExpiry": {
"allOf": [
{
"$ref": "#/components/schemas/DataMatchState"
},
{
"description": "The result of data match on date of expiry field."
}
]
},
"documentNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DataMatchState"
},
{
"description": "The result of data match on document number field."
}
]
},
"documentAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DataMatchState"
},
{
"description": "The result of data match on document additional number field."
}
]
},
"documentOptionalAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DataMatchState"
},
{
"description": "The result of data match on document optional additional number field."
}
]
},
"personalIdNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DataMatchState"
},
{
"description": "The result of data match on personal ID number field."
}
]
},
"dataMatchResult": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DataMatchState"
},
{
"description": "The result of data match on the whole document."
}
]
}
},
"description": "Result of data match check."
},
"DataMatchState": {
"title": "Data match state",
"type": "string",
"description": "We currently check document number, date of expiry, date of birth and date of issue fields.",
"enum": [
"NOT_PERFORMED",
"FAILED",
"SUCCESS"
]
},
"Date": {
"type": "object",
"properties": {
"day": {
"type": "integer",
"description": "Day in month",
"format": "int32",
"nullable": true
},
"month": {
"type": "integer",
"description": "Month in year",
"format": "int32",
"nullable": true
},
"year": {
"type": "integer",
"description": "Year",
"format": "int32",
"nullable": true
},
"successfullyParsed": {
"type": "boolean",
"description": "True if date was successfully parsed",
"nullable": true
},
"filledByDomainKnowledge": {
"type": "boolean",
"description": "True if date was filled by domain knowledge",
"nullable": true
},
"originalString": {
"type": "string",
"description": "String used in date parsing",
"nullable": true
}
}
},
"DateResult": {
"type": "object",
"properties": {
"day": {
"type": "integer",
"description": "Day in month",
"format": "int32",
"nullable": true
},
"month": {
"type": "integer",
"description": "Month in year",
"format": "int32",
"nullable": true
},
"year": {
"type": "integer",
"description": "Year",
"format": "int32",
"nullable": true
},
"successfullyParsed": {
"type": "boolean",
"description": "True if date was successfully parsed",
"nullable": true
},
"filledByDomainKnowledge": {
"type": "boolean",
"description": "True if date was filled by domain knowledge",
"nullable": true
},
"originalString": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "String used in date parsing"
}
]
}
}
},
"DefaultResponse": {
"required": [
"executionId"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Exception message",
"nullable": true
},
"traceId": {
"type": "string",
"description": "Provided identifier",
"nullable": true
},
"executionId": {
"type": "string",
"description": "Unique execution identifier"
}
},
"description": "Response type for exceptions."
},
"DependentInfo": {
"type": "object",
"properties": {
"dateOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The date of birth of the dependent."
}
]
},
"sex": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The sex or gender of the dependent."
}
]
},
"documentNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The document number of the dependent."
}
]
},
"fullName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The full name of the dependent."
}
]
}
},
"description": " The dependents info."
},
"DetailedCroppedImageResult": {
"required": [
"image"
],
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "The cropped image."
},
"location": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/RectangleF"
},
{
"description": "Location of the image. Coordinates are relative to the dewarped image."
}
]
},
"side": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ScanningSide"
},
{
"description": "The side of the document where the cropped image was taken."
}
]
}
},
"description": "The result of the cropped image transformation with additional details."
},
"DetailedFieldType": {
"type": "object",
"properties": {
"fieldType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/FieldType"
},
{
"description": "Field type"
}
]
},
"alphabetType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/AlphabetType"
},
{
"description": "Alphabet type"
}
]
}
}
},
"DetectionPoints": {
"type": "object",
"properties": {
"points": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/Points"
}
}
},
"description": "Points array with coordinates of barcode detection."
},
"Dimensions": {
"type": "object",
"properties": {
"width": {
"type": "number",
"format": "float",
"nullable": true
},
"height": {
"type": "number",
"format": "float",
"nullable": true
}
}
},
"DocumentAnonymizationSettings": {
"required": [
"fields"
],
"type": "object",
"properties": {
"documentFilter": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentFilter"
},
{
"description": "Specified fields will be anonymized if filter conditions are met."
}
]
},
"fields": {
"type": "array",
"description": "Fields to be anonymized.",
"items": {
"$ref": "#/components/schemas/FieldType"
}
},
"documentNumberAnonymizationSettings": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentNumberAnonymizationSettings"
},
{
"description": "If set, document number will be partially anonymized. Otherwise, document number anonymization settings will not be taken into account during anonymization."
}
]
}
},
"description": "Redact fields for specific document class. Fields specified by requirements or laws for a specific document will be redacted regardless of this setting. Based on anonymizationMode setting, data will be redacted from the image, the result or both."
},
"DocumentClassInfo": {
"type": "object",
"properties": {
"country": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Country"
}
]
},
"region": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Region"
}
]
},
"type": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Type"
}
]
},
"countryName": {
"type": "string",
"description": "The name of the country that issued the scanned document.",
"nullable": true
},
"isoAlpha3CountryCode": {
"type": "string",
"description": "The 3 letter ISO code of the country that issued the scanned document.",
"nullable": true
},
"isoAlpha2CountryCode": {
"type": "string",
"description": "The 2 letter ISO code of the country that issued the scanned document.",
"nullable": true
},
"isoNumericCountryCode": {
"type": "string",
"description": "The ISO numeric code of the country that issued the scanned document.",
"nullable": true
}
},
"description": "The document class information."
},
"DocumentFilter": {
"type": "object",
"properties": {
"country": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Country"
},
{
"description": "If set, specified fields will be anonymized on documents issued by specified country only.Otherwise, issuing country will not be taken into account during anonymization."
}
]
},
"region": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Region"
},
{
"description": "If set, specified fields will be anonymized on documents issued by specified region only. Otherwise, issuing region will not be taken into account during anonymization."
}
]
},
"type": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Type"
},
{
"description": "If set, specified fields will be anonymized on documents issued by specified type only. Otherwise, document type will not be taken into account during anonymization."
}
]
}
},
"description": "Specified fields will be anonymized if filter conditions are met."
},
"DocumentImageColorStatus": {
"title": "Document image color status",
"type": "string",
"description": "The color status determined from scanned image.",
"enum": [
"NOT_AVAILABLE",
"BLACK_AND_WHITE",
"COLOR"
]
},
"DocumentNumberAnonymizationSettings": {
"type": "object",
"properties": {
"prefixDigitsVisible": {
"type": "integer",
"description": "Defines how many digits at the beginning of the document number remain visible after anonymization.",
"format": "int32",
"nullable": true
},
"suffixDigitsVisible": {
"type": "integer",
"description": " Defines how many digits at the end of the document number remain visible after anonymization.",
"format": "int32",
"nullable": true
}
}
},
"DocumentOrientation": {
"title": "Card orientation",
"type": "string",
"description": "Orientation determined from the scanned image.",
"enum": [
"HORIZONTAL",
"VERTICAL",
"NOT_AVAILABLE"
]
},
"DocumentRotation": {
"title": "Card rotation",
"type": "string",
"description": "Rotation determined from the scanned image.",
"enum": [
"NOT_AVAILABLE",
"ZERO",
"CLOCKWISE_90",
"COUNTER_CLOCKWISE_90",
"UPSIDE_DOWN"
]
},
"DocumentRules": {
"type": "object",
"properties": {
"documentFilter": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentFilter"
},
{
"description": "Specified fields will overrule our class field rules if filter conditions are met."
}
]
},
"fields": {
"type": "array",
"description": "Fields to overrule our class field rules.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DetailedFieldType"
}
}
},
"description": "Define custom rules for specific document class.\nThe new class rules will be a combination of our internal and user-defined rules.\nThe more detailed class filter will have priority over the other."
},
"DriverLicenseDetailedInfo": {
"type": "object",
"properties": {
"restrictions": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The restrictions to driving privileges for the United States driver license owner."
}
]
},
"endorsements": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional privileges granted to the United States driver license owner."
}
]
},
"vehicleClass": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The type of vehicle the driver license owner has privilege to drive."
}
]
},
"conditions": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The driver license conditions."
}
]
},
"vehicleClassesInfo": {
"type": "array",
"description": "The additional information on vehicle class.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/VehicleClassInfo"
}
}
},
"description": "The driver license detailed info."
},
"FieldType": {
"type": "string",
"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",
"EFFECTIVE_DATE",
"PARENTS_LAST_NAME",
"WORK_RESTRICTION",
"PARENTS_FIRST_NAME",
"SOCIAL_SECURITY_STATUS",
"LEGAL_STATUS",
"HUSBAND_NAME",
"CARD_ACCESS_NUMBER"
]
},
"HealthCheckType": {
"type": "string",
"enum": [
"LIVENESS",
"READINESS"
]
},
"HealthResult": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/HealthStatus"
},
"details": {}
}
},
"HealthStatus": {
"required": [
"description",
"name",
"operational",
"severity"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"operational": {
"type": "boolean",
"nullable": true
},
"severity": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
},
"ImageAnalysisDetectionStatus": {
"title": "Image analysis detection status",
"type": "string",
"description": "Detection status determined from the scanned image.",
"enum": [
"NOT_AVAILABLE",
"NOT_DETECTED",
"DETECTED"
]
},
"ImageAnalysisLightingStatus": {
"title": "Image analysis lighting status",
"type": "string",
"description": "Lighting status determined from the scanned image.",
"enum": [
"NOT_AVAILABLE",
"TOO_BRIGHT",
"TOO_DARK",
"NORMAL"
]
},
"ImageAnalysisResult": {
"type": "object",
"properties": {
"blurDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"glareDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"documentImageColorStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentImageColorStatus"
}
]
},
"documentImageMoireStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"faceDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"mrzDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"barcodeDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"documentOrientation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentOrientation"
}
]
},
"documentRotation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DocumentRotation"
}
]
},
"realIDDetectionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"documentHandOcclusionStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisDetectionStatus"
}
]
},
"documentLightingStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ImageAnalysisLightingStatus"
}
]
}
},
"description": "Various information obtained by analysing the scanned image."
},
"ImageExtractionType": {
"type": "string",
"enum": [
"FULL_DOCUMENT",
"FACE",
"SIGNATURE"
]
},
"ImageFormat": {
"title": "Image Format",
"type": "string",
"enum": [
"JPG",
"PNG",
"QOI"
]
},
"ImageSource": {
"type": "object",
"properties": {
"imageUrl": {
"type": "string",
"description": "Url string of the image.",
"nullable": true
},
"imageBase64": {
"type": "string",
"description": "Base64 string of the image.",
"nullable": true
}
},
"description": "Url or base64 string of the image. The Base64 image takes precedence if url and base64 are defined."
},
"LocationInfo": {
"type": "object",
"properties": {
"topLeftCorner": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Point2df"
}
]
},
"dimensions": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Dimensions"
}
]
},
"side": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ScanningSide"
}
]
}
}
},
"MicroblinkEndpointRequest": {
"type": "object"
},
"MrtdDocumentType": {
"title": "Mrtd document type",
"type": "string",
"description": "Possible types of Machine Readable Travel Documents (MRTDs).",
"enum": [
"UNKNOWN",
"IDENTITY_CARD",
"PASSPORT",
"VISA",
"GREEN_CARD",
"MALAYSIAN_PASS_IMM13P",
"DRIVER_LICENSE",
"INTERNATIONAL_TRAVEL_DOCUMENT",
"BORDER_CROSSING_CARD"
]
},
"MrzResult": {
"type": "object",
"properties": {
"rawMrzString": {
"type": "string",
"description": "The entire Machine Readable Zone text from ID. This string is usually used for parsing other elements.\n NOTE: This string is available only if OCR result was parsed successfully.",
"nullable": true
},
"documentCode": {
"type": "string",
"description": "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 <.",
"nullable": true
},
"issuer": {
"type": "string",
"description": "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.",
"nullable": true
},
"documentNumber": {
"type": "string",
"description": "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.",
"nullable": true
},
"opt1": {
"type": "string",
"description": "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.",
"nullable": true
},
"opt2": {
"type": "string",
"description": "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.",
"nullable": true
},
"gender": {
"type": "string",
"description": "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.",
"nullable": true
},
"nationality": {
"type": "string",
"description": "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.",
"nullable": true
},
"primaryId": {
"type": "string",
"description": "The primary indentifier. If there is more than one component, they are separated with space.",
"nullable": true
},
"secondaryId": {
"type": "string",
"description": "The secondary identifier. If there is more than one component, they are separated with space.",
"nullable": true
},
"verified": {
"type": "boolean",
"description": "True if all check digits inside MRZ are correct, false otherwise.",
"nullable": true
},
"dateOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
}
]
},
"dateOfExpiry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Date"
}
]
},
"documentType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/MrtdDocumentType"
}
]
},
"issuerName": {
"type": "string",
"description": "Returns full issuer name that is expanded from the three-letter or two-letter code which indicate the issuing State.",
"nullable": true
},
"nationalityName": {
"type": "string",
"description": "Returns full nationality of the holder, which is expanded from the three-letter or two-letter nationality code.",
"nullable": true
}
},
"description": "The data extracted from the machine readable zone."
},
"ParentInfo": {
"type": "object",
"properties": {
"firstName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The first name of one of the document owner's parents."
}
]
},
"lastName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The last name of one of the document owner's parents."
}
]
}
},
"description": "Information on one of the document owner's parents."
},
"Point2df": {
"type": "object",
"properties": {
"x": {
"type": "number",
"format": "float",
"nullable": true
},
"y": {
"type": "number",
"format": "float",
"nullable": true
}
}
},
"Points": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"description": "X coordinate of a point.",
"format": "int32",
"nullable": true
},
"y": {
"type": "integer",
"description": "Y coordinate of a point.",
"format": "int32",
"nullable": true
}
}
},
"ProcessingStatus": {
"title": "Processing status",
"type": "string",
"description": "Detailed information about the recognition process.",
"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"
]
},
"RecognitionMode": {
"title": "Recognition mode",
"type": "string",
"description": "Recognition mode used to scan current document.",
"enum": [
"NONE",
"MRZ_ID",
"MRZ_VISA",
"MRZ_PASSPORT",
"PHOTO_ID",
"FULL_RECOGNITION",
"BARCODE_ID"
]
},
"RectangleF": {
"type": "object",
"properties": {
"topLeftCorner": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Point2df"
}
]
},
"dimensions": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/Dimensions"
}
]
}
}
},
"Region": {
"title": "Region",
"type": "string",
"description": "Document 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",
"REGION_ACRE",
"REGION_ESPIRITO_SANTO",
"REGION_MATO_GROSSO_DO_SUL",
"REGION_PARAIBA",
"REGION_PIAUI",
"REGION_RIO_GRANDE_DO_NORTE",
"REGION_TOCANTINS",
"REGION_ODISHA",
"REGION_UTTARAKHAND"
]
},
"ResultState": {
"title": "Result state",
"type": "string",
"description": "Possible states of the Recognizer's result.",
"enum": [
"EMPTY",
"UNCERTAIN",
"VALID",
"STAGE_VALID"
]
},
"ScanningSide": {
"title": "Scanning side",
"type": "string",
"description": "Represents the sides of the document that can be scanned.",
"enum": [
"FIRST",
"SECOND"
]
},
"StrictnessLevel": {
"type": "string",
"enum": [
"DISABLED",
"LEVEL1",
"LEVEL2",
"LEVEL3",
"LEVEL4",
"LEVEL5",
"LEVEL6",
"LEVEL7",
"LEVEL8",
"LEVEL9",
"LEVEL10"
]
},
"StringResult": {
"type": "object",
"properties": {
"latin": {
"type": "string",
"description": "The result of recognition in latin.",
"nullable": true
},
"latinLocation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/LocationInfo"
},
{
"description": "The location latin recognition."
}
]
},
"cyrillic": {
"type": "string",
"description": "The result of recognition in cyrillic.",
"nullable": true
},
"cyrillicLocation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/LocationInfo"
},
{
"description": "The location cyrillic recognition."
}
]
},
"arabic": {
"type": "string",
"description": "The result of recognition in arabic.",
"nullable": true
},
"arabicLocation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/LocationInfo"
},
{
"description": "The location arabic recognition."
}
]
},
"greek": {
"type": "string",
"description": "The result of recognition in greek.",
"nullable": true
},
"greekLocation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/LocationInfo"
},
{
"description": "The location greek recognition."
}
]
}
}
},
"Type": {
"title": "Type",
"type": "string",
"description": "Document 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",
"TYPE_NIN_CARD",
"TYPE_MYSSS_CARD",
"TYPE_GENDARMERIE_ID",
"TYPE_POLICE_ID",
"TYPE_ORIGIN_CARD"
]
},
"VIZResult": {
"type": "object",
"properties": {
"firstName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The first name of the document owner."
}
]
},
"lastName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The last name of the document owner."
}
]
},
"fullName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The full name of the document owner."
}
]
},
"documentSubtype": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The transcription of the document subtype."
}
]
},
"remarks": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The remarks on the residence permit."
}
]
},
"residencePermitType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The residence permit type."
}
]
},
"manufacturingYear": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The manufacturing year."
}
]
},
"vehicleType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": " The vehicle type."
}
]
},
"eligibilityCategory": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The eligibility category."
}
]
},
"specificDocumentValidity": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The specific document validity."
}
]
},
"dependentsInfo": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/DependentInfo"
}
},
"parentsInfo": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ParentInfo"
}
},
"vehicleOwner": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The vehicle owner."
}
]
},
"certificateNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The vehicle owner."
}
]
},
"countryCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The certificate number of the document owner."
}
]
},
"nationalInsuranceNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The country code of the document owner."
}
]
},
"additionalNameInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional name information number of the document owner."
}
]
},
"localizedName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The localized name of the document."
}
]
},
"address": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The address of the document owner."
}
]
},
"additionalAddressInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional address information of the document owner."
}
]
},
"additionalOptionalAddressInformation": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The one more additional address information of the document owner."
}
]
},
"placeOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The place of birth of the document owner."
}
]
},
"nationality": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The nationality of the documet owner."
}
]
},
"race": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The race of the document owner."
}
]
},
"religion": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The religion of the document owner."
}
]
},
"profession": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The profession of the document owner."
}
]
},
"maritalStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The marital status of the document owner."
}
]
},
"residentialStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The residential stauts of the document owner."
}
]
},
"employer": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The employer of the document owner."
}
]
},
"sex": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The sex of the document owner."
}
]
},
"dateOfBirth": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"dateOfIssue": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"dateOfExpiry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
}
]
},
"dateOfExpiryPermanent": {
"type": "boolean",
"description": "Determines if date of expiry is permanent.",
"nullable": true
},
"documentNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The document number."
}
]
},
"personalIdNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The personal identification number."
}
]
},
"documentAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional number of the document."
}
]
},
"additionalPersonalIdNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The additional personal identification number."
}
]
},
"documentOptionalAdditionalNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The one more additional number of the document."
}
]
},
"issuingAuthority": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The issuing authority of the document."
}
]
},
"fathersName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The fathers name of the document owner."
}
]
},
"mothersName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The mothers name of the document owner."
}
]
},
"dateOfEntry": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The date of entry."
}
]
},
"effectiveDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The effective date."
}
]
},
"localityCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The locality code."
}
]
},
"maidenName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The maiden name of the document owner."
}
]
},
"municipalityCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The municipality code."
}
]
},
"municipalityOfRegistration": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The municipality of registration."
}
]
},
"pollingStationCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The polling station code."
}
]
},
"registrationCenterCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The registration center code."
}
]
},
"sectionCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The section code."
}
]
},
"stateCode": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The state code."
}
]
},
"stateName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The state name."
}
]
},
"driverLicenseDetailedInfo": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DriverLicenseDetailedInfo"
}
]
},
"bloodType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The blood type of the document owner."
}
]
},
"sponsor": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The sponsor of the document owner."
}
]
},
"visaType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "Visa type of the document."
}
]
},
"husbandName": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The husband name of the document owner."
}
]
},
"legalStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The legal status of the document owner."
}
]
},
"socialSecurityStatus": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The social security status of the document owner."
}
]
},
"workRestriction": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The work restriction of the document owner."
}
]
},
"cardAccessNumber": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "Numeric code used to establish secure electronic access to the embedded contactless chip. "
}
]
}
},
"description": "The data extracted from the visual inspection zone."
},
"VehicleClassInfo": {
"type": "object",
"properties": {
"vehicleClass": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The type of vehicle the driver license owner has privilege to drive."
}
]
},
"licenceType": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/StringResult"
},
{
"description": "The type of driver licence."
}
]
},
"effectiveDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The date since licence is effective"
}
]
},
"expiryDate": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/DateResult"
},
{
"description": "The date of expiry of licence."
}
]
}
},
"description": "The additional information on vehicle class."
}
}
}
}