additional_interests

create_additional_interest

POST

/api/v2/additional_interests/create_additional_interest

create_additional_interest

create_additional_interest › Request Body

Request payload for /api/v2/additional_interests/create_additional_interest. Provide quote_id for revision-level or vehicle_id/risk_id for risk-level.

request-create_additional_interest

object · required

create_additional_interest › Responses

200

Response payload for /api/v2/additional_interests/create_additional_interest.

response-create_additional_interest

required

object · required

success

boolean · required

POST/api/v2/additional_interests/create_additional_interest

curl --request POST \
  --url /api/v2/additional_interests/create_additional_interest \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_interest": {
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "risk_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "contact_id": "00000000-0000-0000-0000-000000000000",
    "interest": "interest",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "notes": "notes",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "2024-08-25",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ]
  }
}
'

Example Request Body

{
  "additional_interest": {
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "risk_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "contact_id": "00000000-0000-0000-0000-000000000000",
    "interest": "interest",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "notes": "notes",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "2024-08-25",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ]
  }
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": 0,
    "contact_id": "00000000-0000-0000-0000-000000000000",
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "interest": "interest",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "date_of_birth",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ],
    "can_edit": true
  },
  "success": true
}

json

application/json

delete_additional_interest

POST

/api/v2/additional_interests/delete_additional_interest

delete_additional_interest

delete_additional_interest › Request Body

Request payload for /api/v2/additional_interests/delete_additional_interest.

request-delete_additional_interest

id

string · uuid · required

Additional interest ID to delete

delete_additional_interest › Responses

200

Response payload for /api/v2/additional_interests/delete_additional_interest.

response-delete_additional_interest

messages

string[] · required

Success or error messages

data

object · required

Empty object on successful deletion

success

boolean · required

get_additional_interest

POST

/api/v2/additional_interests/get_additional_interest

get_additional_interest

get_additional_interest › Request Body

Request payload for /api/v2/additional_interests/get_additional_interest.

request-get_additional_interest

id

string · uuid · required

Additional interest ID

get_additional_interest › Responses

200

Response payload for /api/v2/additional_interests/get_additional_interest.

response-get_additional_interest

required

additional_interest-def · required

Additional interest definition. Either revision-level (quote_id) or risk-level (vehicle_id or risk_id).

success

boolean · required

POST/api/v2/additional_interests/get_additional_interest

curl --request POST \
  --url /api/v2/additional_interests/get_additional_interest \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "00000000-0000-0000-0000-000000000000",
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "notes": "notes",
    "interest": "interest",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "date_of_birth",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ],
    "can_edit": true
  },
  "success": true
}

json

application/json

list_additional_interests

POST

/api/v2/additional_interests/list_additional_interests

list_additional_interests

list_additional_interests › Request Body

Request payload for /api/v2/additional_interests/list_additional_interests. Accepts either a risk scope (risk_id) or a revision scope (quote_id).

request-list_additional_interests

quote_id

string · uuid

ID of the quote/revision to list interests for (revision scope)

risk_id

string · uuid

ID of the risk/property to list interests for (risk scope)

list_additional_interests › Responses

200

Response payload for /api/v2/additional_interests/list_additional_interests (revision and risk scopes).

response-list_additional_interests

messages

string[] · required

Success or informational messages

additional_interest-def[] · required

Array of additional interests for the quote

success

boolean · required

Indicates if the request was successful

POST/api/v2/additional_interests/list_additional_interests

curl --request POST \
  --url /api/v2/additional_interests/list_additional_interests \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_id": "00000000-0000-0000-0000-000000000000",
  "risk_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "quote_id": "00000000-0000-0000-0000-000000000000",
  "risk_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "contact_id": "00000000-0000-0000-0000-000000000000",
      "quote_id": "00000000-0000-0000-0000-000000000000",
      "vehicle_id": "00000000-0000-0000-0000-000000000000",
      "risk_id": "00000000-0000-0000-0000-000000000000",
      "interest_type": "interest_type",
      "loan_number": "loan_number",
      "notes": "notes",
      "interest": "interest",
      "name": "name",
      "type": "individual",
      "ssn": "ssn",
      "date_of_birth": "date_of_birth",
      "fein_tax_id": "fein_tax_id",
      "legal_entity_type": "legal_entity_type",
      "phones": [
        {
          "phone": "phone",
          "type": "Home",
          "is_preferred": true
        }
      ],
      "addresses": [
        {
          "city": "city",
          "county": "county",
          "street": "street",
          "line2": "line2",
          "state": "state",
          "zipcode": "zipcode",
          "is_preferred": true,
          "type": "Mailing/Billing"
        }
      ],
      "emails": [
        {
          "email": "email",
          "type": "Personal",
          "is_preferred": true
        }
      ],
      "can_edit": true
    }
  ],
  "success": true
}

json

application/json

list_interest_type_labels_by_code

POST

/api/v2/additional_interests/list_interest_type_labels_by_code

Return the code -> label lookup for ADDITIONAL_INTEREST_TYPES, including inactive rows. Frontends resolve the display label for historical AIs whose stored code has since been deactivated (dropdowns keep using list_interest_type_options for the picker itself).

list_interest_type_labels_by_code › Request Body

Request payload for /api/v2/additional_interests/list_interest_type_labels_by_code. No parameters: the endpoint returns the tenant-wide code -> label map for ADDITIONAL_INTEREST_TYPES, including inactive rows, so display seams can resolve labels for historical AIs whose stored code was since deactivated.

request-list_interest_type_labels_by_code

list_interest_type_labels_by_code › Responses

200

Response payload for /api/v2/additional_interests/list_interest_type_labels_by_code. `data` is a code -> label object for the ADDITIONAL_INTEREST_TYPES QuickCode. Includes inactive rows so a historical AI whose type has been deactivated still resolves back to its label. This is a display-only map: the picker keeps using list_interest_type_options for the active/scoped selectable set.

response-list_interest_type_labels_by_code

messages

string[] · required

Success or informational messages

object · required

code -> label map for ADDITIONAL_INTEREST_TYPES (active + inactive)

success

boolean · required

Indicates if the request was successful

list_interest_type_options

POST

/api/v2/additional_interests/list_interest_type_options

list_interest_type_options

list_interest_type_options › Request Body

Request payload for /api/v2/additional_interests/list_interest_type_options. Resolves the selectable Additional Interest type QuickCode values for a revision, scoped by either a revision (quote_id) or a risk (risk_id). When neither is provided the global active set is returned.

request-list_interest_type_options

quote_id

string · uuid

ID of the quote/revision to resolve interest type options for (revision scope)

risk_id

string · uuid

ID of the risk/property whose revision is used to resolve interest type options (risk scope)

list_interest_type_options › Responses

200

Response payload for /api/v2/additional_interests/list_interest_type_options. Returns the effective Additional Interest type QuickCode values for the resolved revision - the same set create/update validation accepts. Only active values are returned, ordered by sort_order then code_value_type.

response-list_interest_type_options

messages

string[] · required

Success or informational messages

object[] · required

Selectable interest type QuickCode values for the resolved revision

success

boolean · required

Indicates if the request was successful

POST/api/v2/additional_interests/list_interest_type_options

curl --request POST \
  --url /api/v2/additional_interests/list_interest_type_options \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_id": "00000000-0000-0000-0000-000000000000",
  "risk_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "quote_id": "00000000-0000-0000-0000-000000000000",
  "risk_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": [
    {
      "code_value_type": "code_value_type",
      "quick_code": "quick_code",
      "label": "label",
      "description": "description",
      "active": true,
      "default": true,
      "is_system_default": true,
      "sort_order": 0,
      "added_by": "added_by",
      "date_added": "date_added",
      "updated_by": "updated_by",
      "date_updated": "date_updated"
    }
  ],
  "success": true
}

json

application/json

update_additional_interest

POST

/api/v2/additional_interests/update_additional_interest

update_additional_interest

update_additional_interest › Request Body

Request payload for /api/v2/additional_interests/update_additional_interest. Provide quote_id for revision-level or vehicle_id/risk_id for risk-level.

request-update_additional_interest

object · required

update_additional_interest › Responses

200

Response payload for /api/v2/additional_interests/update_additional_interest.

response-update_additional_interest

required

additional_interest-def · required

Additional interest definition. Either revision-level (quote_id) or risk-level (vehicle_id or risk_id).

success

boolean · required

POST/api/v2/additional_interests/update_additional_interest

curl --request POST \
  --url /api/v2/additional_interests/update_additional_interest \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_interest": {
    "id": "00000000-0000-0000-0000-000000000000",
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "interest": "interest",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "notes": "notes",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "2024-08-25",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ]
  }
}
'

Example Request Body

{
  "additional_interest": {
    "id": "00000000-0000-0000-0000-000000000000",
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "interest": "interest",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "notes": "notes",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "2024-08-25",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ]
  }
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "00000000-0000-0000-0000-000000000000",
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "notes": "notes",
    "interest": "interest",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "date_of_birth",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ],
    "can_edit": true
  },
  "success": true
}

json

application/json

update_additional_interest_associations

POST

/api/v2/additional_interests/update_additional_interest_associations

update_additional_interest_associations

update_additional_interest_associations › Request Body

Request payload for /api/v2/additional_interests/update_additional_interest_associations. Diffs current risk associations against risk_ids: missing risks are linked, removed risks are unlinked.

request-update_additional_interest_associations

id

string · uuid · required

ID of an existing x_properties_contacts record for this AI

risk_ids

string[] · minItems: 1 · required

Complete desired set of risk IDs for this contact+interest. Risks present in the current set but absent here will be removed.

update_additional_interest_associations › Responses

200

Response payload for /api/v2/additional_interests/update_additional_interest_associations. Returns the updated additional interest with its current associations list.

response-update_additional_interest_associations

required

additional_interest-def · required

Additional interest definition. Either revision-level (quote_id) or risk-level (vehicle_id or risk_id).

success

boolean · required

POST/api/v2/additional_interests/update_additional_interest_associations

curl --request POST \
  --url /api/v2/additional_interests/update_additional_interest_associations \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "risk_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "risk_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "contact_id": "00000000-0000-0000-0000-000000000000",
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "vehicle_id": "00000000-0000-0000-0000-000000000000",
    "risk_id": "00000000-0000-0000-0000-000000000000",
    "interest_type": "interest_type",
    "loan_number": "loan_number",
    "notes": "notes",
    "interest": "interest",
    "name": "name",
    "type": "individual",
    "ssn": "ssn",
    "date_of_birth": "date_of_birth",
    "fein_tax_id": "fein_tax_id",
    "legal_entity_type": "legal_entity_type",
    "phones": [
      {
        "phone": "phone",
        "type": "Home",
        "is_preferred": true
      }
    ],
    "addresses": [
      {
        "city": "city",
        "county": "county",
        "street": "street",
        "line2": "line2",
        "state": "state",
        "zipcode": "zipcode",
        "is_preferred": true,
        "type": "Mailing/Billing"
      }
    ],
    "emails": [
      {
        "email": "email",
        "type": "Personal",
        "is_preferred": true
      }
    ],
    "can_edit": true
  },
  "success": true
}

json

application/json

accounting agentcy