openapi: 3.0.3 info: title: 'Conduit API' description: 'The Conduit API provides a simple way to start uploading your policy and commission data into any agency management system.' version: 1.0.0 servers: - url: 'http://conduituploads.com/api' paths: /api/commissions: get: summary: 'Display a listing of all uploaded commissions.' operationId: displayAListingOfAllUploadedCommissions description: '' parameters: - in: query name: page description: 'The page number.' example: 1 required: false schema: type: integer description: 'The page number.' example: 1 - in: query name: per_page description: 'Number of items per page.' example: 15 required: false schema: type: integer description: 'Number of items per page.' example: 15 responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Commissions post: summary: 'Creating a new commission upload.' operationId: creatingANewCommissionUpload description: '' parameters: [] responses: { } tags: - Commissions requestBody: required: true content: application/json: schema: type: object properties: insureds_name: type: string description: 'The name of the insured.' example: 'John Doe' policy_number: type: string description: 'The policy number.' example: POL123 line_of_business_code: type: string description: 'The code for the line of business. See /line-of-business-codes endpoint for a list of codes.' example: BOP carrier_naics_code: type: string description: 'The NAICS code of the issuing carrier. See /carrier-naics-codes endpoint for a list of codes.' example: '10001' transaction_effective_date: type: string description: 'The transaction effective date (mm-dd-yyyy).' example: 01-01-2023 policy_effective_date: type: string description: 'The policy effective date (mm-dd-yyyy).' example: 01-01-2023 policy_expiration_date: type: string description: 'The policy expiration date (mm-dd-yyyy).' example: 01-01-2024 policy_gross_amount: type: number description: 'The policy gross amount.' example: 1000.0 commission_rate: type: number description: 'The commission rate.' example: 15.0 commission_amount: type: number description: 'The commission amount.' example: 150.0 receiver_npn_number: type: string description: 'The agency NPN number.' example: '123456' transaction_type_code: type: string description: 'The transaction type code. See /transaction-type-codes endpoint for list of codes.' example: NBS required: - insureds_name - policy_number - line_of_business_code - carrier_naics_code - transaction_effective_date - policy_effective_date - policy_expiration_date - policy_gross_amount - commission_rate - commission_amount - receiver_npn_number - transaction_type_code /api/connections: get: summary: 'Display a listing of the resource.' operationId: displayAListingOfTheResource description: 'Returns a list of accepted connections for the authenticated company.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: 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' properties: connections: type: array example: - 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' items: type: object properties: status: type: string example: accepted company: type: object properties: name: type: string example: 'Example Company' email: type: string example: example@company.com phone_number: type: string example: 555-555-5555 type: type: string example: carrier npn_number: type: string example: '1234567' created_at: type: string example: '2024-01-01T00:00:00.000000Z' updated_at: type: string example: '2024-01-01T00:00:00.000000Z' tags: - 'Connection Management' /api/memo: get: summary: 'Display a listing of memos.' operationId: displayAListingOfMemos description: 'Returns a list of all memos.' parameters: [] responses: 200: description: '' content: application/json: schema: type: array items: type: object example: - 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' tags: - Memos post: summary: 'Store a new memo.' operationId: storeANewMemo description: 'Creates a new memo and stores it in the database.' parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: 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' properties: id: type: integer example: 1 carrier_name: type: string example: 'State Farm' carrier_naics_code: type: string example: '123456789' policy_number: type: string example: SF123456789 notice_date: type: string example: '2024-01-15' due_date: type: string example: '2024-02-15' notice_type: type: string example: 'Cancellation Notice' notice_reason: type: string example: Non-payment line_of_business: type: string example: 'Personal Auto' named_insured: type: string example: 'John Doe' amount_due: type: number example: 523.45 total_balance: type: number example: 1045.9 agency_npn: type: string example: '12345678' created_at: type: string example: '2024-02-20T12:00:00.000000Z' updated_at: type: string example: '2024-02-20T12:00:00.000000Z' tags: - Memos requestBody: required: true content: application/json: schema: type: object properties: carrier_name: type: string description: 'The insurance carrier name.' example: 'State Farm' carrier_naics_code: type: string description: 'The insurance carrier NAICS code.' example: '123456789' policy_number: type: string description: 'The policy number.' example: SF123456789 notice_date: type: date description: 'The date of the notice.' example: '2024-01-15' due_date: type: date description: 'The due date for the notice.' example: '2024-02-15' notice_type: type: string description: 'The type of notice.' example: 'Cancellation Notice' notice_reason: type: string description: 'The reason for the notice.' example: Non-payment line_of_business: type: string description: 'The line of business.' example: 'Personal Auto' insureds_name: type: string description: '' example: accusantium amount_due: type: numeric description: 'The amount due on the notice.' example: '523.45' total_balance: type: numeric description: 'The total balance.' example: '1045.90' agency_npn: type: string description: 'The agency NPN.' example: '12345678' named_insured: type: string description: 'The name of the insured.' example: 'John Doe' required: - carrier_name - policy_number - notice_date - line_of_business - insureds_name - agency_npn - named_insured /api/line-of-business-codes: get: summary: 'List of line of business codes' operationId: listOfLineOfBusinessCodes description: "Returns an array of line of business codes and their corresponding descriptions.\nEach item contains a \"code\" and \"description\" field." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: - code_value: BOP code_description: 'Business owners' - code_value: HOME code_description: Homeowners properties: data: type: array example: - code_value: BOP code_description: 'Business owners' - code_value: HOME code_description: Homeowners items: type: object properties: code_value: type: string example: BOP code_description: type: string example: 'Business owners' tags: - 'Standard Codes' /api/carrier-naics-codes: get: summary: 'List of carrier NAICS codes' operationId: listOfCarrierNAICSCodes description: "Returns an array of carrier NAICS codes and their corresponding carrier names.\nEach item contains a \"code\" and \"carrier_name\" field." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: - code: '10000' carrier_name: 'Commercial Mut Ins Co Ins Co' - code: '10002' carrier_name: 'Municipal Mut Ins Co' properties: data: type: array example: - code: '10000' carrier_name: 'Commercial Mut Ins Co Ins Co' - code: '10002' carrier_name: 'Municipal Mut Ins Co' items: type: object properties: code: type: string example: '10000' carrier_name: type: string example: 'Commercial Mut Ins Co Ins Co' tags: - 'Standard Codes' /api/transaction-type-codes: get: summary: 'List of transaction type codes' operationId: listOfTransactionTypeCodes description: "Returns an array of transaction type codes and their corresponding descriptions.\nEach item contains a \"code_value\" and \"code_description\" field." parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: - code_value: NBS code_description: 'New Business' - code_value: RWL code_description: Renewal properties: data: type: array example: - code_value: NBS code_description: 'New Business' - code_value: RWL code_description: Renewal items: type: object properties: code_value: type: string example: NBS code_description: type: string example: 'New Business' tags: - 'Standard Codes' tags: - name: Commissions description: '' - name: 'Connection Management' description: '' - name: Memos description: '' - name: 'Standard Codes' description: '' components: securitySchemes: default: type: http scheme: bearer description: 'You can retrieve your token by visiting your dashboard and clicking Generate API token.' security: - default: []