policy

Policy Summary with Brand Code

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

Request

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

Path parameters

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

Policy number to retrieve summary information for.

Response

Success

brandCode'nibau' | 'nibnz' | 'tidau' | 'wn'
policyDetailIdinteger
policyHeaderIdinteger
policyNumberstring

Policy number.

sequenceNumberinteger

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

policyStatusIdinteger
policyStatusstring

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

detailStatusIdinteger
detailStatusstring

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

policyActionTypeIdinteger
policyActionType'Purchase' | 'Amendment' | 'Cancellation'

Action type of the policy transaction - Indicates last action performed on 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.

referencePolicyWordingIdinteger

Reference ID to the policy wording document.

regulatoryWordingTranslationNamestring
displayDestinationDescriptionstring
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
customerIdinteger
displayTransactionValueAggregateAmountstring
policyDocumentAccessGuidstring
excessnumber double

Excess amount recorded against the policy in policy currency.

binderIdinteger

Binder ID associated with the policy.

Changes

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