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

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.

Allowed values:
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.