Skip to main content
GET
Retrieve an eligibility verification

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Scopes

eligibility:read

Path Parameters

id
string<uuid>
required

The id returned when the check was submitted. Distinct from request_id, which identifies a single HTTP call.

Response

The check's current state, with the result once it has one.

data
object
required

A submitted check and, once the payer has answered, its result.

request_id
string
required
Example:

"c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"