Policy Details | Documentation

[
  {
    "policyDetailId": 1000000,
    "policyDetailNumber": "policyDetailNumber",
    "status": "Active",
    "actionType": "Purchase",
    "ipAddress": "ipAddress",
    "ipAddressCountry": "ipAddressCountry",
    "userAgent": "userAgent",
    "presentationTimeZoneCode": "presentationTimeZoneCode",
    "createdAt": "createdAt",
    "createdLocalDateTime": "createdLocalDateTime",
    "departureAt": "departureAt",
    "departureLocalDateTime": "departureLocalDateTime",
    "coverEndAt": "coverEndAt",
    "coverEndLocalDateTime": "coverEndLocalDateTime",
    "coverDurationInDays": 1000000,
    "travellers": [
      {}
    ],
    "dependents": [
      {}
    ],
    "address": {
      "addressLine1": "addressLine1",
      "addressLine2": "addressLine2",
      "addressLine3": "addressLine3",
      "addressLine4": "addressLine4",
      "postalCode": "postalCode",
      "provinceId": 1000000,
      "provinceName": "provinceName",
      "countryId": 1000000,
      "countryName": "countryName"
    },
    "financialSummary": {
      "policyDetailId": 1000000,
      "transactionAmount": 1.1,
      "premium": 1.1,
      "discount": 1.1,
      "footprintsDonation": 1.1,
      "taxes": [
        {}
      ]
    },
    "policyCombinedOptionLongSummary": {
      "policyOptionLongSummaries": [
        {}
      ]
    },
    "notes": [
      {}
    ]
  }
]

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 details.

Response

Success

policyDetailIdlongOptionalDefaults to 0

policyDetailNumberstringOptional

The latest Policy detail number, this is a unique identifier for each policy transaction. it ends with -<SequenceNumber> e.g. -2 for a purchase followed by potentially an amendment.

statusstringOptional

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

actionTypeenumOptional

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

ipAddressstringOptional

IP Address of the user who performed the last policy transaction.

ipAddressCountrystringOptional

Geo-location country of the IP Address of the user who performed the last policy transaction.

userAgentstringOptional

User agent of the user who performed the last policy transaction.

presentationTimeZoneCodestringOptional

createdAtstringOptional

Created date timestamp in UTC time ISO 8601 format.

createdLocalDateTimestringOptional

departureAtstringOptional

Departure date timestamp in UTC time ISO 8601 format.

departureLocalDateTimestringOptional

coverEndAtstringOptional

Cover end date timestamp in UTC time ISO 8601 format.

coverEndLocalDateTimestringOptional

coverDurationInDayslongOptionalDefaults to 0

travellerslist of objectsOptional

List of travellers associated with the policy.

dependentslist of objectsOptional

List of dependents associated with the policy.

addressobjectOptional

Address information stored against the policy

financialSummaryobjectOptional

Financial summary breakdown record against the policy.

policyCombinedOptionLongSummaryobjectOptional

noteslist of objectsOptional

Notes recorded against the policy.

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