Skip to main content
PATCH
/
v1
/
eligibility
/
checks
/
{check_id}
Update Check
curl --request PATCH \
  --url https://api.example.com/v1/eligibility/checks/{check_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "eligibility_status": "active"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eligibility_search_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eligibility_status": "active",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
check_id
string<uuid>
required

Body

application/json

Request schema for updating individual eligibility check status

​
eligibility_status
enum<string>
required

Eligibility status (active, inactive, failed)

Available options:
active,
inactive,
pending,
failed

Response

Successful Response

Response for eligibility check update

​
id
string<uuid>
required

Check ID

​
batch_id
string<uuid>
required

Parent batch ID

​
eligibility_search_id
string<uuid>
required

Eligibility search ID

​
eligibility_status
enum<string>
required

Eligibility status

Available options:
active,
inactive,
pending,
failed
​
updated_at
string<date-time> | null

Last update timestamp