Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
quotes
/
{quoteId}
Get Quote
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/{quoteId} \
  --header 'Authorization: <api-key>'
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "number": "Q00000001-01", "status": "in_progress", "submissionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "description": "<string>", "policyCurrency": "USD", "grandTotal": 2500, "wizardType": "quote", "applicant": { "id": "<string>", "name": "<string>", "email": "jsmith@example.com" }, "data": { "currentStepKey": "<string>", "hasPassedDetailsStep": true, "hasReachedReviewStep": true, "policyInfo": { "number": "<string>", "type": "<string>", "startsAtDate": "2023-12-25", "endsAtDate": "2023-12-25", "coverageTimezone": "<string>", "broker": {}, "description": "<string>", "currency": "USD", "ratingData": {}, "ratingInfo": {} }, "noRatingPremium": 123, "policyAggregateLimits": {}, "policyInsureds": [ { "policyInsuredId": 123, "coveragePeriods": [ { "id": "<string>", "joinDate": "2023-12-25", "terminationDate": "2023-12-25", "initialTerminationDate": "2023-12-25", "policyInsuredId": 123 } ], "isNewInsured": true, "isAddedInFlow": true, "isEditedInFlow": true, "coveragePeriodModification": true } ], "coverages": [ {} ], "useDefaultCoverages": true, "editingCustomAdjustments": [ { "id": "<string>", "description": "<string>", "amount": "<string>", "insuredId": "<string>", "sectionRank": 123, "format": "percent" } ], "billType": "annual", "billConfig": {}, "customBillItems": [ {} ], "previousCustomBillItems": [ {} ], "files": [ { "id": "<string>", "filename": "<string>" } ], "displayUploadFilesStep": true, "selectedForms": {}, "bindingSettings": {}, "recipients": [ {} ], "enteredEffectiveDate": "2023-12-25", "importPolicyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }, "bindErrors": [ {} ], "previewData": { "premium": 123, "taxes": 123, "fees": 123, "total": 123, "billItems": [ {} ], "insuredRatings": [ {} ] }, "ratingEngineRevisionId": "<string>", "ratingEngineVersionShortName": "<string>", "billingEmail": "jsmith@example.com" }

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

​
quoteId
string<uuid>
required

Quote identifier

Response

Quote details

​
id
string<uuid>
​
number
string
Example:

"Q00000001-01"

​
status
enum<string>
Available options:
in_progress,
complete,
sent,
accepted,
bound,
cancelled,
archived,
applied_to_policy
​
submissionId
string<uuid>
​
applicationId
string<uuid>
​
policyId
string<uuid>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
description
string
​
policyCurrency
string
Example:

"USD"

​
grandTotal
number
Example:

2500

​
wizardType
enum<string>
Available options:
quote,
endorsement,
cancellation,
reinstatement,
renewal,
forms
​
applicant
object
​
data
object

Full quote data structure

​
bindErrors
object[]
​
previewData
object

Calculated values for displaying quote

​
ratingEngineRevisionId
string
​
ratingEngineVersionShortName
string
​
billingEmail
string<email>