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."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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());
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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());
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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());
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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"
}
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.