Policy Details
Path parameters
brandCode
Allowed values:
policyNumber
Policy number to retrieve details.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
Success
policyDetailId
policyDetailNumber
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.
status
Status of the policy - For example indicating whether the policy is active or cancelled.
actionType
Action type of the policy transaction - Indicates last action performed on the policy.
Allowed values:
ipAddress
IP Address of the user who performed the last policy transaction.
ipAddressCountry
Geo-location country of the IP Address of the user who performed the last policy transaction.
userAgent
User agent of the user who performed the last policy transaction.
presentationTimeZoneCode
createdAt
Created date timestamp in UTC time ISO 8601 format.
createdLocalDateTime
departureAt
Departure date timestamp in UTC time ISO 8601 format.
departureLocalDateTime
coverEndAt
Cover end date timestamp in UTC time ISO 8601 format.
coverEndLocalDateTime
coverDurationInDays
travellers
List of travellers associated with the policy.
dependents
List of dependents associated with the policy.
address
Address information stored against the policy
financialSummary
Financial summary breakdown record against the policy.
policyCombinedOptionLongSummary
notes
Notes recorded against the policy.