Configuration by ID | Documentation

curl https://api-staging.nibtravelinsurance.com/products/v1/nibau/plans/1000000 \
     -H "Authorization: Bearer <token>"

{
  "expirySeconds": 86400,
  "planId": 280,
  "code": "AUSTANDARD",
  "name": "Standard",
  "insuranceContractId": 40,
  "policyNumberPrefix": "WN",
  "policyNumberFormat": "[Prefix][JurisdictionCountryCode][Year][IncrementNumber]",
  "underwriterCode": "piiau",
  "currencyCode": "AUD",
  "homeCountryCodes": [
    "AUS"
  ],
  "pdsUrl": "v2/wn/insuranceContract/40/pds?preferredDocumentFileType=HTML&planId=280&lang=en",
  "purchaseTermsAndConditions": [
    {
      "termConditionId": 2421,
      "customerDeclarationText": "I/we have read, understood and agree to the terms and conditions in the DOCUMENT0, including <a href=\"https://products-api.worldnomads.com/v1/wn/regulatoryWordingDocuments/1069your-duty-to-us\" target=\"_blank\">Your Duty to Us</a>, and I/we agree to receive all policy documents electronically.",
      "tokenReplacements": [
        {
          "token": "DOCUMENT0",
          "label": "Product Disclosure Statement",
          "url": "/v1/wn/regulatoryWordingDocuments/1069"
        }
      ],
      "countryCode": "AUS",
      "provinceCode": "provinceCode",
      "policyActionTypeId": 1,
      "destinationCountryCodes": [
        "destinationCountryCodes"
      ],
      "partnerGroupIds": [
        1000000
      ]
    },
    {
      "termConditionId": 2423,
      "customerDeclarationText": "I confirm that all people named on the policy are UNDERWRITERCONTENT0 of Australia.",
      "tokenReplacements": [
        {
          "token": "UNDERWRITERCONTENT0",
          "label": "residents",
          "underwriterContentType": "RESIDENTDEFINITIONTEXT"
        }
      ],
      "countryCode": "AUS",
      "provinceCode": "provinceCode",
      "policyActionTypeId": 1,
      "destinationCountryCodes": [
        "destinationCountryCodes"
      ],
      "partnerGroupIds": [
        1000000
      ]
    },
    {
      "termConditionId": 2447,
      "customerDeclarationText": "I/we understand that this policy does not cover losses arising from government intervention including broadly imposed quarantine or border closures; that <a href=\"https://www.worldnomads.com/help/insurance/recent-events\" target=\"_blank\">travel advice</a> may impact our cover and there is no cover for any events that there is a ‘Do Not Travel’ warning for in our destination.",
      "tokenReplacements": [
        {}
      ],
      "countryCode": "AUS",
      "provinceCode": "provinceCode",
      "policyActionTypeId": 1,
      "destinationCountryCodes": [
        "destinationCountryCodes"
      ],
      "partnerGroupIds": [
        1000000
      ]
    },
    {
      "termConditionId": 2444,
      "customerDeclarationText": "I/we understand this policy will not cover existing medical conditions, except automatically covered conditions and when all criteria are met.",
      "tokenReplacements": [
        {}
      ],
      "countryCode": "AUS",
      "provinceCode": "provinceCode",
      "policyActionTypeId": 1,
      "destinationCountryCodes": [
        "destinationCountryCodes"
      ],
      "partnerGroupIds": [
        1000000
      ]
    },
    {
      "termConditionId": 2448,
      "customerDeclarationText": "I/we have read in full and accept the <a href=\"https://www.worldnomads.com/privacy\" target=\"_blank\">Privacy Policy</a> and agree for personal details to be used to provide travel insurance services.",
      "tokenReplacements": [
        {}
      ],
      "countryCode": "AUS",
      "provinceCode": "provinceCode",
      "policyActionTypeId": 1,
      "destinationCountryCodes": [
        "destinationCountryCodes"
      ],
      "partnerGroupIds": [
        1000000
      ]
    }
  ],
  "overrideJurisdictionCountryCode": "overrideJurisdictionCountryCode",
  "overrideJurisdictionProvinceCode": "overrideJurisdictionProvinceCode",
  "effectiveFromDate": "effectiveFromDate",
  "effectiveToDate": "effectiveToDate",
  "availableTranslations": {
    "key": "value"
  },
  "quoteType": "SINGLETRIP",
  "brandCode": "brandCode"
}

Authentication

AuthorizationBearer

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

Path parameters

brandCodeenumRequired

Brand code

Allowed values:

planIdlongRequiredDefaults to 0

A valid Plan ID - see /underwriters

Query parameters

preferredDocumentFileTypestringOptional

langstringOptional

partnerCodestringOptional

effectiveAtstringOptional

The point in time which the response relates to

Response

Success

expirySecondsinteger

planIdlongDefaults to 0

codestring

namestring

insuranceContractIdlongDefaults to 0

policyNumberPrefixstring

policyNumberFormatstring

underwriterCodestring

currencyCodestring

homeCountryCodeslist of strings

pdsUrlstring

purchaseTermsAndConditionslist of objects

overrideJurisdictionCountryCodestring

overrideJurisdictionProvinceCodestring

effectiveFromDatestring

effectiveToDatestring

availableTranslationsmap from strings to optional strings

quoteTypestring

brandCodestring