Skip to main content
GET
Get Eligibility Check
The Eligibility request result will be sent to all active webhooks once available. As a fallback, you may call this endpoint to check result status and obtain the result.

Status

The status field in the response can have one of the following values:

Error codes

Webhooks

Add webhooks in the provider app to receive results into your endpoint. Webhook payload will be identical to the response of this endpoint. When configuring a webhook you can provide a secret to sign the webhook payload and check the signature on the server side. Signature will be sent in X-Signature header in request to webhook endpoint. Signature is a request raw data signed with secret by HMAC SHA256 algorithm. Python example:

Authorizations

Authorization
string
header
required

Your API token prefaced with an "Api" prefix. Example value: "Api B3F4242424E3FDB4242424242A9C7642"

Path Parameters

request_uid
string
required

Response

request_uid
string
required

UID provided on request creation or auto generated

status
enum<string>
required
Available options:
processing,
complete,
error
error_code
string | null
results
object[] | null