supportedState Details

The supportedStateDetails API endpoint informs the publisher whether a user qualifies for an IQL test drive or not. The input that the Publisher receives from this endpoint helps them make an informed decision on allowing a user into the IQL test drive.

In order to enable this API endpoint for your users, please reach out to your integration specialist. If you require further clarification, please contact the Zendrive Support Team.

Design Recommendation

The following are the design recommendations pertaining to the supportedStateDetails API endpoint:

• Publishers can call this API endpoint for State and insurer-based information before allowing a user to onboard the IQL test drive program.

• This endpoint sends out the supported State and insurer information via response data to the Publisher who calls it.

• The Publisher can then use the response data to make an informed decision on whether to allow a user to take the IQL test drive or not.

This endpoint should be called from the publisher backend and not from the application itself. Exposing this endpoint through the application will result in security concerns related to API key.

POST https://iql.zendrive.com/iql/<version>/supported_state_details

Headers

Name	Type	Description
Authorization*	String	APIKEY<apikey>

Request Body

Name	Type	Description
country_code*	String	USA ('USA' is the only accepted syntax for this field).
state_code*	String	US state code
current_insurer*	String	Name of the current insurer, who could be an Advertiser or Publisher for whom the Publisher wants to make the call to this API endpoint.

200: OK Request successful and data returned.

{
    // Response
}

400: Bad Request

{
    // Response
}

401: Unauthorized Unauthorized Request (Problem with API key or setting Authorization.HTTP header in request)

{
    // Response
}

404: Not Found URL Not found (Invalid advertiser name).

{
    // Response
}

500: Internal Server Error Internal Server Error (JSON Payload missing).

{
    // Response
}

Sample Request Payload

{

    "country_code": <country_code>,
    "state_code": <state_code>,
    "current_insurer": <advertiser_name> or <insurer_name>
}

Sample Response

• is_supported_state: This response indicates whether the IQL program supports the state that has been provided.

• can_receive_offer: This response indicates whether or not the insurance offer can be made to the user.

Response Schema

{
    "is_supported_state": true,
    "can_receive_offer": true
}

Sample Request and Response

curl request:
curl --location --request POST 'https://iql.zendrive.com/iql/v1/supported_state_details' \
--header 'Authorization: APIKEY <API Key value>'

Response:

{
    "is_supported_state": true,
    "can_receive_offer": true
}