Справочник API

Апелляции

Апелляции заявителей и решения по ним.

Список апелляций

GET/v1/appeals

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

Параметры

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

Ответы

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

Получить апелляцию

GET/v1/appeals/{appeal_id}

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

Параметры

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

Ответы

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

Решение по апелляции

POST/v1/appeals/{appeal_id}/resolve

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

Параметры

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

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

ПолеТипОбязательно
resolutionenum: uphold, new_verification, procedural_remedyда
reason_codesarray of stringда
evidence_idsarray of string (uuid)да
followup_policy_version_idstring (uuid)нет
notestringда

Ответы

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

Взять апелляцию в работу

POST/v1/appeals/{appeal_id}/claim

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

Takes an open appeal into review (status under_review) by the calling principal, or reassigns an appeal under review to the caller. If-Match is the appeal version. Only the assigned reviewer can resolve an appeal under review.

Параметры

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

Ответы

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