policyDetail

Policy Details

get/v1/{brandCode}/policies/{policyNumber}/details

Request

  • Base URL: https://api-staging.nibtravelinsurance.com/policies
  • URL: https://api-staging.nibtravelinsurance.com/policies/v1/{brandCode}/policies/{policyNumber}/details
  • Auth: HTTP bearer

Path parameters

brandCode'nibau' | 'nibnz' | 'tidau' | 'wn' required
policyNumberstring required

Policy number to retrieve details.

Response

Success

policyDetailIdinteger
policyDetailNumberstring

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.

statusstring

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

actionType'Purchase' | 'Amendment' | 'Cancellation'

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

ipAddressstring

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

ipAddressCountrystring

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

userAgentstring

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

presentationTimeZoneCodestring
createdAtstring

Created date timestamp in UTC time ISO 8601 format.

createdLocalDateTimestring
departureAtstring

Departure date timestamp in UTC time ISO 8601 format.

departureLocalDateTimestring
coverEndAtstring

Cover end date timestamp in UTC time ISO 8601 format.

coverEndLocalDateTimestring
coverDurationInDaysinteger

Changes

No recorded changes to this operation across all 1 revision of this API.