drivers

Download schema

create_driver

POST

/api/v2/drivers/create_driver

create_driver

create_driver › Request Body

object · required

skip_rules

boolean

Default: false

create_driver › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/drivers/create_driver

curl --request POST \
  --url /api/v2/drivers/create_driver \
  --header 'Content-Type: application/json' \
  --data '
{
  "driver": {
    "id": "id",
    "current_occupation": "Unemployed",
    "date_licensed": "2024-08-25",
    "date_of_birth": "2024-08-25",
    "driver_training_completion_date": "2024-08-25",
    "driver_training": true,
    "driver_license_status": "driver_license_status",
    "foreign_license": true,
    "education_level": "Associate Degree",
    "full_name": "full_name",
    "gender": "Not specified or non-binary",
    "good_student": true,
    "included_in_policy": true,
    "license_number": "license_number",
    "license_state": "AL",
    "issuing_country": "issuing_country",
    "marital_status": "Domestic Partner",
    "non_inclusion_reason": "non_inclusion_reason",
    "relation_to_applicant": "Named Insured",
    "social_security_number": "social_security_number",
    "student_over_100_miles": true,
    "quote_id": "quote_id",
    "current_employer": "current_employer",
    "years_with_current_employer": 0,
    "driving_experience_months": 0,
    "govt_employee": true,
    "address_owned": true,
    "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "contact_id",
    "custom_fields": [
      {
        "id": "id",
        "name": "name",
        "value": "value",
        "override": false
      }
    ],
    "added_from_template": true
  },
  "skip_rules": false
}
'

Example Request Body

{
  "driver": {
    "id": "id",
    "current_occupation": "Unemployed",
    "date_licensed": "2024-08-25",
    "date_of_birth": "2024-08-25",
    "driver_training_completion_date": "2024-08-25",
    "driver_training": true,
    "driver_license_status": "driver_license_status",
    "foreign_license": true,
    "education_level": "Associate Degree",
    "full_name": "full_name",
    "gender": "Not specified or non-binary",
    "good_student": true,
    "included_in_policy": true,
    "license_number": "license_number",
    "license_state": "AL",
    "issuing_country": "issuing_country",
    "marital_status": "Domestic Partner",
    "non_inclusion_reason": "non_inclusion_reason",
    "relation_to_applicant": "Named Insured",
    "social_security_number": "social_security_number",
    "student_over_100_miles": true,
    "quote_id": "quote_id",
    "current_employer": "current_employer",
    "years_with_current_employer": 0,
    "driving_experience_months": 0,
    "govt_employee": true,
    "address_owned": true,
    "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "contact_id",
    "custom_fields": [
      {
        "id": "id",
        "name": "name",
        "value": "value",
        "override": false
      }
    ],
    "added_from_template": true
  },
  "skip_rules": false
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "id": "id",
    "current_occupation": "Unemployed",
    "date_licensed": "2024-08-25",
    "date_of_birth": "2024-08-25",
    "driver_training_completion_date": "2024-08-25",
    "driver_training": true,
    "driver_license_status": "driver_license_status",
    "foreign_license": true,
    "education_level": "Associate Degree",
    "full_name": "full_name",
    "gender": "Not specified or non-binary",
    "good_student": true,
    "included_in_policy": true,
    "coverage_status": "covered",
    "license_number": "license_number",
    "license_state": "AL",
    "issuing_country": "issuing_country",
    "marital_status": "Domestic Partner",
    "non_inclusion_reason": "non_inclusion_reason",
    "relation_to_applicant": "Named Insured",
    "social_security_number": "social_security_number",
    "student_over_100_miles": true,
    "quote_id": "quote_id",
    "current_employer": "current_employer",
    "years_with_current_employer": 0,
    "driving_experience_months": 0,
    "govt_employee": true,
    "address_owned": true,
    "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "contact_id",
    "is_primary_named_insured": true,
    "custom_fields": [
      {
        "id": "id",
        "name": "name",
        "value": "value",
        "override": true
      }
    ],
    "added_from_template": true,
    "validations": [
      {}
    ]
  }
}

json

application/json

delete_driver

POST

/api/v2/drivers/delete_driver

delete_driver

delete_driver › Request Body

id

string · required

delete_driver › Responses

200

success

boolean · required

required

Messages or errors related to the request

array · required

Empty

get_driver

POST

/api/v2/drivers/get_driver

get_driver

get_driver › Request Body

id

string · required

get_driver › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/drivers/get_driver

curl --request POST \
  --url /api/v2/drivers/get_driver \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "id"
}'

Example Request Body

{
  "id": "id"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "id": "id",
    "current_occupation": "Unemployed",
    "date_licensed": "2024-08-25",
    "date_of_birth": "2024-08-25",
    "driver_training_completion_date": "2024-08-25",
    "driver_training": true,
    "driver_license_status": "driver_license_status",
    "foreign_license": true,
    "education_level": "Associate Degree",
    "full_name": "full_name",
    "gender": "Not specified or non-binary",
    "good_student": true,
    "included_in_policy": true,
    "coverage_status": "covered",
    "license_number": "license_number",
    "license_state": "AL",
    "issuing_country": "issuing_country",
    "marital_status": "Domestic Partner",
    "non_inclusion_reason": "non_inclusion_reason",
    "relation_to_applicant": "Named Insured",
    "social_security_number": "social_security_number",
    "student_over_100_miles": true,
    "quote_id": "quote_id",
    "current_employer": "current_employer",
    "years_with_current_employer": 0,
    "driving_experience_months": 0,
    "govt_employee": true,
    "address_owned": true,
    "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "contact_id",
    "is_primary_named_insured": true,
    "custom_fields": [
      {
        "id": "id",
        "name": "name",
        "value": "value",
        "override": true
      }
    ],
    "added_from_template": true
  }
}

json

application/json

list_custom_fields_types

POST

/api/v2/drivers/list_custom_fields_types

list_custom_fields_types

list_custom_fields_types › Request Body

Request Schema for /api/v2/watercrafts/list_custom_fields_types

request-list_custom_fields_types

quote_id

string · uuid · required

The ID of the quote to get custom field types for

list_custom_fields_types › Responses

200

Response Schema for /api/v2/watercrafts/list_custom_fields_types

response-list_custom_fields_types

object[] · required

success

boolean · required

Indicates if the request was successful

required

list_driver_integration_reports

POST

/api/v2/drivers/list_driver_integration_reports

list_driver_integration_reports

list_driver_integration_reports › Request Body

driver_id

string · required

list_driver_integration_reports › Responses

200

success

boolean · required

required

Messages or errors related to the request

object[] · required

list_drivers_for_quote

POST

/api/v2/drivers/list_drivers_for_quote

list_drivers_for_quote

list_drivers_for_quote › Request Body

quote_id

string · required

return_unmasked

boolean

Unmask values; honored for administrators only

Default: false

list_drivers_for_quote › Responses

200

success

boolean · required

required

Messages or errors related to the request

object[] · required

POST/api/v2/drivers/list_drivers_for_quote

curl --request POST \
  --url /api/v2/drivers/list_drivers_for_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "return_unmasked": false,
  "quote_id": "quote_id"
}
'

Example Request Body

{
  "return_unmasked": false,
  "quote_id": "quote_id"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": [
    {
      "id": "id",
      "current_occupation": "Unemployed",
      "date_licensed": "2024-08-25",
      "date_of_birth": "2024-08-25",
      "driver_training_completion_date": "2024-08-25",
      "driver_training": true,
      "driver_license_status": "driver_license_status",
      "foreign_license": true,
      "education_level": "Associate Degree",
      "full_name": "full_name",
      "gender": "Not specified or non-binary",
      "good_student": true,
      "included_in_policy": true,
      "coverage_status": "covered",
      "license_number": "license_number",
      "license_state": "AL",
      "issuing_country": "issuing_country",
      "marital_status": "Domestic Partner",
      "non_inclusion_reason": "non_inclusion_reason",
      "relation_to_applicant": "Named Insured",
      "social_security_number": "social_security_number",
      "student_over_100_miles": true,
      "quote_id": "quote_id",
      "current_employer": "current_employer",
      "years_with_current_employer": 0,
      "driving_experience_months": 0,
      "govt_employee": true,
      "address_owned": true,
      "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
      "contact_id": "contact_id",
      "is_primary_named_insured": true,
      "custom_fields": [
        {
          "id": "id",
          "name": "name",
          "value": "value",
          "override": true
        }
      ],
      "added_from_template": true
    }
  ]
}

json

application/json

update_driver

POST

/api/v2/drivers/update_driver

update_driver

update_driver › Request Body

object · required

Must include the driver's id; every other field is optional

skip_rules

boolean

Default: false

update_driver › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/drivers/update_driver

curl --request POST \
  --url /api/v2/drivers/update_driver \
  --header 'Content-Type: application/json' \
  --data '
{
  "driver": {
    "id": "id",
    "current_occupation": "Unemployed",
    "date_licensed": "2024-08-25",
    "date_of_birth": "2024-08-25",
    "driver_training_completion_date": "2024-08-25",
    "driver_training": true,
    "driver_license_status": "driver_license_status",
    "foreign_license": true,
    "education_level": "Associate Degree",
    "full_name": "full_name",
    "gender": "Not specified or non-binary",
    "good_student": true,
    "included_in_policy": true,
    "license_number": "license_number",
    "license_state": "AL",
    "issuing_country": "issuing_country",
    "marital_status": "Domestic Partner",
    "non_inclusion_reason": "non_inclusion_reason",
    "relation_to_applicant": "Named Insured",
    "social_security_number": "social_security_number",
    "student_over_100_miles": true,
    "quote_id": "quote_id",
    "current_employer": "current_employer",
    "years_with_current_employer": 0,
    "driving_experience_months": 0,
    "govt_employee": true,
    "address_owned": true,
    "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "contact_id",
    "custom_fields": [
      {
        "id": "id",
        "name": "name",
        "value": "value",
        "override": false
      }
    ],
    "added_from_template": true
  },
  "skip_rules": false
}
'

Example Request Body

{
  "driver": {
    "id": "id",
    "current_occupation": "Unemployed",
    "date_licensed": "2024-08-25",
    "date_of_birth": "2024-08-25",
    "driver_training_completion_date": "2024-08-25",
    "driver_training": true,
    "driver_license_status": "driver_license_status",
    "foreign_license": true,
    "education_level": "Associate Degree",
    "full_name": "full_name",
    "gender": "Not specified or non-binary",
    "good_student": true,
    "included_in_policy": true,
    "license_number": "license_number",
    "license_state": "AL",
    "issuing_country": "issuing_country",
    "marital_status": "Domestic Partner",
    "non_inclusion_reason": "non_inclusion_reason",
    "relation_to_applicant": "Named Insured",
    "social_security_number": "social_security_number",
    "student_over_100_miles": true,
    "quote_id": "quote_id",
    "current_employer": "current_employer",
    "years_with_current_employer": 0,
    "driving_experience_months": 0,
    "govt_employee": true,
    "address_owned": true,
    "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "contact_id",
    "custom_fields": [
      {
        "id": "id",
        "name": "name",
        "value": "value",
        "override": false
      }
    ],
    "added_from_template": true
  },
  "skip_rules": false
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "id": "id",
    "current_occupation": "Unemployed",
    "date_licensed": "2024-08-25",
    "date_of_birth": "2024-08-25",
    "driver_training_completion_date": "2024-08-25",
    "driver_training": true,
    "driver_license_status": "driver_license_status",
    "foreign_license": true,
    "education_level": "Associate Degree",
    "full_name": "full_name",
    "gender": "Not specified or non-binary",
    "good_student": true,
    "included_in_policy": true,
    "coverage_status": "covered",
    "license_number": "license_number",
    "license_state": "AL",
    "issuing_country": "issuing_country",
    "marital_status": "Domestic Partner",
    "non_inclusion_reason": "non_inclusion_reason",
    "relation_to_applicant": "Named Insured",
    "social_security_number": "social_security_number",
    "student_over_100_miles": true,
    "quote_id": "quote_id",
    "current_employer": "current_employer",
    "years_with_current_employer": 0,
    "driving_experience_months": 0,
    "govt_employee": true,
    "address_owned": true,
    "sub_line_instance_id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "contact_id",
    "is_primary_named_insured": true,
    "custom_fields": [
      {
        "id": "id",
        "name": "name",
        "value": "value",
        "override": true
      }
    ],
    "added_from_template": true,
    "validations": [
      {}
    ]
  }
}

json

application/json

document_templates erp