Skip to main content
GET
/
insurancepolicies
/
{id}
Retrieve an Insurance Policy
curl --request GET \
  --url https://commerce.driv.ly/api/insurancepolicies/{id}
{
  "data": {
    "id": "<string>",
    "consumer": "<string>",
    "policyNumber": "<string>",
    "insurer": "<string>"
  },
  "success": true
}

Path Parameters

​
id
string
required

Insurance Policy is uniquely identified by id

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Response

Insurance Policy Found

​
data
Insurance Policy · object
Example:
{
  "id": "insp_4dkf9v0s3j4s",
  "insurer": { "id": "ins_9k2d8sj3hdk2" },
  "consumer": {
    "id": "con_2k4jd93vsd82",
    "ssn": "123-45-6789",
    "email": "john.doe@example.com",
    "lastName": "Doe",
    "birthDate": "1984-09-20",
    "firstName": "John",
    "phoneNumber": "555-0199"
  },
  "policyNumber": "POL123456789"
}
​
success
boolean