List appeals
GET/v1/appeals
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200AppealList400401403404409412413415422428429503
API reference
Appeals
Applicant appeals and their resolution.
Get an appeal
GET/v1/appeals/{appeal_id}
Parameters
| Field | Type | Required |
|---|---|---|
appeal_idpath | string (uuid) | yes |
Responses
200Appeal400401403404409412413415422428429503
Resolve an appeal
POST/v1/appeals/{appeal_id}/resolve
Parameters
| Field | Type | Required |
|---|---|---|
appeal_idpath | string (uuid) | yes |
Request bodyAppealResolve
| Field | Type | Required |
|---|---|---|
resolution | enum: uphold, new_verification, procedural_remedy | yes |
reason_codes | array of string | yes |
evidence_ids | array of string (uuid) | yes |
followup_policy_version_id | string (uuid) | no |
note | string | yes |
Responses
200Appeal400401403404409412413415422428429503
Claim an appeal
POST/v1/appeals/{appeal_id}/claim
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.
Parameters
| Field | Type | Required |
|---|---|---|
appeal_idpath | string (uuid) | yes |
Responses
200Appeal400401403404409412413415422428429503