suspensions

Download schema

create_suspension

POST

/api/v2/suspensions/create_suspension

create_suspension

create_suspension › Request Body

create_suspension › Responses

200

success

boolean

message

string[]

data

object

delete_suspension

POST

/api/v2/suspensions/delete_suspension

delete_suspension

delete_suspension › Request Body

delete_suspension › Responses

200

success

boolean

message

string[]

data

object

get_policy_applicable_suspensions

POST

/api/v2/suspensions/get_policy_applicable_suspensions

get_policy_applicable_suspensions

get_policy_applicable_suspensions › Request Body

Request schema for the get_policy_applicable_suspensions endpoint

request-get_policy_applicable_suspensions

policy_id

string · uuid · required

Unique identifier for the policy

suspension_actions

string[] · minItems: 1 · required

Array of suspension actions to filter applicable suspensions

Enum values:

Suspend Binding Authority

Suspend Application Submission

Suspend Quoting

Suspend Straight Through Processing

Suspend Endorsement

Suspend Cancellation

get_policy_applicable_suspensions › Responses

200

object[]

Array of applicable suspensions for the given policy and suspension actions

action

string · enum · required

The suspension action type

Enum values:

Suspend Binding Authority

Suspend Application Submission

Suspend Quoting

Suspend Straight Through Processing

Suspend Endorsement

Suspend Cancellation

id

string

Unique identifier for the suspension

object

start_date

string · date

Suspension start date

end_date

string · date

Suspension end date

description

string

Suspension description

object[]

Array of rules that define when this suspension applies

POST/api/v2/suspensions/get_policy_applicable_suspensions

curl --request POST \
  --url /api/v2/suspensions/get_policy_applicable_suspensions \
  --header 'Content-Type: application/json' \
  --data '
{
  "policy_id": "00000000-0000-0000-0000-000000000000",
  "suspension_actions": [
    "Suspend Binding Authority"
  ]
}
'

Example Request Body

{
  "policy_id": "00000000-0000-0000-0000-000000000000",
  "suspension_actions": [
    "Suspend Binding Authority"
  ]
}

json

Example Responses

[
  {
    "id": "id",
    "action": "Suspend Binding Authority",
    "contact": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name"
    },
    "start_date": "2024-08-25",
    "end_date": "2024-08-25",
    "description": "description",
    "rules": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "suspension_id": "00000000-0000-0000-0000-000000000000",
        "rule_type": "ZIP_CODE",
        "policy_type_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "line_id": "00000000-0000-0000-0000-000000000000",
        "policy_type_item_id": "00000000-0000-0000-0000-000000000000",
        "subline_id": "00000000-0000-0000-0000-000000000000",
        "zipcode": "zipcode",
        "county": "county"
      }
    ]
  }
]

json

application/json

get_revision_suspensions

POST

/api/v2/suspensions/get_revision_suspensions

get_revision_suspensions

get_revision_suspensions › Request Body

get_revision_suspensions › Responses

200

success

boolean

message

string[]

data

object

get_user_suspensions_with_geometries

POST

/api/v2/suspensions/get_user_suspensions_with_geometries

get_user_suspensions_with_geometries

get_user_suspensions_with_geometries › Request Body

Request schema for /api/v2/suspensions/get_user_suspensions_with_geometries

request-get_user_suspensions_with_geometries

date

string · pattern: ^(0[1-9]|1[0-2])-(0[… · required

Date to filter suspensions in MM-DD-YYYY format

state

string · pattern: ^[A-Z]{2}$ · required

2-letter state abbreviation to filter suspensions

get_user_suspensions_with_geometries › Responses

200

Response schema for /api/v2/suspensions/get_user_suspensions_with_geometries

response-get_user_suspensions_with_geometries

object[] · required

Array of suspension objects with geometry data

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/suspensions/get_user_suspensions_with_geometries

curl --request POST \
  --url /api/v2/suspensions/get_user_suspensions_with_geometries \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "09-03-2025",
  "state": "MA"
}
'

Example Request Body

{
  "date": "09-03-2025",
  "state": "MA"
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "action": "Suspend Quoting",
      "contact": {
        "id": "id",
        "name": "name"
      },
      "start_date": "2024-08-25",
      "end_date": "2024-08-25",
      "description": "description",
      "geometry": null,
      "rules": [
        {
          "id": "id",
          "suspension_id": "suspension_id",
          "rule_type": "ZIP_CODE",
          "zipcode": "string",
          "county": "string",
          "policy_type_id": "string",
          "location_id": "string",
          "line_id": "string",
          "policy_type_item_id": "string",
          "subline_id": "string",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  0
                ]
              ]
            ]
          }
        }
      ]
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

list_suspensions

POST

/api/v2/suspensions/list_suspensions

list_suspensions

list_suspensions › Request Body

list_suspensions › Responses

200

success

boolean

message

string[]

data

object

update_suspension

POST

/api/v2/suspensions/update_suspension

update_suspension

update_suspension › Request Body

update_suspension › Responses

200

success

boolean

message

string[]

data

object

summaries tasks