ENЗапросить демонстрацию

Справочник API

Ручной разбор

Очередь разбора, экспертиза документов и решения сотрудников.

Задачи разбора

GET/v1/review-tasks

Области доступа
review:read

Filters combine with AND. A cursor is bound to the filter it was issued for; another filter with that cursor is 400. Invalid filter value is 400 schema_validation_failed.

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет
case_idзапросOnly tasks of this case.string (uuid)нет
statusзапросOnly tasks in this status (lease expiry applied).enum: open, claimed, resolved, expiredнет
assignmentзапросassigned: claimed by anyone; unassigned: open; mine: claimed by the calling identity.enum: assigned, unassigned, mineнет
assigned_principal_idзапросOnly tasks claimed by this principal.string (uuid)нет

Ответы

  • 200ReviewTaskList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Взять задачу в работу

POST/v1/review-tasks/{task_id}/claim

Области доступа
review:claim
Обязательный заголовок
Idempotency-Key
Обязательный заголовок
If-Match

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да

Ответы

  • 200ReviewTask
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Завершить разбор

POST/v1/review-tasks/{task_id}/resolve

Области доступа
review:resolve
Обязательный заголовок
Idempotency-Key
Обязательный заголовок
If-Match

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да

Тело запросаReviewResolve

ПолеТипОбязательно
resolutionenum: approve, reject, request_evidence, inconclusiveда
reason_codesarray of stringда
evidence_idsarray of string (uuid)да
notestringда
kyb_conflict_decisionsarray of KybConflictDecisionнет
approval_idstring (uuid)нет
resolution_payload_sha256stringнет

Ответы

  • 200ReviewTask
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Оценки экспертов

GET/v1/review-tasks/{task_id}/expert-records

Области доступа
review:read

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да

Ответы

  • 200ExpertRecordList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Записать оценку эксперта

POST/v1/review-tasks/{task_id}/expert-records

Области доступа
review:expert
Обязательный заголовок
Idempotency-Key

Document expert interface: a signed correction or assessment of a check of the task case. Two disagreeing expert assessments escalate the check to a senior expert. Scope review:expert: roles owner, reviewer, document_expert, senior_document_expert.

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да

Тело запросаExpertRecordCreate

ПолеТипОбязательно
kindenum: correction, assessmentда
check_idstring (uuid)да
reason_codestringда
proposed_outcomeenum: pass, fail, inconclusive, not_supported, unavailable, not_performedнет
fieldstringнет
sourceobjectнет
new_valueCorrected value; stored sealed with the subject key, never returned, recorded in the expert record only as a digest.stringнет

Ответы

  • 201ExpertRecord
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Оценка старшего эксперта

POST/v1/review-tasks/{task_id}/senior-assessments

Области доступа
review:senior
Обязательный заголовок
Idempotency-Key

Senior document expert assessment of an escalated check. The senior expert is not one of the disagreeing experts.

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да

Тело запросаSeniorAssessmentCreate

ПолеТипОбязательно
check_idstring (uuid)да
proposed_outcomeenum: pass, fail, inconclusive, not_supported, unavailable, not_performedда
reason_codeenum: fields_consistent, layout_mismatch, security_feature_doubtful, needs_original_documentда

Ответы

  • 201ExpertRecord
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Очередь экспертизы

GET/v1/expert-queue

Области доступа
review:expert

Queue of document checks for expert review: latest succeeded checks of the document family (document_*, nfc_*) of cases with an open or claimed review task, with the expert review status of each check; needs_review=true keeps checks whose outcome is not pass or that already have expert records. No applicant, case or screening data is returned.

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет
statusзапросOnly checks in this expert review status.enum: open, agreed, escalated_to_senior, resolved_by_seniorнет
case_idзапросOnly checks of this case.string (uuid)нет
needs_reviewзапросtrue: only checks with an outcome other than pass or with expert records.booleanнет

Ответы

  • 200ExpertQueue
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Материалы для экспертизы

GET/v1/review-tasks/{task_id}/expert-material

Области доступа
review:expert

Material of one document check for the expert: the check, its source and derived evidence (metadata only), observed fields with their visibility class, conflicting values of other sources, the expert review state and the history of records with original and new values. Values are exposed by the masking profile of the caller: full with evidence:download, otherwise expert_masked (personal identifiers and address masked); a field outside the attribute list of the check is never shown.

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да
check_idзапросDocument check of the task case.string (uuid)да

Ответы

  • 200ExpertMaterial
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Просмотр материала экспертизы

GET/v1/review-tasks/{task_id}/expert-material/evidence/{evidence_id}/preview

Области доступа
review:expert

Backend masked low resolution projection of a source or derived image of the check for the expert (same projection as previewEvidence); only evidence of this check or derived from it.

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да
evidence_idпутьstring (uuid)да
check_idзапросDocument check of the task case.string (uuid)да

Ответы

  • 200EvidencePreview
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Раскрыть оригинал материала

POST/v1/review-tasks/{task_id}/expert-material/evidence/{evidence_id}/reveal

Области доступа
review:expert
Обязательный заголовок
Idempotency-Key

Reveal of the original image of the check to the expert while the review task is open or claimed: a short-lived signed link with a required reason (EvidenceReveal); only evidence of this check or derived from it. The audit event records the reason, the review task and the digest.

Параметры

ПолеТипОбязательно
task_idпутьstring (uuid)да
evidence_idпутьstring (uuid)да
check_idзапросDocument check of the task case.string (uuid)да

Тело запросаEvidenceReveal

ПолеТипОбязательно
reason_codeenum: case_review, appeal_review, quality_assurance, customer_support, legal_obligationда

Ответы

  • 200Download
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503