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

Справочник API

Дела

Проверка заявителя: создание, отправка, сессии, ссылки, проверки, граф владения, отчеты и решения.

Список дел

GET/v1/cases

Области доступа
cases: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нет
stateзапросOnly cases in this state.enum: created, collecting, submitted, processing, action_required, manual_review, approved, rejected, ...нет
applicant_typeзапросOnly cases of applicants of this type.enum: person, companyнет
countryзапросOnly cases whose country_context.document_issuer_country or customer_jurisdiction equals this code.stringнет
referenceзапросOnly cases of the applicant with this external_id (exact match).stringнет
created_fromзапросCreated at or after this time.string (date-time)нет
created_toзапросCreated before this time.string (date-time)нет

Ответы

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

Создать дело

POST/v1/cases

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

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

ПолеТипОбязательно
applicant_idstring (uuid)да
purposestringда
policy_version_idstring (uuid)да
country_contextCountryContextда
parent_case_idstring (uuid)нет
related_party_processing_context_idApproved processing context for related person cases of this company case: purpose and region of the company case, published policy without company checks. Related cases (invitations and createRelatedPartyCase) are created in it; without it they are refused. Allowed only for a company applicant.string (uuid)нет
metadataMetadataнет
processing_context_idstring (uuid)да

Ответы

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

Коды ошибокconfiguration_error

Получить дело

GET/v1/cases/{case_id}

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

Параметры

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

Ответы

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

Отправить дело на проверку

POST/v1/cases/{case_id}/submit

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

Параметры

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

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

ПолеТипОбязательно
evidence_idsarray of string (uuid)да
consent_record_idsarray of string (uuid)да
graph_versionintegerнет
input_manifest_sha256stringда
basis_record_idstring (uuid)да

Ответы

  • 202Case
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Отменить дело

POST/v1/cases/{case_id}/cancel

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

Параметры

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

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

ПолеТипОбязательно
reason_codestringда
notestringнет

Ответы

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

Сессии дела

GET/v1/cases/{case_id}/sessions

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

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Создать сессию заявителя

POST/v1/cases/{case_id}/sessions

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

Параметры

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

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

ПолеТипОбязательно
channelenum: hosted, iframe, native_ios, native_androidда
localestringда
allowed_originstring (uri)нет
return_urlstring (uri)нет
broker_client_idTenant broker credential (BrokerBearer of kind tenant_broker with sessions:renew in the same tenant and region) bound to an iframe session at issuance; only this broker can renew the session with its refresh token. Without it the iframe session lasts until the access token expires. Not allowed for other channels.string (uuid)нет

Ответы

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

Коды ошибокconfiguration_error

Проверки дела

GET/v1/cases/{case_id}/checks

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

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Разрешение на загрузку файла

POST/v1/cases/{case_id}/uploads

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

Параметры

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

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

ПолеТипОбязательно
kindenum: document_front, document_back, passport_data_page, face_video, face_image, nfc_transcript, corporate_document, address_document, ...да
content_typestringда
byte_countintegerда
sha256stringда
capture_attempt_idstring (uuid)нет
document_profile_idstringнет

Ответы

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

Коды ошибокconfiguration_errorcase_upload_quota_exceeded

Завершить загрузку файла

POST/v1/cases/{case_id}/uploads/complete

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

Параметры

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

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

ПолеТипОбязательно
upload_idstring (uuid)да
sha256stringда
byte_countintegerда

Ответы

  • 202Evidence
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Доказательства дела

GET/v1/cases/{case_id}/evidence

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

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Граф владения

GET/v1/cases/{case_id}/graph

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

Параметры

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

Ответы

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

Заменить узлы графа

PUT/v1/cases/{case_id}/graph/nodes

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

Параметры

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

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

ПолеТипОбязательно
nodesarray of EntityInputда
reason_codestringда

Ответы

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

Добавить связь в граф

POST/v1/cases/{case_id}/graph/relationships

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

Параметры

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

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

ПолеТипОбязательно
from_entity_idstring (uuid)да
to_entity_idstring (uuid)да
roleenum: shareholder, claimed_ubo, director, representative, trustee, settlor, protector, beneficiary, ...да
economic_share_percentoneOfнет
voting_share_percentoneOfнет
control_descriptionstringнет
effective_fromstring (date)нет
effective_tostring (date)нет
evidence_idsarray of string (uuid)да
share_classstringнет
denominator_basisenum: total_issued_equity, class_issued_equity, total_voting_rights, class_voting_rights, other, unknownда
assertion_statusenum: claimed, unknownда
source_referencestringнет
conflicting_assertion_idsarray of string (uuid)нет
lower_share_percentoneOfнет
upper_share_percentoneOfнет

Ответы

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

Удалить связь графа

DELETE/v1/cases/{case_id}/graph/relationships/{relationship_id}

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

Параметры

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

Ответы

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

Отчеты дела

GET/v1/cases/{case_id}/reports

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

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Сформировать отчет

POST/v1/cases/{case_id}/reports

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

Параметры

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

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

ПолеТипОбязательно
formatenum: json, pdf, bothда
localestringда
include_evidence_indexbooleanда

Ответы

  • 202Report
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Решения дела

GET/v1/cases/{case_id}/decisions

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

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Выдать доступ к апелляции

POST/v1/cases/{case_id}/appeal-access

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

Параметры

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

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

ПолеТипОбязательно
channelenum: email, sms, copy_linkда
recipientstringнет
localestringда
basis_profile_idstring (uuid)да

Ответы

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

Зарегистрировать основание обработки

POST/v1/cases/{case_id}/processing-basis

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

Параметры

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

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

ПолеТипОбязательно
profile_idstring (uuid)да
notice_idstring (uuid)да
notice_versionstringда
subject_referencestring (uuid)да
event_atstring (date-time)да
evidence_idsarray of string (uuid)да
attestation_formatenum: contractual_record, signed_assertionда
attestation_sha256stringда
purposestringда
basis_typeenum: customer_contract, customer_obligationнет
obligation_refstringнет
obligation_data_categoriesarray of stringнет

Ответы

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

Связанные лица

GET/v1/cases/{case_id}/related-parties

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

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Создать дело связанного лица

POST/v1/cases/{case_id}/related-parties

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

B2B creation of a related person case for a graph node and role required by the case KYB profile. A non-final related case of the same node and role is returned instead of a new one; a related case that ended without approval is replaced. The case must have related_party_processing_context_id.

Параметры

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

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

ПолеТипОбязательно
entity_idstring (uuid)да
roleenum: ubo, director, representative, controllerда

Ответы

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

Поиск компании

POST/v1/cases/{case_id}/company-search

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

B2B registry search for a company case: the same rules as applicant capture. The server searches the registry source of the case KYB profile for the country; every candidate record is kept as case evidence (provenance source_retrieval); a name search only yields candidates.

Параметры

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

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

ПолеТипОбязательно
countrystringда
name_querystringнет
registration_numberstringнет
source_idOptional. Without it the server searches the first registry source permitted by the case KYB profile for the country; a supplied source must be permitted by the profile for that country, otherwise the search answers not_supported.stringнет

Ответы

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

Выбрать компанию

POST/v1/cases/{case_id}/company-selection

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

B2B selection of a registry record found by searchCaseCompanyCandidates: identity resolution with alternatives of the same search, the record enters the case input set, the previous selection leaves it. If-Match is the case ETag.

Параметры

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

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

ПолеТипОбязательно
candidate_idstring (uuid)да
candidate_evidence_idstring (uuid)да

Ответы

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

Сведения о компании дела

GET/v1/cases/{case_id}/company

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

Organization of a company case with assertions, identity resolution, field decisions and mandatory conflicts. ETag is the case version.

Параметры

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

Ответы

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

Выгрузить граф владения

POST/v1/cases/{case_id}/graph/export

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

Export of the ownership graph with personal data masked by role; see GraphExport. The export is a read with an audit record; Idempotency-Key repeats return the same export.

Параметры

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

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

ПолеТипОбязательно
reason_codePurpose of the export recorded in the audit trail.stringда

Ответы

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

Уведомления дела

GET/v1/cases/{case_id}/notices

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

Notices (all versions and locales) of the basis profile and purpose of the case processing context: the notice_id and notice_version a client records with registerExternalBasisEvidence.

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
localeзапросstringнет
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Сообщенные итоги

GET/v1/cases/{case_id}/outcome-reports

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

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

Сообщить итог по делу

POST/v1/cases/{case_id}/outcome-reports

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

Records an outcome confirmed after the decision. The decision must belong to the case and be final; the report is immutable and audited. Decisions and reports are not changed.

Параметры

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

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

ПолеТипОбязательно
decision_idstring (uuid)да
outcomeenum: confirmed_fraud, confirmed_legitimateда
categoryenum: document_forgery, impersonation, synthetic_identity, account_takeover, presentation_attack, money_mule, otherда
reason_codestringда
confirmed_atstring (date-time)да

Ответы

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

История состояний дела

GET/v1/cases/{case_id}/transitions

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

State transitions of the case, newest first. Reason codes and actor types only; no personal data.

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
cursorзапросstringнет
limitзапросintegerнет

Ответы

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