SDK Response

🔁 VIDVDocKitResponse Types

Type

Description

Success(data)

SDK finished successfully

BuilderError(code, message)

Error in configuration setup

ServiceFailure(code, message, data)

OCR failed or invalid result

Exit(step, data)

User exited early

📦 VIDVDocKitData

Field

Type

Description

sessionID

String

Unique session ID

deviceID

String

Device identifier

captures

Map<String,String?>

Document images in Base64

extractedData

Map<String,String?>

Extracted values from document

🖼 Captures

Egyptian National ID

Field

Type

Description

egy_front_nid

String

Base64 front image

egy_back_nid

String

Base64 back image

MRZ Passport

Field

Type

Description

egy_passport

String

Base64 front image

Tunisian National ID

Field

Type

Description

tunisian_front_nid

String

Base64 front image

tunisian_back_nid

String

Base64 back image

Algerian National ID

Field

Type

Description

algerian_front_nid

String

Base64 front image

algerian_back_nid

String

Base64 back image

🧾ExtractedData

extractedDataMap<String,String?> (Egyptian National ID)
  • nid <string>

  • first_name <string>

  • full_name <string>

  • street <string>

  • front_nid <string>

  • serial_number <string>

  • back_nid <string>

  • release_date <string>

  • gender <string>

  • marital_status <string>

  • profession<string>

  • religion <string>

  • husband_name <string>

  • date_of_birth <string>

  • age <string>

  • birth_governorate <string>

  • gender <string>

  • police_station <string>

  • governorate<string>

  • expiry_date <string>

extractedData Map<String,String?> (MRZ Passport)
  • name <string>

  • surname <string>

  • date_of_birth <string>

  • nationality <string>

  • passport_number <string>

  • sex <string>

  • expiration_date <string>

extractedData Map<String,String?> (Tunisian National ID)
  • nid <string>

  • first_name <string>

  • last_name <string>

  • father_name <string>

  • husband_name <string>

  • birthdate <string>

  • birthplace <string>

  • mother_name <string>

  • profession <string>

  • address <string>

  • issue_date<string>

  • thumbprint_code <string>

extractedData Map<String,String?> (Algerian National ID)
  • nid <string>

  • first_name <string>

  • surname <string>

  • date_of_birth <string>

  • place_of_birth <string>

  • blood_type <string>

  • gender<string>

  • issuance_date<string>

  • serial_no<string>

  • issuing_authority<string>

  • expiration_date <string>

Last updated