Справочник API

Заявители

Физические лица и компании, которых вы проверяете.

Список заявителей

GET/v1/applicants

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

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет

Ответы

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

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

POST/v1/applicants

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

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

ПолеТипОбязательно
typeenum: person, companyда
external_idstringда
personPersonInputнет
companyCompanyInputнет
metadataMetadataнет
processing_context_idstring (uuid)да

Ответы

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

Получить заявителя

GET/v1/applicants/{applicant_id}

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

Параметры

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

Ответы

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

Изменить заявителя

PATCH/v1/applicants/{applicant_id}

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

Параметры

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

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

ПолеТипОбязательно
personPersonInputнет
companyCompanyInputнет
metadataMetadataнет

Ответы

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