URL Expired

The URL for this request expired after 30 days.

customer_id

integer

required

The id of the customer

api-version

integer

required

Target API version

``200 Success

object

id

integer

carrier

string  null

policy_number

string  null

expires_on

string

customer_id

integer

is_stale

boolean

Represents if the insurance account has not been refreshed since a time period determined by business rules

is_verified

boolean

Represents if the insurance account is verified according to business rules

is_incomplete

boolean

Indicates if the insurance record is missing required fields (carrier, policy_number, or expires_on)

missing_required_fields

array of strings

List of required fields that are missing from the insurance record

carrier``policy_number``expires_on

refreshed_at

string  null

Timestamp of when the last time the account was verified by the third party.

image

object  null

id

integer

url

string

sufficiency

object  null

loaner

object  null

loaner object  null

rental

object  null

rental object  null

``401 Unauthorized

``403 Forbidden

``404 Not found

``406 Not Acceptable

{
  "id": 12,
  "carrier": "UnitedHealthCare",
  "policy_number": "GAC56232",
  "expires_on": "2023-02-13T16:08:34Z",
  "customer_id": 110,
  "is_stale": false,
  "is_verified": false,
  "is_incomplete": false,
  "missing_required_fields": [],
  "refreshed_at": "2023-02-13T16:08:34Z",
  "image": {
    "id": 323,
    "url": "https://example.com/image_url.png"
  },
  "sufficiency": {
    "loaner": {
      "sufficient": true,
      "status": "pass",
      "valid_until": "2024-12-31T23:59:59Z",
      "checked_at": "2024-01-01T12:00:00Z",
      "details": {
        "collision_coverage_meets_requirements": "pass",
        "comprehensive_coverage_meets_requirements": "fail",
        "expiration_date_comparison": "pass",
        "insureds_match": "unknown",
        "required_policy_information_is_present": "pass"
      }
    },
    "rental": {
      "sufficient": true,
      "status": "pass",
      "valid_until": "2024-12-31T23:59:59Z",
      "checked_at": "2024-01-01T12:00:00Z",
      "details": {
        "comprehensive_coverage_meets_requirements": "fail",
        "expiration_date_comparison": "pass",
        "insureds_match": "unknown",
        "rental_covered_for_collision": "pass",
        "required_policy_information_is_present": "pass"
      }
    }
  }
}