Policy Summary with Brand Code

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

{
  "brandCode": "nibau",
  "policyDetailId": 1000000,
  "policyHeaderId": 1000000,
  "policyNumber": "policyNumber",
  "sequenceNumber": 1,
  "policyStatusId": 1000000,
  "policyStatus": "Active",
  "detailStatusId": 1000000,
  "detailStatus": "Completed",
  "policyActionTypeId": 1000000,
  "policyActionType": "Purchase",
  "plan": {
    "planId": 100,
    "productId": 50,
    "planDisplayGroupId": 1000000,
    "saleCurrencyId": 1000000,
    "code": "code",
    "shortDescription": "shortDescription",
    "longDescription": "longDescription",
    "underwriterCode": "underwriterCode",
    "isAnnualMultiTrip": true,
    "quotePanelTypeId": 1000000
  },
  "destinationRegion": "destinationRegion",
  "destinationCountries": "destinationCountries",
  "destinationCountryCodes": "destinationCountryCodes",
  "referencePolicyWordingId": 1000000,
  "regulatoryWordingTranslationName": "regulatoryWordingTranslationName",
  "displayDestinationDescription": "displayDestinationDescription",
  "currency": {
    "id": 1000000,
    "symbol": "symbol",
    "code": "code",
    "description": "description",
    "hasMinorUnits": true
  },
  "presentationTimeZoneCode": "presentationTimeZoneCode",
  "policyIssuedAt": "policyIssuedAt",
  "policyIssuedLocalDateTime": "policyIssuedLocalDateTime",
  "detailIssuedAt": "detailIssuedAt",
  "detailIssuedLocalDateTime": "detailIssuedLocalDateTime",
  "departureAt": "departureAt",
  "departureLocalDateTime": "departureLocalDateTime",
  "coverEndAt": "coverEndAt",
  "coverEndLocalDateTime": "coverEndLocalDateTime",
  "address": {
    "addressLine1": "addressLine1",
    "addressLine2": "addressLine2",
    "addressLine3": "addressLine3",
    "addressLine4": "addressLine4",
    "postalCode": "postalCode",
    "provinceId": 1000000,
    "provinceName": "provinceName",
    "countryId": 1000000,
    "countryName": "countryName"
  },
  "policyAudit": {
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "createdByUserId": 1000000,
    "updatedByUserId": 1000000
  },
  "detailAudit": {
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "createdByUserId": 1000000,
    "updatedByUserId": 1000000
  },
  "customerId": 1000000,
  "travellers": [
    {
      "travellerId": 1000000,
      "guid": "guid",
      "displayOrder": 1,
      "isPrimary": true,
      "title": "title",
      "firstName": "firstName",
      "surname": "surname",
      "age": 1,
      "emailAddress": "emailAddress",
      "landLinePhoneNumber": "landLinePhoneNumber",
      "mobileNumber": "mobileNumber"
    }
  ],
  "dependents": [
    {
      "dependentId": 1000000,
      "guid": "guid",
      "displayOrder": 1,
      "title": "title",
      "firstName": "firstName",
      "surname": "surname",
      "age": 1
    }
  ],
  "transactionValueAggregateAmount": {
    "policyHeaderId": 1000000,
    "transactionTypeId": 1000000,
    "amount": 1.1,
    "optionTypeId": 1000000,
    "travellerSurrogateKey": "travellerSurrogateKey",
    "dependentSurrogateKey": "dependentSurrogateKey"
  },
  "displayTransactionValueAggregateAmount": "displayTransactionValueAggregateAmount",
  "authorizationPolicy": {
    "planId": 1000000,
    "partnerId": 1000000,
    "customerUserId": 1000000
  },
  "policyDocumentAccessGuid": "policyDocumentAccessGuid",
  "externalMemberships": [
    {
      "name": "name",
      "code": "code",
      "number": "number"
    }
  ],
  "excess": 1.1,
  "binderId": 1000000
}

Authentication

AuthorizationBearer

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

Path parameters

brandCodeenumRequired

Allowed values:

policyNumberstringRequired

Policy number to retrieve summary information for.

Response

Success

brandCodeenum

Allowed values:

policyDetailIdlongDefaults to 0

policyHeaderIdlongDefaults to 0

policyNumberstring

Policy number.

sequenceNumberinteger

This is a numeric sequence number that is the latest version of the policy.

policyStatusIdlongDefaults to 0

policyStatusstring

Status of the policy - For example indicating whether the policy is active or cancelled.

detailStatusIdlongDefaults to 0

detailStatusstring

Detailed status of the policy transaction, this is mainly used if a policy has entered manual workflow requiring authorisation..

policyActionTypeIdlongDefaults to 0

policyActionTypeenum

Action type of the policy transaction - Indicates last action performed on the policy.

Allowed values:

planobject

Product information associated with the policy.

destinationRegionstring

destinationCountriesstring

List of destination country and region names

destinationCountryCodesstring

List of destination country and region codes in extended ISO-3166 Alpha-3 format.

referencePolicyWordingIdlongDefaults to 0

Reference ID to the policy wording document.

regulatoryWordingTranslationNamestring

displayDestinationDescriptionstring

currencyobject

This is currency for the policy. All financial transactions are in this currency.

presentationTimeZoneCodestring

policyIssuedAtstring

Policy issue date timestamp in UTC time ISO 8601 format.

policyIssuedLocalDateTimestring

detailIssuedAtstring

Latest policy transaction issue date timestamp in UTC time ISO 8601 format.

detailIssuedLocalDateTimestring

departureAtstring

Departure date timestamp in UTC time ISO 8601 format.

departureLocalDateTimestring

coverEndAtstring

Cover end date timestamp in UTC time ISO 8601 format.

coverEndLocalDateTimestring

addressobject

Address recorded against the policy.

policyAuditobject

detailAuditobject

customerIdlongDefaults to 0

travellerslist of objects

List of travellers associated with the policy.

dependentslist of objects

List of dependents associated with the policy.

transactionValueAggregateAmountobject

displayTransactionValueAggregateAmountstring

authorizationPolicyobject

policyDocumentAccessGuidstring

externalMembershipslist of objects

External membership information associated with the policy.

excessdouble

Excess amount recorded against the policy in policy currency.

binderIdlongDefaults to 0

Binder ID associated with the policy.