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

tun_front_nid

String

Base64 front image

tun_back_nid

String

Base64 back image

🧾ExtractedData

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

  • firstName <string>

  • fullName <string>

  • street <string>

  • frontNid <string>

  • serialNumber <string>

  • backNid <string>

  • releaseDate <string>

  • gender <string>

  • maritalStatus <string>

  • profession<string>

  • religion <string>

  • husbandName <string>

  • dateOfBirth <string>

  • age <string>

  • birthGovernorate <string>

  • gender <string>

  • policeStation <string>

  • governorate<string>

  • expiryDate <string>

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

  • surname <string>

  • dateOfBirth <string>

  • nationality <string>

  • passportNumber <string>

  • sex <string>

  • expirationDate <string>

  • type <string>

  • validity <int>

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

  • firstName <string>

  • lastName <string>

  • fatherName <string>

  • husbandName <string>

  • birthdate <string>

  • birthplace <string>

  • motherName <string>

  • profession <string>

  • address <string>

  • issueDate<string>

  • thumbprintCode <string>

Last updated