/
v3.0.11Get access

fastRegRecognizeImage

Executes an optical character recognition pipeline on a provided image file, It identifies document fields specific to fast registration forms and returns a structured data object containing the extracted information

Request parameters:

Name
DescriptionTypeValuesDefault
fileName
The original name of the file (e.g., passport_photo.jpg). Used for logging and internal tracking.string--
imageData
The Base64-encoded string of the image. This is the raw data the optical character recognition engine will process.string--
fileFormat
Format/type of the uploaded file(e.g., 'jpg', 'png', or 'pdf').string--
documentType
Type of document being processedstring--
country
ISO‑3166 alpha‑2 country code (e.g., "AM" for Armenia), used to apply region-specific extraction rulesstring--
fragment
Specifies which side of the document is being sent (e.g., "FrontSide").string--

Parameters marked with must be included in the request

Call example:

fastRegRecognizeImage({
  fileName: 'passport_photo.jpg',
  imageData: 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE...',
  fileFormat: 1,
  documentType: 1,
  country: 'AM',
  fragment: 'FrontSide'
})

Response examples:

{
  code: 0,
  rid: '16246004277416',
  data: {
    document_type: 'ID',
    issuing_country: 'FR',
    surname: 'ERRAES',
    issuance_department: '88',
    issuance_office: '074',
    issuance_date: '2008-12',
    issuance_department_2: '883',
    management_center_id: '00714',
    hash_1: '8',
    first_name: 'JULIEN',
    birth_date: '1989-05-05',
    hash_2: '3',
    gender: 'M',
    hash_3: '0',
    id: '15ff6ff5-652a-49b2-94dd-ba03fa11f09c'
  }
}

Response parameters:

NameDescriptionTypeValues
document_type
The category of the recognized document (e.g., 'ID', 'Passport').string-
issuing_country
The ISO 3166-1 alpha-2 code of the country that issued the documentstring-
surname
The primary family name or last name of the document holder.string-
first_name
The given name(s) of the document holder.string-
birth_date
The holder's date of birth, formatted as YYYY-MM-DD.string-
gender
The gender of the holder (e.g., 'M', 'F', or 'X')string-
issuance_date
The date the document was issued (Note: may follow YYYY-MM format depending on document type).string-
issuance_department
The administrative code of the department where the document was issuedstring-
issuance_department_2
A supplemental administrative or sub-departmental code.string-
issuance_office
Internal code for the specific office/prefecture that processed the application.string-
management_center_id
A unique identifier for the administrative center managing the document record.string-
hash_1
Checksum values extracted from the Machine Readable Zone (MRZ) used to verify data integrity.string-
hash_2
Checksum values extracted from the Machine Readable Zone (MRZ) used to verify data integrity.string-
hash_3
Checksum values extracted from the Machine Readable Zone (MRZ) used to verify data integrity.string-
id
A unique ID (transaction ID) generated for this specific recognition event.string-