Swyfft Partner API
V1 Docs
HomeAPI ReferenceSDKsContext Plugin
Quote Groups

Create a quote group

POST
/partnerapi/v2/quote-groups

Synchronously rates both Admitted and EAndS carriers for an HO property address. Get-or-create semantics: a repeat POST for the same agency and address returns the existing group while it still has live quotes. Sequential retries are safe. Overlapping retries (e.g. firing a second request while the first, still in flight after a client timeout, has not yet inserted its group) are not: the lookup-then-insert has no uniqueness constraint, so overlapping requests can create duplicate groups. Callers must not issue overlapping retries for the same address.

Authorization

partnerApiKey
X-SwyfftApiKey<token>

API key issued by Swyfft. Pass in the X-SwyfftApiKey request header.

In: header

Request Body

The property and insured details for rating.

Inbound request body for POST /partnerapi/v2/quote-groups.

address*string

Full street address line (e.g. "123 Main St").

Length1 <= length
city*string

City (e.g. "Austin").

Length1 <= length
state*StateCode

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

Value in

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

First name of the insured. Validated at the service layer.

Length1 <= length
insuredMiddleName?|

Optional middle name of the insured. Improves NCF (LexisNexis) person-matching when provided.

insuredLastName*string

Last name of the insured. Validated at the service layer.

Length1 <= length
livingSpace?|

Optional square footage of living space.

Formatint32
yearBuilt?|

Optional year the property was built.

Formatint32
roofAge?|

Optional age of the roof in years.

Formatint32

Response Body

curl -X POST "https://example.com/partnerapi/v2/quote-groups" \  -H "Content-Type: application/json" \  -d '{    "address": "string",    "city": "Miami",    "state": "AK",    "zip": "string",    "insuredFirstName": "John",    "insuredLastName": "Smith"  }'
{  "quoteGroupId": "a51b0373-35ef-4927-98a1-cbda0d27b588",  "quotes": [    {      "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",      "ratingType": "Admitted",      "carrierCode": "BIC",      "annualPremium": 1250,      "annualFeesTotal": 100,      "grossAnnualPayment": 100,      "expiresOn": "2025-06-15T14:30:00Z",      "customizeUrl": "string",      "premiumErrors": "1250.00",      "elementGroups": [        {          "groupName": "string",          "elements": [            {              "elementName": "string",              "value": "1000.00",              "defaultValue": "1000.00",              "elementType": "string",              "valueType": "1000.00",              "editable": true,              "conditionallyHidden": true,              "displayFormat": "string",              "minValue": 1000,              "maxValue": 1000,              "increment": 100,              "choices": [                {                  "name": "John Smith",                  "value": "1000.00"                }              ]            }          ]        }      ]    }  ],  "errors": [    {      "ratingType": "Admitted",      "code": "conflict",      "message": "string"    }  ],  "createdOn": "2025-06-15T14:30:00Z"}

Get carrier capabilities GET

Returns the carriers active for new-business quoting in the given state, and the element vocabulary each carrier accepts at agent-level visibility. This is a <em>design-time</em> endpoint — use it to discover the accepted element names and values before creating a quote group. Per-quote element visibility and allowed values are in the comparison endpoint, which accounts for this-specific-risk conditions. The response is agency-independent and may be cached.

Get a quote group GET

Returns the current state of a quote group — quotes and per-type errors.