E-Document¶

The overview describes the common field interpretation rules, failure reasons, and full/light file formats.

Parent: edocument_result. Retrieved electronic document and supporting information.

Fields of edocument_result.

Fields marked “Required” are always present within this object. Other fields are included when a value is available; null is excluded from the response.

Field	JSON type	Purpose and conditions
`status`	string, enum	Required: `NOT_RECEIVED` — not received; `PENDING` — pending; `RECEIVED` — received; `CANCELED` — retrieval canceled; `COPIED` — previous result reused.
`document_type`	string, enum	Required. Electronic document type, with values listed below; differs from type designations in input parameters.
`result_json`	JSON	Document data from the government service. Dynamic JSON that depends on the document type.
`face_photo`	string	Face photo; only when a file is available.
`barcode`	string	Barcode image; only when a file is available.
`qrcode`	string	QR code image; only when a file is available.
`document_image`	string	Document image; only when a file is available.
`document_pdf`	string	Document PDF; only when a file is available.
`is_subject_in_mcdb`	boolean	Whether the user was found in the Mobile Citizens Database (MCDB), if the check produced a value.
`phone`	string	User's phone number, if stored; may be an empty string. No uniform format is validated here.
`source_session`	string, UUID	Source session when data is reused.
`gender`	string	Derived from the 7th digit of the owner's IIN in `result_json.common.docOwner.iin`: `male` — odd 1/3/5, `female` — even 2/4/6, `foreigner` — 0, `error` — a digit greater than 6. If the source IIN is absent, the field is absent. This is the result of decoding the IIN, not a face model estimate.
`extra`	object	Required; may be `{}`. Additional dates in a normalized format.
`result`	boolean	Stored technology result: `true` means accepted, `false` means a negative result. May be absent before calculation; consider the status and the details below.
`failure_reason`	object	Failure reason, if recorded; see the structure.

The five file fields contain Base64 in the full response and URLs in light. A document does not have to contain all files at once.

Parent: edocument_result.extra or edocument_child_result.extra.

Fields marked “Required” are always present within this object. Other fields are included when a value is available; null is excluded from the response.

Field	JSON type	Purpose and conditions
`date_of_birth`	string, date	Date of birth, `YYYY-MM-DD`, if extracted.
`date_of_issue`	string, date	Issue date, `YYYY-MM-DD`, if extracted.
`date_of_expire`	string, date	Expiration date, `YYYY-MM-DD`, if extracted. Note the name `expire`, not `expiry`.

extra is generated from document timestamps expressed in Unix milliseconds. The API returns converted calendar dates; do not interpret these strings as the original timestamps. The common, domain, and other sections of result_json do not become required merely because individual values are extracted from them.

Values of edocument_result.document_type and edocument_child_result.document_type.

These are result model values, not a guarantee that every document is available in every Workflow.

Field	JSON type	Purpose and conditions
`IdentityCard`	string	identity card
`DriverLicense`	string	driver's license
`BirthCertificate`	string	birth certificate
`MarriageCertificate`	string	marriage certificate
`ChangeFioCertificate`	string	name change certificate
`DivorceCertificate`	string	divorce certificate
`Diploma`	string	diploma
`SRTS`	string	vehicle registration certificate
`Vaccination`	string	vaccination document
`SocialId`	string	social ID
`DisabilityCertificate`	string	disability certificate
`LargeFamilyCertificate`	string	large family document
`AspCertificate`	string	targeted social assistance certificate
`TechPassport`	string	technical passport
`Pension`	string	pension document
`Passport`	string	passport
`StudentCard`	string	student ID
`Vnzh`	string	residence permit
`PcrCertificate`	string	PCR certificate
`LbgCard`	string	stateless person's ID
`InsurancePolicy`	string	insurance policy
`Hunter`	string	hunter's ID
`Oralman`	string	oralman / kandas ID
`Attorney`	string	Attorney-type document; the exact category is not specified by the local code
`SchoolCard`	string	school document
`CollegeDiploma`	string	college diploma
`Voucher`	string	Voucher-type document; the exact purpose is not specified by the local code
`ChildIdentityCard`	string	child's identity card
`ChildBirthCertificate`	string	child's birth certificate
`ChildPassport`	string	child's passport
`ChildSchoolCard`	string	child's school document

Child E-Document¶

Parent: edocument_child_result. The child technology result is selected separately; the structure of all fields and the extra object matches E-Document.

In this block, both endpoints return Base64 in face_photo, barcode, qrcode, document_image, and document_pdf. Light does not replace them with URLs. Presence conditions, null exclusion, statuses, and document type enums are the same as in the E-Document tables. The regular and child blocks may be present simultaneously.

JSON examples¶

Fragments of the root response object, not complete responses. All values and URLs are illustrative. File formats follow the explanations on this page.

{
  "edocument_result": {
    "status": "COPIED",
    "document_type": "IdentityCard",
    "result": true,
    "source_session": "44444444-4444-4444-8444-444444444444",
    "extra": {
      "date_of_birth": "1990-01-01",
      "date_of_issue": "2025-01-01",
      "date_of_expire": "2035-01-01"
    }
  }
}

{
  "edocument_child_result": {
    "status": "PENDING",
    "document_type": "ChildBirthCertificate",
    "extra": {}
  }
}