Account

APIDescription
POST {version}/Account/TokenExchange

Exchanges .ASPXAUTH Cookies for a JSON Web Token

Agency

APIDescription
GET v1/Agency?Id={Id}&Name={Name}&ParentId={ParentId}&ParentName={ParentName}&LegalName={LegalName}&Limi...

Retrieve Agencies

GET v1/Agency/{id}

Retrieve Agency

POST v1/Agency

Create Agency

PUT v1/Agency/{id}

Update Agency

PUT v1/Agency/Deactivate/{id}

Deactivate Agency

PUT v1/Agency/Activate/{id}

Activate Agency

GET v1/Agency/{AgencyId}/BankAccounts

List Agency Bank Accounts

GET v1/Agency/{AgencyId}/BankAccounts/{BankAccountId}

Retrieve Agency Bank Account

DELETE v1/Agency/{AgencyId}/BankAccounts/{BankAccountId}

Delete Agency Bank Account

PUT v1/Agency/{AgencyId}/BankAccounts/{BankAccountId}

Update Bank Account Details

POST v1/Agency/{AgencyId}/BankAccounts

Save Bank Account Details for Agency

GET v1/Agency/{AgencyId}/Contact

List Agency Contacts

GET v1/Agency/{AgencyId}/Contact/{ContactId}

Retrieve Agency Contacts

DELETE v1/Agency/{AgencyId}/Contact/{ContactId}

Delete Agency Contact

PUT v1/Agency/{AgencyId}/Contact/{ContactId}

Update Agency Contact

POST v1/Agency/{AgencyId}/Contact

Add Agency Contact

Agents

APIDescription
GET v1/Agents?Id={Id}&Name={Name}&ParentId={ParentId}&ParentName={ParentName}&Limit={Limit}&Offset={Offs...

Retrieve agents

GET v1/Agents/{id}

Retrieve Agent

POST v1/Agents

Create Agent

GET v1/Agents/Groups

Retrieve Groups

PUT v1/Agents/{id}

Update Agent

PUT v1/Agents/Deactivate/{id}

Deactivate Agent

PUT v1/Agents/Activate/{id}

Activate Agent

Customers

APIDescription
GET v1/Customers?FirstName={FirstName}&LastName={LastName}&CommercialName={CommercialName}&CustomerId={C...

Customer Search

GET v1/Customers/Search?FullName={FullName}&CustomerType={CustomerType}&Email={Email}&Address1={Address1...

Customer Clearance Search

GET v1/Customers/{id}

Retrieve Customer

POST v1/Customers

Create Customer

PUT v1/Customers/{id}?updateIfNull={updateIfNull}

Update Customer

GET v1/Customers/{CustomerId}/Quotes?Id={Id}&CompleteQuote={CompleteQuote}&QuoteNumber={QuoteNumber}&Eff...

Retrieve Customer's Quotes

Document

APIDescription
GET v1/Documents

Document Search

GET v1/Documents/{id}

Document Download

Ledger

APIDescription
GET v1/Ledger?PolicyNumber={PolicyNumber}&ItemNumber={ItemNumber}&AccountingDate={AccountingDate}&Descri...

Ledger Search

Management

APIDescription
GET v1/Management/ping

Ping

PUT v1/Management/ping

Ping

PATCH v1/Management/ping

Ping

POST v1/Management/ping

Ping

DELETE v1/Management/ping

Ping

OPTIONS v1/Management/ping

Ping

HEAD v1/Management/ping

Ping

GET v1/Management/health

Self Health Check

Payment

APIDescription
GET v1/Payment/History?PolicyNumber={PolicyNumber}&ItemNumber={ItemNumber}&AccountingDate={AccountingDat...

Payment History

GET v1/Payment/Plan?LineOfBusiness={LineOfBusiness}&StateCode={StateCode}&ProductType={ProductType}&Univ...

Payment Plan Options

GET v1/Payment/InstallmentSchedule?NumberOfInstallments={NumberOfInstallments}&LineOfBusiness={LineOfBus...

Installment Schedule

GET v1/Payment/ActiveInstallmentSchedule?PolicyNumber={PolicyNumber}

Retrieve Active Installment Schedule

GET v1/Payment/Autopay?PolicyNumber={PolicyNumber}

Retrieve Autopay Info

GET v1/Payment/BillHistory?PolicyNumber={PolicyNumber}

Policy Bill History

POST v1/Payment/DisableAutoPay?PolicyNumber={PolicyNumber}

Disable Autopay for Policy

POST v1/Payment/UpdateAutoPayCC?PolicyNumber={PolicyNumber}

Update Autopay Credit Card Details

POST v1/Payment/UpdateAutoPayEFT?PolicyNumber={PolicyNumber}

Update Autopay EFT Details

POST v1/Payment/PostPaymentEFT

Post EFT payment

POST v1/Payment/PostPaymentCreditCard

Post Credit Card Payment

POST v1/Payment/PostPayment

Post Payment

GET v1/Payment/FindPolicyNumberByAPN?apnNo={apnNo}

Retrieve policy number that matches the given APN number

GET v1/Payment/FindQuoteNumberByAPN?apnNo={apnNo}

Retrieve quote number that matches the given APN number

PaymentAccount

APIDescription
GET v1/PaymentAccount/CreditCard?PolicyNumber={PolicyNumber}

Retrieve Credit Card Details

POST v1/PaymentAccount/CreditCard?PolicyNumber={PolicyNumber}

Save Credit Card Details

PUT v1/PaymentAccount/CreditCard?PolicyNumber={PolicyNumber}

Update Credit Card Details

DELETE v1/PaymentAccount/CreditCard?PolicyNumber={PolicyNumber}&CreditCardId={CreditCardId}

Delete Credit Card Details

GET v1/PaymentAccount/BankAccount?PolicyNumber={PolicyNumber}

Retrieve Bank Account Details

POST v1/PaymentAccount/BankAccount?PolicyNumber={PolicyNumber}

Save Bank Account Details

PUT v1/PaymentAccount/BankAccount?PolicyNumber={PolicyNumber}

Update Bank Account Details

DELETE v1/PaymentAccount/BankAccount?PolicyNumber={PolicyNumber}&EftId={EftId}

Delete Bank Account Details

Policy

Policy Management

APIDescription
GET v1/Policy/ReservePolicyNumber?LineOfBusiness={LineOfBusiness}&UnderwritingCompany={UnderwritingCompa...

Reserve the next available policy number

GET v1/Policy?Id={Id}&EffectiveDate={EffectiveDate}&ExpirationDate={ExpirationDate}&PolicyNumber={Policy...

Policy Search

GET v1/Policy/{PolicyNumber}?Term={Term}

Retrieve Policy

GET v1/Policy/{PolicyNumber}/Product/{Path}?Term={Term}&filter={filter}

Retrieve Policy Product Data

GET v1/Policy/{PolicyNumber}/Status?Term={Term}

Policy Status Retrieval

PUT v1/Policy/Cancel?PolicyNumber={PolicyNumber}&AmendEffDate={AmendEffDate}&Note={Note}&Term={Term}&Can...

Cancel Policy

PUT v1/Policy/DoNotReinstate?PolicyNumber={PolicyNumber}

Do Not Reinstate

PUT v1/Policy/ReverseDoNotReinstate?PolicyNumber={PolicyNumber}

Reverse Do Not Reinstate

POST v1/Policy/Rewrite?PolicyNumber={PolicyNumber}&Term={Term}&Note={Note}

Rewrite

PUT v1/Policy/ReinstateWithLapse?PolicyNumber={PolicyNumber}&AmendEffDate={AmendEffDate}&Term={Term}&Not...

Reinstate With Lapse

PUT v1/Policy/Reinstate?PolicyNumber={PolicyNumber}&ReinstateTypeId={ReinstateTypeId}&Term={Term}&Note={...

Reinstate

POST v1/Policy/Reissue?PolicyNumber={PolicyNumber}&Note={Note}

Reissue

POST v1/Policy/AddEarlyRenewal?PolicyNumber={PolicyNumber}&RenewalTypeId={RenewalTypeId}&Note={Note}

Add Early Renewal

PUT v1/Policy/DeleteEarlyRenewal?PolicyNumber={PolicyNumber}

Delete Early Renewal

PUT v1/Policy/DoNotRenew?PolicyNumber={PolicyNumber}

Do Not Renew

PUT v1/Policy/ReverseDoNotRenew?PolicyNumber={PolicyNumber}

Reverse Do Not Renew

POST v1/Policy

Create Policy

PUT v1/Policy/Amend?PolicyNumber={PolicyNumber}&amendEffDate={amendEffDate}&Term={Term}&note={note}

Update Policy

PATCH v1/Policy/Amend?PolicyNumber={PolicyNumber}&amendEffDate={amendEffDate}&Term={Term}&note={note}

Update Policy Partially

POST v1/Policy/Renew?PolicyNumber={PolicyNumber}&RenewalTypeId={RenewalTypeId}&Note={Note}

Renew Policy

Quote

Quote Management

APIDescription
GET v1/Quotes?Id={Id}&CompleteQuote={CompleteQuote}&QuoteNumber={QuoteNumber}&CustomerId={CustomerId}&Ef...

Quote Search

GET v1/Quotes/{QuoteNumber}

Retrieve Quote

GET v1/Quotes/{QuoteNumber}/Product/{Path}?filter={filter}

Retrieve Quote Product Data

GET v1/Quotes/{QuoteNumber}/Status

Retrieve Quote Status

POST v1/Quotes?suppressDocGen={suppressDocGen}

Create Quote

PATCH v1/Quotes?QuoteNumber={QuoteNumber}&suppressDocGen={suppressDocGen}

Update Quote Partially

PUT v1/Quotes?suppressDocGen={suppressDocGen}

Update Quote

PUT v1/Quotes/Issue?QuoteNumber={QuoteNumber}

Issue Policy from Quote

POST v1/Quotes/AssignPolicyNumber?QuoteNumber={QuoteNumber}

Assign and return policy number for early cash quote

Rate

APIDescription
POST v1/Rate/Quote?ratingValidation={ratingValidation}

Rate Quote

POST v1/Rate?ratingTaxa={ratingTaxa}&effectiveDate={effectiveDate}&ratingValidation={ratingValidation}

Rate

Tasks

APIDescription
GET v1/Tasks?TaskId={TaskId}&ModifiedUserId={ModifiedUserId}&ModifiedDate={ModifiedDate}&FromUserId={Fro...

Task Search

GET v1/Tasks/{id}

Retrieve Task

POST v1/Tasks

Create Task

PUT v1/Tasks/{id}

Update Task

GET v1/Tasks/{TaskId}/TaskNotes?TaskNoteId={TaskNoteId}&Comment={Comment}&CreationDate={CreationDate}&Cr...

Retrieve Task's Notes

POST v1/Tasks/{TaskId}/TaskNotes

Create Task Note

PUT v1/Tasks/{TaskId}/TaskNotes?id={id}

Update Task Note

Users

APIDescription
GET v1/Users/Current

Retrieve Current User Info

POST v1/Users

Create User

GET v1/Users/{id}

Retrieve User

GET v1/Users/Groups

Retrieve Groups

PUT v1/Users/{id}

Update User

PUT v1/Users/Deactivate/{id}

Deactivate User

PUT v1/Users/Activate/{id}

Activate User