Список заявителей
GET/v1/applicants
Параметры
| Поле | Тип | Обязательно |
|---|---|---|
cursorзапрос | string | нет |
limitзапрос | integer | нет |
Ответы
200ApplicantList400401403404409412413415422428429503
Справочник API
Физические лица и компании, которых вы проверяете.
GET/v1/applicants
| Поле | Тип | Обязательно |
|---|---|---|
cursorзапрос | string | нет |
limitзапрос | integer | нет |
200ApplicantList400401403404409412413415422428429503POST/v1/applicants
ApplicantCreate| Поле | Тип | Обязательно |
|---|---|---|
type | enum: person, company | да |
external_id | string | да |
person | PersonInput | нет |
company | CompanyInput | нет |
metadata | Metadata | нет |
processing_context_id | string (uuid) | да |
201Applicant400401403404409412413415422428429503GET/v1/applicants/{applicant_id}
| Поле | Тип | Обязательно |
|---|---|---|
applicant_idпуть | string (uuid) | да |
viewзапросfull (default) or masked: the masked projection of personal data of a person; the console reads applicants masked. | enum: full, masked | нет |
200Applicant400401403404409412413415422428429503PATCH/v1/applicants/{applicant_id}
| Поле | Тип | Обязательно |
|---|---|---|
applicant_idпуть | string (uuid) | да |
ApplicantUpdate| Поле | Тип | Обязательно |
|---|---|---|
person | PersonInput | нет |
company | CompanyInput | нет |
metadata | Metadata | нет |
200Applicant400401403404409412413415422428429503POST/v1/applicants/{applicant_id}/reveal
Reveals the full personal data of an applicant with a reason code: requires evidence:download in addition to applicants:read; the reveal is written to the audit log (applicant.reveal) with the reason; the response carries the display deadline.
| Поле | Тип | Обязательно |
|---|---|---|
applicant_idпуть | string (uuid) | да |
EvidenceReveal| Поле | Тип | Обязательно |
|---|---|---|
reason_code | enum: case_review, appeal_review, quality_assurance, customer_support, legal_obligation | да |
200ApplicantReveal400401403404409412413415422428429503