Skip to content
English
More support
Subscribe to Release Notes
  • There are no suggestions because the search field is empty.

How to Create a Client API Eligibility Connector and Assign it to an Exam

Org Admins can now integrate custom API endpoints for eligibility by creating validated Client API Eligibility Connectors.

Step 1: Access the Eligibility Connectors Section

  • Log in to the platform as an Organization Admin.

  • Navigate to the Eligibility Connectors section in your Admin Panel.

  • Click Create New Connector.

Select the Provider Type

  • In the Provider Type dropdown, select Custom Client Api.

Note: Only users with valid credentials can create ClientApi Connectors.

Provide Connector Details

  • Enter a Connector Name.

    • The name must be unique within your organization (even if the provider type is the same).

  • Input the Username and Password for the ClientApi credentials.

  • Enter Partner Endpoint Domain

  • Click Validate Credentials.

    • If the credentials are valid, you’ll be allowed to proceed.

  • Click Save Connector.

Step 2: Assign a Connector to a Store Exam

  • Go to the Store Exams section.

  • Select an existing Exam

  • In the Eligibility Configuration Type, choose Eligibility Data as the provider.

  • Save the Store Exam settings.

 

Last updated on April 23rd 2025. Information may have changed since.