POST
/
api
/
auth
/
v1
/
eligibility
{
	"insurer_code": "insurer:demo:vision",
	"request_uid": "19850f24-900e-4812-8e99-6faa2397fe57",
	"patient": {
		"first_name": "John",
		"last_name": "Smith",
		"dob": "1990-01-01",
	}
}

{
  "request_uid": "af38aa113b4148ec86f3ed7324f75894"
}

This call is asynchronous, it initiates an eligibility search and returns a UID assigned to this request. The result will be returned in two ways:

  • Via active webhooks once available - preferred. Request UID will be included in payload.
  • By calling the “Eligibility Result” endpoint - only to be used as fallback. Request UID is required.

If specifying a UID, ensure it is unique. If omitted, one will be generated automatically and included in the response for this API call.

The response will contain the request UID or a validation error.

{
	"insurer_code": "insurer:demo:vision",
	"request_uid": "19850f24-900e-4812-8e99-6faa2397fe57",
	"patient": {
		"first_name": "John",
		"last_name": "Smith",
		"dob": "1990-01-01",
	}
}

{
  "request_uid": "af38aa113b4148ec86f3ed7324f75894"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Response

201 - application/json

Search started successfully

The response is of type object.