driverInfo Endpoint

Use the driverInfo API endpoint to upload or update driver information to the backend. This information is essential for the user to qualify for the IQL program.

Design Recommendation

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 the API key.

Note that the driverInfo API endpoint does not create a new driver entry in the Zendrive backend. A new user is created when the application calls the Zendrive SDK's setup method with the new driver details.

driverInfo PUT API Endpoint

Driver Info Endpoint

PUT URL: https://iql.zendrive.com /iql/v1/driver/{driver_id}/info

Populate driver information required for qualification in the IQL program.

Path Parameters

Name	Type	Description
driver_id*	String	Driver's unique identifier.

Headers

Name	Type	Description
Authorization*	String	APIKEY <api_key>

Request Body

Name	Type	Description
country*	String	Country code (for example: USA)
state*	String	2 letter ANSI standard state code (for example, 'AZ' for Arizona.
insurer	String	Name of user’s current insurer (for example, 'Progressive').
zipcode	String	5 letter USA zip code (for example, '10118', which is the zip code for New York).
segment.acq_source	String	The driver's acquisition source.

200: OK Entry successfully updated.

400: Bad Request Bad Request (could be because of invalid request payload)

401: Unauthorized Unauthorized request. Check if the API key is correctly provided in the Authorization header.

404: Not Found URL Not found (could be wrong version or driver_id)

Request Payload Fields

Req Parameter	Description	Type	Example	Required
country	User's country code	String	“USA”	Mandatory
state	User's state code	String	“AZ”	Mandatory
zipcode	User's zipcode	String	“10118”	Optional
insurer	User's Insurer	String	“Progressive”	Optional
segment.acq_source	The acquisition source of the user.	String	"fetch_abc"	Optional

Sample Request URL

https://iql.zendrive.com/iql/v1/driver/b_01/info

Sample Request Payload

{
  "country": "USA",
  "state": "AZ",
  "zipcode": "10118"
  "insurer": "Progressive",
  "segment": {
    "acq_source": "fetch_abc"
  }
}

Sample Request

curl --location --request PUT 'https://iql.zendrive.com/iql/v1/driver/user_123/info' \
--header 'Authorization: APIKEY A6B8cDEFG01HI7jklMnp1stQuvvZXyZ5' \
--header 'Content-Type: application/json' \
--data-raw '{
    "country": "USA",
    "state": "AZ",
    "zipcode": "10118",
    "insurer": "Progressive",
    "segment": {
        "acq_source": "fetch_abc"
    }
}'

Sample Response

Response  - {}       status code -  200   (User uploaded/updated in database)

driverInfo GET API Endpoint

Use the driverInfo GET API endpoint to obtain the driver information stored in the backend.

GET https://iql.zendrive.com /iql/v1/driver/{driver_id}/info

Path Parameters

Name	Type	Description
driver_id*	String	The unique Id of the user.

Headers

Name	Type	Description
Authorization*	string	APIKEY <api_key>

200: OK Driver information successfully obtained from the backend.

401: Unauthorized API Key not valid, authorization failure.

404: Not Found URL Not found. This could be because it's the wrong version, or that the wrong driver_id has been used.

204: No Content Driver exists but driver info is not found.

Field	Type	Nullable	Description
country	String	No	Acronym of the country to which the driver belongs.
state	String	No	Acronym of the state to which the driver belongs.
zipcode	String	Yes	Zipcode of the driver's locality.
insurer	String	Yes	The name of the insurer.
segment.acq_source	String	Yes	The driver's acquisition source.

Sample Request

curl --location --request GET 'https://iql.zendrive.com/iql/v1/driver/b_0/info' --header 'Authorization: APIKEY apikey'

Sample Response

{
    "country": "USA",
    "state": "AZ",
    "zipcode": "10118",
    "insurer": "insurer_aInsurer_AProgressive",
    "segment": {
	"acq_source" : "acq_sourceAcq_Sourcesteady"
     }
}