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

Captures

Document images in Base64

extractedData

ExtractedData

Extracted values from document

🖼 Captures

Field

Type

Description

front

String?

Base64 front image

back

String?

Base64 back image

🧾 ExtractedData

Not all fields are always returned — it depends on document type & scan quality.

Field

Type

Description

name

String?

First name

surname

String?

Last name

passportNumber

String?

Passport number

dateOfBirth

String?

Date of birth

nationality

String?

Nationality

sex

String?

Gender (M/F)

expiryDate

String?

Document expiry

issueDate

String?

Issue date

nationalId

String?

National ID number

religion

String?

Religion

profession

String?

Job title

maritalStatus

String?

Marital status

husbandName

String?

Husband’s name

street

String?

Address

policeStation

String?

Police station

age

String?

Age

governorate

String?

Governorate

releaseDate

String?

Release date

serialNumber

String?

Serial number

type

String?

Document type

validity

Int?

Validity percentage

Fields are document-specific. Some are only available for Egyptian IDs or Passports.

Last updated