MENU navbar-image

Introduction

The Conduit API provides a simple way to start uploading your policy and commission data into any agency management system.

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Commercial Auto

Store a newly created commercial auto policy.

Example request:
curl --request POST \
    "https://localhost:8000/api/api/commercial-auto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"transaction_type\": \"NBS\",
    \"transaction_date\": \"01-15-2023\",
    \"transaction_effective_date\": \"01-15-2023\",
    \"insured\": {
        \"name_type\": \"Commercial\",
        \"first_name\": \"John\",
        \"middle_name\": \"Anthony\",
        \"last_name\": \"Smith\",
        \"company_name\": \"ABC Company Inc\",
        \"mailing_address\": {
            \"street_address_line1\": \"123 Main St\",
            \"street_address_line2\": \"Suite 100\",
            \"city\": \"New York\",
            \"state_province_abbreviation\": \"NY\",
            \"zip_code\": \"10001\"
        }
    },
    \"policy\": {
        \"policy_number\": \"POL123456789\",
        \"company_code\": \"placeat\",
        \"renewal_term\": \"1\",
        \"current_term_amount\": \"1500.00\",
        \"billing_method_code\": \"A\",
        \"policy_effective_date\": \"01-15-2023\",
        \"policy_expiration_date\": \"01-15-2024\",
        \"controlling_state\": \"NY\",
        \"operations_business_description\": \"Commercial Trucking\",
        \"additional_other_interests\": [
            \"possimus\"
        ],
        \"forms\": [
            \"sed\"
        ],
        \"states\": [
            {
                \"locations\": [
                    {
                        \"street_address_line1\": \"empalftxjnevvt\",
                        \"street_address_line2\": \"utlbycywzsurqxvtdhkiqs\",
                        \"city\": \"l\",
                        \"state_province_abbreviation\": \"AR\",
                        \"zip_code\": \"xyeddcp\",
                        \"unit_at_risk\": [
                            {
                                \"vehicle_year\": \"tz\",
                                \"vehicle_make\": \"hssgikrjbisazglrzxk\",
                                \"vehicle_model\": \"tqtbbqtm\",
                                \"vehicle_body_type_code\": \"MISUV\",
                                \"vin\": \"vjzewdqixwaaefgxzbxqi\",
                                \"vehicle_registration_state\": \"MD\",
                                \"rating_territory\": \"a\",
                                \"cost_new\": 136,
                                \"vehicle_use_code\": \"01\",
                                \"gvw_gcw\": \"jrrdbwwaax\",
                                \"garage_city\": \"kvbtadutr\",
                                \"garage_state_province_abbreviation\": \"MS\",
                                \"garage_zip_code\": \"selpjlkui\",
                                \"total_vehicle_full_term_premium\": 6.76669,
                                \"garage_street_line_1\": \"eybsmzinjqiwhnhbgkjuzqqpn\",
                                \"garage_street_line_2\": \"kl\",
                                \"coverage\": [
                                    {
                                        \"code\": \"UMCSL\",
                                        \"limit\": 57537159.7,
                                        \"deductible\": 2,
                                        \"deductible_type_code\": \"OC\",
                                        \"current_term_amount\": 10.06953297,
                                        \"description\": \"Eveniet nesciunt laboriosam a quos ullam earum.\"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    },
    \"drivers\": [
        \"deleniti\"
    ]
}"
const url = new URL(
    "https://localhost:8000/api/api/commercial-auto"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "transaction_type": "NBS",
    "transaction_date": "01-15-2023",
    "transaction_effective_date": "01-15-2023",
    "insured": {
        "name_type": "Commercial",
        "first_name": "John",
        "middle_name": "Anthony",
        "last_name": "Smith",
        "company_name": "ABC Company Inc",
        "mailing_address": {
            "street_address_line1": "123 Main St",
            "street_address_line2": "Suite 100",
            "city": "New York",
            "state_province_abbreviation": "NY",
            "zip_code": "10001"
        }
    },
    "policy": {
        "policy_number": "POL123456789",
        "company_code": "placeat",
        "renewal_term": "1",
        "current_term_amount": "1500.00",
        "billing_method_code": "A",
        "policy_effective_date": "01-15-2023",
        "policy_expiration_date": "01-15-2024",
        "controlling_state": "NY",
        "operations_business_description": "Commercial Trucking",
        "additional_other_interests": [
            "possimus"
        ],
        "forms": [
            "sed"
        ],
        "states": [
            {
                "locations": [
                    {
                        "street_address_line1": "empalftxjnevvt",
                        "street_address_line2": "utlbycywzsurqxvtdhkiqs",
                        "city": "l",
                        "state_province_abbreviation": "AR",
                        "zip_code": "xyeddcp",
                        "unit_at_risk": [
                            {
                                "vehicle_year": "tz",
                                "vehicle_make": "hssgikrjbisazglrzxk",
                                "vehicle_model": "tqtbbqtm",
                                "vehicle_body_type_code": "MISUV",
                                "vin": "vjzewdqixwaaefgxzbxqi",
                                "vehicle_registration_state": "MD",
                                "rating_territory": "a",
                                "cost_new": 136,
                                "vehicle_use_code": "01",
                                "gvw_gcw": "jrrdbwwaax",
                                "garage_city": "kvbtadutr",
                                "garage_state_province_abbreviation": "MS",
                                "garage_zip_code": "selpjlkui",
                                "total_vehicle_full_term_premium": 6.76669,
                                "garage_street_line_1": "eybsmzinjqiwhnhbgkjuzqqpn",
                                "garage_street_line_2": "kl",
                                "coverage": [
                                    {
                                        "code": "UMCSL",
                                        "limit": 57537159.7,
                                        "deductible": 2,
                                        "deductible_type_code": "OC",
                                        "current_term_amount": 10.06953297,
                                        "description": "Eveniet nesciunt laboriosam a quos ullam earum."
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "drivers": [
        "deleniti"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "message": "Commercial auto policy created successfully",
    "policy_id": 12345
}
 

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "transaction_type": [
            "The transaction type field is required."
        ]
    }
}
 

Request      

POST api/commercial-auto

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

transaction_type   string   

The transaction type. Must be one of: NBQ (New Business Quote), NBS (New Business), PCH (Policy Change/Endorsement), REN (Renewal), RWL (Renewal Policy), RWQ (Renewal Quote). Example: NBS

transaction_date   string   

The date of which this download was created in format m-d-Y. Example: 01-15-2023

transaction_effective_date   string   

The effective date of the transacion. For New Business policies, this should be the effective date in format m-d-Y. Example: 01-15-2023

insured   object   

The insured information.

name_type   string   

The type of name. Must be one of: Commercial, Personal. Example: Commercial

first_name   string  optional  

The insured's first name. Required if name_type is Personal. Example: John

middle_name   string  optional  

nullable The insured's middle name. Example: Anthony

last_name   string  optional  

The insured's last name. Required if name_type is Personal. Example: Smith

company_name   string  optional  

The company name. Required if name_type is Commercial. Example: ABC Company Inc

mailing_address   object   

The insured's mailing address.

street_address_line1   string   

The street address line 1. Maximum length: 30. Example: 123 Main St

street_address_line2   string  optional  

nullable The street address line 2. Maximum length: 30. Example: Suite 100

city   string   

The city. Maximum length: 19. Example: New York

state_province_abbreviation   string   

The state abbreviation. Example: NY

zip_code   string   

The 5 digit zip code. Maximum length: 5. Example: 10001

policy   object   

The policy information.

policy_number   string   

The policy number. Maximum length: 25. Example: POL123456789

company_code   string   

The NAIC code of the issuing carrier. Maximum length: 6. Example 123456 Example: placeat

renewal_term   string  optional  

nullable The renewal term of this policy. If this is the first renewal of a policy, it should be 1. Maximum length: 3. Example: 1

current_term_amount   numeric   

The current term premium amount. Example: 1500.00

billing_method_code   string   

The billing method code. Must be one of: A (Agency Billed), C (Company Policy Billed). Example: A

policy_effective_date   string   

The policy effective date in format m-d-Y. Example: 01-15-2023

policy_expiration_date   string   

The policy expiration date in format m-d-Y. Example: 01-15-2024

controlling_state   string   

The controlling state code of which the policy is issued. Example: NY

operations_business_description   string   

The business description of the insured. Maximum length: 30. Example: Commercial Trucking

additional_other_interests   string[]  optional  

nullable Additional or other interests.

nature_of_interest_code   string   

Example: LP

Must be one of:
  • AI
  • AN
  • IL
  • LH
  • LP
  • OT
name_type   string   

Example: Personal

Must be one of:
  • Commercial
  • Personal
first_name   string  optional  

This field is required when policy.additional_other_interests.*.name_type is Personal. Example: iure

middle_name   string  optional  

Example: aut

last_name   string  optional  

This field is required when policy.additional_other_interests.*.name_type is Personal. Example: ullam

company_name   string  optional  

This field is required when policy.additional_other_interests.*.name_type is Commercial. Example: alias

interest_holder_account_number   string  optional  

Must not be greater than 25 characters. Example: carzxlool

street_address_line1   string  optional  

Must not be greater than 30 characters. Example: hyteeswlqgbcsy

street_address_line2   string  optional  

Must not be greater than 30 characters. Example: zjcgryntuyzlqqdqsy

city   string  optional  

Must not be greater than 19 characters. Example: hhffeadpibgrhutiq

state_province_abbreviation   string  optional  

Example: NE

Must be one of:
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
zip_code   string  optional  

Must not be greater than 9 characters. Example: jjh

*   object  optional  
nature_of_interest_code   string   

The nature of interest code. Must be one of: AI (Additional Insured), AN (Additional Named Insured), IL (Additional Insured and Leinholder), LH (Leinholder), LP (Loss Payee), OT (Other). Example: AI

name_type   string   

The type of name. Must be one of: Commercial, Personal. Example: Commercial

first_name   string  optional  

nullable The first name. Required if name_type is Personal. Example: Jane

middle_name   string  optional  

nullable The middle name. Example: B

last_name   string  optional  

nullable The last name. Required if name_type is Personal. Example: Doe

company_name   string  optional  

nullable The company name. Required if name_type is Commercial. Example: XYZ Leasing LLC

interest_holder_account_number   string  optional  

nullable The interest holder account number. Maximum length: 25. Example: ACCT12345

street_address_line1   string  optional  

nullable The street address line 1. Maximum length: 30. Example: 123 Main St

street_address_line2   string  optional  

nullable The street address line 2. Maximum length: 30. Example: Suite 100

city   string  optional  

nullable The city. Maximum length: 19. Example: New York

state_province_abbreviation   string  optional  

nullable The state abbreviation. Example: NY

zip_code   string  optional  

nullable The 5 digit zip code. Maximum length: 5. Example: 10001

forms   string[]  optional  

nullable The policy forms.

form_number   string   

Must not be greater than 10 characters. Example: amizjcdh

form_name   string   

Must not be greater than 50 characters. Example: fezirztqhatv

form_edition_date   string   

Must be a valid date in the format m-d-Y. Example: 04-11-2025

*   object  optional  
form_number   string  optional  

nullable The form number. Maximum length: 10. Example: CA0001

form_name   string  optional  

nullable The form name. Maximum length: 50. Example: Business Auto Coverage Form

form_edition_date   string  optional  

nullable The form edition date in format m-d-Y. Example: 10-01-2020

states   string[]   

The state information.

state   string   

Example: LA

Must be one of:
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
company_code   string   

Must not be greater than 6 characters. Example: exye

locations   object[]   
street_address_line1   string   

Must not be greater than 30 characters. Example: empalftxjnevvt

street_address_line2   string  optional  

Must not be greater than 30 characters. Example: utlbycywzsurqxvtdhkiqs

city   string   

Must not be greater than 19 characters. Example: l

state_province_abbreviation   string   

Example: AR

Must be one of:
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
zip_code   string   

Must not be greater than 9 characters. Example: xyeddcp

unit_at_risk   object[]   
vehicle_year   string   

Must not be greater than 4 characters. Example: tz

vehicle_make   string   

Must not be greater than 20 characters. Example: hssgikrjbisazglrzxk

vehicle_model   string   

Must not be greater than 20 characters. Example: tqtbbqtm

vehicle_body_type_code   string   

Example: MISUV

Must be one of:
  • 2DRHT
  • 4DRHT
  • 4WD
  • ANTQ
  • AMBE
  • AMBNE
  • ARPTL
  • CHRTB
  • OTHSB
  • ARPTB
  • CHRHB
  • ICTYB
  • OTHB
  • PPILB
  • PSPS
  • SSEEB
  • URBNB
  • CDSDC
  • CDSW
  • CONVT
  • COUPE
  • FDNP
  • FDP
  • FNRE
  • FNRFC
  • FNRH
  • FNRL
  • FNRN
  • FPCPR
  • HATCH
  • LEAM
  • LEAP
  • LENN
  • L
  • MCYC
  • MTRHM
  • MH22
  • MHTR
  • MH23
  • PPIL
  • PPRC
  • PPRCF
  • PU
  • PUCM
  • PVNOC
  • SDSD
  • SDSW
  • SEDAN
  • SMEF
  • SMEN
  • SSEMP
  • SSOTH
  • STAWG
  • TAXI
  • TCDSD
  • TCDSW
  • ST
  • SHRMT
  • SRVT
  • DMPT
  • T
  • DMPST
  • TRA&E
  • TREMO
  • TREMP
  • DMPTK
  • TK
  • TKTR
  • PANVN
  • VAN
  • CRGVN
  • STPVN
  • UTIL
  • WDWVN
  • VANPE
  • VANPO
  • OT
  • GOLFM
  • SNOWM
  • SUV
  • COSUV
  • MISUV
  • CRSUV
  • MSSUV
  • LFSUV
  • LXSUV
  • ORSUV
  • TRSUV
  • HYSUV
  • ATRAN
  • CUSTM
  • FDTRK
  • FRMTR
  • HMTRK
  • LAWNC
  • LTRAN
  • SERVT
vin   string   

Must not be greater than 25 characters. Example: vjzewdqixwaaefgxzbxqi

vehicle_registration_state   string   

Example: MD

Must be one of:
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
rating_territory   string  optional  

Must not be greater than 4 characters. Example: a

cost_new   number  optional  

Example: 136

vehicle_use_code   string   

Example: 01

Must be one of:
  • 01
  • 02
  • 03
  • 04
  • 05
  • 06
  • 07
  • DC
  • FH
  • PS
  • OT
gvw_gcw   string  optional  

Must not be greater than 10 characters. Example: jrrdbwwaax

garage_city   string   

Must not be greater than 19 characters. Example: kvbtadutr

garage_state_province_abbreviation   string   

Example: MS

Must be one of:
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
garage_zip_code   string   

Must not be greater than 9 characters. Example: selpjlkui

total_vehicle_full_term_premium   number   

Example: 6.76669

garage_street_line_1   string   

Must not be greater than 30 characters. Example: eybsmzinjqiwhnhbgkjuzqqpn

garage_street_line_2   string  optional  

Must not be greater than 30 characters. Example: kl

coverage   object[]   
code   string   

Example: UMCSL

Must be one of:
  • COMP
  • COLL
  • PD
  • MEPM
  • BIOP
  • CSL
  • MTC
  • HNA
  • UMCSL
limit   number  optional  

Example: 57537159.7

deductible   number  optional  

Must not be greater than 8. Example: 2

deductible_type_code   string  optional  

Example: OC

Must be one of:
  • A
  • C
  • FL
  • OC
current_term_amount   number   

Example: 10.06953297

description   string  optional  

Must not be greater than 60 characters. Example: Eveniet nesciunt laboriosam a quos ullam earum.

*   object  optional  
state   string   

The state code. Example: NY

company_code   string   

The NAIC code of the issuing carrier. Maximum length: 6. Example: 123456

locations   string[]   

The location information.

*   object  optional  
street_address_line1   string   

The street address line 1. Maximum length: 30. Example: 123 Main St

street_address_line2   string  optional  

nullable The street address line 2. Maximum length: 30. Example: Suite 100

city   string   

The city. Maximum length: 19. Example: New York

state_province_abbreviation   string   

The state abbreviation. Example: NY

zip_code   string   

The 5 digit zip code. Maximum length: 5. Example: 10001

unit_at_risk   string[]   

The vehicle information.

*   object  optional  
vehicle_year   string   

The vehicle year. Maximum length: 4. Example: 2022

vehicle_make   string   

The vehicle make. Maximum length: 20. Example: Ford

vehicle_model   string   

The vehicle model. Maximum length: 20. Example: F-150

vehicle_body_type_code   string   

The vehicle body type code. Must be one of: 2DRHT (Two-Door Hardtop), 4DRHT (Four-Door Hardtop), 4WD (Four-Wheel Drive), ANTQ (Antique Autos), AMBE (Ambulance - emergency), AMBNE (Ambulance - non emergency), ARPTL (Airport Limousine), CHRTB (Charter Bus), OTHSB (Other School Bus), ARPTB (Airport Bus), CHRHB (Church Bus), ICTYB (Inter City Bus), OTHB (Buses Otherwise Not Classified), PPILB (Private Passenger Rated from CLM, Business Use - Illinois Only), PSPS (School Bus Owned by Political Subdivision or School District), SSEEB (Sightseeing Bus), URBNB (Urban Bus), CDSDC (Commercial Driving School with Dual Controls), CDSW (Commercial Driving School without Dual Controls), CONVT (Convertible), COUPE (Coupe), FDNP (Fire Departments - non-PPT), FDP (Fire Departments - PPT), FNRE (Funeral - combination Hearse-Ambulance, Emergency), FNRFC (Funeral Flower Car), FNRH (Funeral Hearse), FNRL (Funeral Limousine), FNRN (Funeral - combination Hearse-Ambulance, non-Emergency), FPCPR (Folding or Pop-up Campers), HATCH (Hatch Back), LEAM (Law Enforcement Agency - Motorcycle), LEAP (Law Enforcement Agency - PPT), LENN (Law Enforcement Agency - non-PPT, non-Motorcycle), L (Limousine), MCYC (Motorcycle), MTRHM (Motor Home), MH22 (Mobile Home - 22 feet or less), MHTR (Mobile Home Trailer), MH23 (Mobile Home - over 22 feet), PPIL (Private Passenger Rated from CLM, Pleasure Use - Illinois Only), PPRC (Private Passenger Rated from CLM), PPRCF (Private Passenger Rated from CLM - Farm), PU (Pickup Truck), PUCM (Pick-up Truck - used solely to transport camper bodies), PVNOC (Public Vehicle Not Otherwise Classified), SDSD (School Driver Training with Dual Controls), SDSW (School Driver Training without Dual Controls), SEDAN (Sedan), SMEF (Special or Mobile Equipment - Farm), SMEN (Special or Mobile Equipment - non-Farm), SSEMP (Social Services Auto - Employee Operated), SSOTH (Social Services Auto - all other), STAWG (Stationwagon), TAXI (Taxi), TCDSD (Commercial Driving School with Dual Controls - Trucks-Tractors-Trailers), TCDSW (Commercial Driving School without Dual Controls - Trucks-Tractors-Trailers), ST (Semi-Trailer), SHRMT (Showroom Trailer), SRVT (Service or Utility Trailer), DMPT (Dump Trailer), T (Trailer), DMPST (Dump Semi-Trailer), TRA&E (Transportation of Athletes and Entertainers), TREMO (Transportation of Employees - all other), TREMP (Transportation of Employees - PPT), DMPTK (Dump Truck), TK (Truck), TKTR (Truck-Tractor), PANVN (Panel Van), VAN (Van), CRGVN (Cargo Van), STPVN (Step Van), UTIL (Utility Van), WDWVN (Window Van), VANPE (Van Pools - Employer Furnished), VANPO (Van Pools - all other), OT (Other), GOLFM (Golfmobile), SNOWM (Snowmobile), SUV (Sport Utility Vehicle), COSUV (Compact SUV), MISUV (Mini SUV), CRSUV (Crossover SUV), MSSUV (Mid-size SUV), LFSUV (Large/Full-size SUV), LXSUV (Luxury SUV), ORSUV (Off-road SUV), TRSUV (Truck-like SUV), HYSUV (Hybrid SUV), ATRAN (Automobile Transporter), CUSTM (Custom Built Car), FDTRK (Food Truck), FRMTR (Farming/Agriculture Tractor), HMTRK (Highway Maintenance Truck), LAWNC (Lawn Cutter), LTRAN (Livestock Transporter), SERVT (Service Truck). Example: PU

vin   string   

The vehicle identification number. Maximum length: 25. Example: 1FTFW1ET5DFA38105

vehicle_registration_state   string   

The vehicle registration state. Example: NY

rating_territory   string  optional  

nullable The rating territory. Maximum length: 4. Example: 001

cost_new   numeric  optional  

nullable The cost when new. Example: 45000

vehicle_use_code   string   

The vehicle use code. Must be one of: 01 (Service), 02 (Commercial), 03 (Retail), 04 (Drive to Work or School Under 15 Miles), 05 (Drive to Work or School Over 15 Miles), 06 (Pleasure), 07 (Farm), DC (Day Care Center), FH (For Hire), PS (Private Passenger), OT (Other). Example: 01

gvw_gcw   string  optional  

nullable The gross vehicle weight/gross combined weight. Maximum length: 10. Example: 10000

garage_city   string   

The garage city. Maximum length: 19. Example: New York

garage_state_province_abbreviation   string   

The garage state abbreviation. Example: NY

garage_zip_code   string   

The garage zip code. Maximum length: 9. Example: 10001

total_vehicle_full_term_premium   numeric   

The total vehicle full term premium. Example: 1200.00

garage_street_line_1   string   

The garage street line 1. Maximum length: 30. Example: 123 Main St

garage_street_line_2   string  optional  

nullable The garage street line 2. Maximum length: 30. Example: Suite 100

coverage   string[]   

The coverage information.

*   object  optional  
code   string   

The coverage code. Must be one of: COMP (Comprehensive), COLL (Collision), PD (Property Damage), MEPM (Medical Payments), BIOP (Bodily Injury), CSL (Combined Single Limit), MTC (Motor Truck Cargo), HNA (Hired/Non-Owned Automobile Combined), UMCSL (Uninsured Motorist Combined Single Limit). Example: COMP

limit   numeric  optional  

nullable The coverage limit. Example: 1000000

deductible   numeric  optional  

nullable The deductible amount. Maximum: 8 digits. Example: 1000

deductible_type_code   string  optional  

nullable The deductible type code. Must be one of: A (Per Accident), C (Per Claim), FL (Flat), OC (Per Occurrence). Example: A

current_term_amount   numeric   

The current term amount. Example: 500.00

description   string  optional  

nullable The coverage description. Maximum length: 60. Example: Comprehensive coverage with $1000 deductible

drivers   string[]  optional  

nullable The driver information.

name_type   string   

Example: Commercial

Must be one of:
  • Commercial
  • Personal
first_name   string  optional  

This field is required when drivers.*.name_type is Personal. Example: et

last_name   string  optional  

This field is required when drivers.*.name_type is Personal. Example: quia

driver_license_number   string  optional  

Must not be greater than 25 characters. Example: ejyerrozrbfdboks

license_state   string  optional  

Example: FL

Must be one of:
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
*   object  optional  
name_type   string   

The type of name. Must be one of: Commercial, Personal. Example: Personal

first_name   string  optional  

nullable The first name. Required if name_type is Personal. Example: John

last_name   string  optional  

nullable The last name. Required if name_type is Personal. Example: Smith

driver_license_number   string  optional  

nullable The driver license number. Maximum length: 25. Example: DL123456789

license_state   string  optional  

nullable The state of which the drivers license is issued. Example: NY

Commissions

Display a listing of all uploaded commissions.

requires authentication

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/commissions?page=1&per_page=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/commissions"
);

const params = {
    "page": "1",
    "per_page": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/commissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

The page number. Example: 1

per_page   integer  optional  

Number of items per page. Example: 15

Creating a new commission upload.

requires authentication

Example request:
curl --request POST \
    "https://localhost:8000/api/api/commissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"insureds_name\": \"John Doe\",
    \"policy_number\": \"POL123\",
    \"line_of_business_code\": \"BOP\",
    \"carrier_naics_code\": \"10001\",
    \"transaction_effective_date\": \"01-01-2023\",
    \"policy_effective_date\": \"01-01-2023\",
    \"policy_expiration_date\": \"01-01-2024\",
    \"policy_gross_amount\": 1000,
    \"commission_rate\": 15,
    \"commission_amount\": 150,
    \"receiver_npn_number\": \"123456\",
    \"transaction_type_code\": \"NBS\"
}"
const url = new URL(
    "https://localhost:8000/api/api/commissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "insureds_name": "John Doe",
    "policy_number": "POL123",
    "line_of_business_code": "BOP",
    "carrier_naics_code": "10001",
    "transaction_effective_date": "01-01-2023",
    "policy_effective_date": "01-01-2023",
    "policy_expiration_date": "01-01-2024",
    "policy_gross_amount": 1000,
    "commission_rate": 15,
    "commission_amount": 150,
    "receiver_npn_number": "123456",
    "transaction_type_code": "NBS"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/commissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

insureds_name   string   

The name of the insured. Example: John Doe

policy_number   string   

The policy number. Example: POL123

line_of_business_code   string   

The code for the line of business. See /line-of-business-codes endpoint for a list of codes. Example: BOP

carrier_naics_code   string   

The NAICS code of the issuing carrier. See /carrier-naics-codes endpoint for a list of codes. Example: 10001

transaction_effective_date   string   

The transaction effective date (mm-dd-yyyy). Example: 01-01-2023

policy_effective_date   string   

The policy effective date (mm-dd-yyyy). Example: 01-01-2023

policy_expiration_date   string   

The policy expiration date (mm-dd-yyyy). Example: 01-01-2024

policy_gross_amount   number   

The policy gross amount. Example: 1000

commission_rate   number   

The commission rate. Example: 15

commission_amount   number   

The commission amount. Example: 150

receiver_npn_number   string   

The agency NPN number. Example: 123456

transaction_type_code   string   

The transaction type code. See /transaction-type-codes endpoint for list of codes. Example: NBS

Connection Management

Display a listing of the resource.

requires authentication

Returns a list of accepted connections for the authenticated company.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/connections" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/connections"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "connections": [
        {
            "status": "accepted",
            "company": {
                "name": "Example Company",
                "email": "example@company.com",
                "phone_number": "555-555-5555",
                "type": "carrier",
                "npn_number": "1234567"
            },
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z"
        }
    ]
}
 

Request      

GET api/connections

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Endpoints

Display a listing of the resource.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/commercial-auto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/commercial-auto"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/commercial-auto

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Show the form for creating a new resource.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/commercial-auto/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/commercial-auto/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/commercial-auto/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Display the specified resource.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/commercial-auto/optio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/commercial-auto/optio"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/commercial-auto/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the commercial auto. Example: optio

Show the form for editing the specified resource.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/commercial-auto/et/edit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/commercial-auto/et/edit"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/commercial-auto/{commercial_auto}/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

commercial_auto   string   

Example: et

Update the specified resource in storage.

Example request:
curl --request PUT \
    "https://localhost:8000/api/api/commercial-auto/sed" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/commercial-auto/sed"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/commercial-auto/{id}

PATCH api/commercial-auto/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the commercial auto. Example: sed

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "https://localhost:8000/api/api/commercial-auto/eligendi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/commercial-auto/eligendi"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/commercial-auto/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the commercial auto. Example: eligendi

Memos

Display a listing of memos.

requires authentication

Returns a list of all memos.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/memo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/memo"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "carrier_name": "State Farm",
        "carrier_naics_code": "123456789",
        "policy_number": "SF123456789",
        "notice_date": "2024-01-15",
        "due_date": "2024-02-15",
        "notice_type": "Cancellation Notice",
        "notice_reason": "Non-payment",
        "line_of_business": "Personal Auto",
        "named_insured": "John Doe",
        "amount_due": "523.45",
        "total_balance": "1045.90",
        "agency_npn": "12345678"
    }
]
 

Request      

GET api/memo

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a new memo.

requires authentication

Creates a new memo and stores it in the database.

Example request:
curl --request POST \
    "https://localhost:8000/api/api/memo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"carrier_name\": \"State Farm\",
    \"carrier_naics_code\": \"123456789\",
    \"policy_number\": \"SF123456789\",
    \"notice_date\": \"2024-01-15\",
    \"due_date\": \"2024-02-15\",
    \"notice_type\": \"Cancellation Notice\",
    \"notice_reason\": \"Non-payment\",
    \"line_of_business\": \"Personal Auto\",
    \"insureds_name\": \"autem\",
    \"amount_due\": \"523.45\",
    \"total_balance\": \"1045.90\",
    \"agency_npn\": \"12345678\",
    \"named_insured\": \"John Doe\"
}"
const url = new URL(
    "https://localhost:8000/api/api/memo"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "carrier_name": "State Farm",
    "carrier_naics_code": "123456789",
    "policy_number": "SF123456789",
    "notice_date": "2024-01-15",
    "due_date": "2024-02-15",
    "notice_type": "Cancellation Notice",
    "notice_reason": "Non-payment",
    "line_of_business": "Personal Auto",
    "insureds_name": "autem",
    "amount_due": "523.45",
    "total_balance": "1045.90",
    "agency_npn": "12345678",
    "named_insured": "John Doe"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "carrier_name": "State Farm",
    "carrier_naics_code": "123456789",
    "policy_number": "SF123456789",
    "notice_date": "2024-01-15",
    "due_date": "2024-02-15",
    "notice_type": "Cancellation Notice",
    "notice_reason": "Non-payment",
    "line_of_business": "Personal Auto",
    "named_insured": "John Doe",
    "amount_due": 523.45,
    "total_balance": 1045.9,
    "agency_npn": "12345678",
    "created_at": "2024-02-20T12:00:00.000000Z",
    "updated_at": "2024-02-20T12:00:00.000000Z"
}
 

Request      

POST api/memo

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

carrier_name   string   

The insurance carrier name. Example: State Farm

carrier_naics_code   string  optional  

The insurance carrier NAICS code. Example: 123456789

policy_number   string   

The policy number. Example: SF123456789

notice_date   date   

The date of the notice. Example: 2024-01-15

due_date   date  optional  

The due date for the notice. Example: 2024-02-15

notice_type   string  optional  

The type of notice. Example: Cancellation Notice

notice_reason   string  optional  

The reason for the notice. Example: Non-payment

line_of_business   string   

The line of business. Example: Personal Auto

insureds_name   string   

Example: autem

amount_due   numeric  optional  

The amount due on the notice. Example: 523.45

total_balance   numeric  optional  

The total balance. Example: 1045.90

agency_npn   string   

The agency NPN. Example: 12345678

named_insured   string   

The name of the insured. Example: John Doe

Standard Codes

List of line of business codes

requires authentication

Returns an array of line of business codes and their corresponding descriptions. Each item contains a "code" and "description" field.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/line-of-business-codes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/line-of-business-codes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "code_value": "BOP",
            "code_description": "Business owners"
        },
        {
            "code_value": "HOME",
            "code_description": "Homeowners"
        }
    ]
}
 

Request      

GET api/line-of-business-codes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

List of carrier NAICS codes

requires authentication

Returns an array of carrier NAICS codes and their corresponding carrier names. Each item contains a "code" and "carrier_name" field.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/carrier-naics-codes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/carrier-naics-codes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "code": "10000",
            "carrier_name": "Commercial Mut Ins Co Ins Co"
        },
        {
            "code": "10002",
            "carrier_name": "Municipal Mut Ins Co"
        }
    ]
}
 

Request      

GET api/carrier-naics-codes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

List of transaction type codes

requires authentication

Returns an array of transaction type codes and their corresponding descriptions. Each item contains a "code_value" and "code_description" field.

Example request:
curl --request GET \
    --get "https://localhost:8000/api/api/transaction-type-codes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://localhost:8000/api/api/transaction-type-codes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "code_value": "NBS",
            "code_description": "New Business"
        },
        {
            "code_value": "RWL",
            "code_description": "Renewal"
        }
    ]
}
 

Request      

GET api/transaction-type-codes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json