Policies APIPolicy Detail

Policy Details

Path parameters

brandCodeenumRequired
Allowed values:
policyNumberstringRequired
Policy number to retrieve details.

Headers

AuthorizationstringRequired

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

Response

Success
policyDetailIdlong or nullDefaults to 0
policyDetailNumberstring or null

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 or null

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

actionTypeenum or null

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

Allowed values:
ipAddressstring or null
IP Address of the user who performed the last policy transaction.
ipAddressCountrystring or null

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

userAgentstring or null
User agent of the user who performed the last policy transaction.
presentationTimeZoneCodestring or null
createdAtstring or null
Created date timestamp in UTC time ISO 8601 format.
createdLocalDateTimestring or null
departureAtstring or null
Departure date timestamp in UTC time ISO 8601 format.
departureLocalDateTimestring or null
coverEndAtstring or null
Cover end date timestamp in UTC time ISO 8601 format.
coverEndLocalDateTimestring or null
coverDurationInDayslong or nullDefaults to 0
travellerslist of objects or null
List of travellers associated with the policy.
dependentslist of objects or null
List of dependents associated with the policy.
addressobject or null
Address information stored against the policy
financialSummaryobject or null
Financial summary breakdown record against the policy.
policyCombinedOptionLongSummaryobject or null
noteslist of objects or null
Notes recorded against the policy.