Get eligibility questionnaire schema

Returns the JSON schema for the eligibility questionnaire by type.

The schema defines the structure and validation rules for the questionnaire responses.
Supports versioning to allow for schema evolution while maintaining backwards compatibility.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View employments (employment:read)Manage employments (employment:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Type of eligibility questionnaire

Allowed:
≥ 1

Version of the form schema


Specific version number

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json