Create / Update Quote | Documentation

curl -X POST https://api-staging.nibtravelinsurance.com/quotes/v2/nibau/quote \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json | Minimum Payload" \
     -d '{}'

{
  "id": "id",
  "isNew": true,
  "isPurchased": true,
  "hasConfigChanged": true,
  "isPurchaseInitiated": true,
  "clientSessionId": "clientSessionId",
  "policyNumber": "policyNumber",
  "stage": "INITIAL",
  "evaluatedAt": "evaluatedAt",
  "input": {
    "cultureCode": "cultureCode",
    "customerInterfaceId": 8,
    "quoteType": "SINGLETRIP",
    "overrideDuplicateCheck": true,
    "skipPersistence": true,
    "planId": 1000000,
    "quoteReferencePlanId": 1000000,
    "homeAddress": {
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "addressLine3": "addressLine3",
      "addressLine4": "addressLine4",
      "provinceCode": "provinceCode",
      "countryCode": "countryCode",
      "postalCode": "postalCode"
    },
    "alternateHomeAddress": {
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "addressLine3": "addressLine3",
      "addressLine4": "addressLine4",
      "provinceCode": "provinceCode",
      "countryCode": "countryCode",
      "postalCode": "postalCode"
    },
    "destinationCountryCodes": [
      "destinationCountryCodes"
    ],
    "departureDate": "2024-11-30",
    "returnDate": "2024-11-30",
    "coverEndDate": "2024-11-30",
    "campaignCode": "campaignCode",
    "partnerCode": "partnerCode",
    "tripValue": 1.1,
    "footprintsDonation": {
      "donationAmount": 1.1,
      "donationProjectId": 1000000,
      "donationAccountCode": "donationAccountCode"
    },
    "basicOptions": [
      {}
    ],
    "adventureActivitiesOption": {
      "optionType": "optionType",
      "adventureActivityIds": [
        1000000
      ]
    },
    "specifiedItemOption": {
      "optionType": "optionType",
      "specifiedItems": [
        {}
      ]
    },
    "cancellationOption": {
      "optionType": "optionType",
      "cancellationCoverLimit": 1.1
    },
    "policyHolders": [
      {
        "dateOfBirth": "2024-11-30"
      }
    ],
    "regulatoryDeclarations": [
      {}
    ],
    "externalIdentifiers": {
      "externalMembershipProviderId": 1000000,
      "externalMembershipNumber": "externalMembershipNumber",
      "bookingReference": "bookingReference",
      "marketingSource": "marketingSource"
    },
    "validation": {
      "isValid": true,
      "errors": [
        {}
      ]
    }
  },
  "priceResults": [
    {
      "planId": 1000000,
      "standardExcess": 1.1,
      "campaignId": 1000000,
      "campaignDiscountPercentage": 1.1,
      "optionPriceResults": [
        {}
      ]
    }
  ],
  "prices": [
    {
      "planId": 1000000,
      "totalPrice": 1.1,
      "standardExcess": 1.1,
      "campaignDiscountPercentage": 1.1,
      "campaignDiscount": 1.1,
      "partnerDiscount": 1.1,
      "basicOptionPrices": [
        {}
      ]
    }
  ],
  "clientInfo": {
    "ipAddress": "ipAddress",
    "userAgent": "userAgent",
    "referer": "referer"
  },
  "audit": {
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "createdByUsername": "createdByUsername",
    "updatedByUsername": "updatedByUsername",
    "createdByUserId": 1000000,
    "updatedByUserId": 1000000
  },
  "customerUserId": 1000000,
  "brandCode": "brandCode",
  "validation": {
    "isValid": true,
    "errors": [
      {}
    ]
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

brandCodeenumRequired

A supported NIB Travel brand code, such as “wn”.

Allowed values:

Request

This endpoint expects an object.

stageenumOptional

Represents the stage the quote is up to. This can be used for tracking quotes across the different stages in an embedded purchase path.

inputobjectOptional

Represents the quote parameters used to price the travel insurance booking.

Response

Success

idstring

isNewbooleanDefaults to false

isPurchasedbooleanDefaults to false

hasConfigChangedbooleanDefaults to false

isPurchaseInitiatedbooleanDefaults to false

clientSessionIdstring

policyNumberstring

The policy number is generated when the policy purchase has completed.

stageenum

Represents the stage the quote is up to. This can be used for tracking quotes across the different stages in an embedded purchase path.

evaluatedAtstring

inputobject

priceResultslist of objects

priceslist of objects

Returns an array of prices with available plans based on the parameters quoted.

clientInfoobject

auditobject

customerUserIdlongDefaults to 0

brandCodestring

validationobject