Policies APIPolicy

Policy Summary with Brand Code

Path parameters

brandCodeenumRequired
Allowed values:
policyNumberstringRequired
Policy number to retrieve summary information for.

Headers

AuthorizationstringRequired

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

Response

Success
brandCodeenum or null
Allowed values:
policyDetailIdlong or nullDefaults to 0
policyHeaderIdlong or nullDefaults to 0
policyNumberstring or null
Policy number.
sequenceNumberinteger or null
This is a numeric sequence number that is the latest version of the policy.
policyStatusIdlong or nullDefaults to 0
policyStatusstring or null

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

detailStatusIdlong or nullDefaults to 0
detailStatusstring or null
Detailed status of the policy transaction, this is mainly used if a policy has entered manual workflow requiring authorisation..
policyActionTypeIdlong or nullDefaults to 0
policyActionTypeenum or null

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

Allowed values:
planobject or null
Product information associated with the policy.
destinationRegionstring or null
destinationCountriesstring or null
List of destination country and region names
destinationCountryCodesstring or null

List of destination country and region codes in extended ISO-3166 Alpha-3 format.

referencePolicyWordingIdlong or nullDefaults to 0
Reference ID to the policy wording document.
regulatoryWordingTranslationNamestring or null
displayDestinationDescriptionstring or null
currencyobject or null
This is currency for the policy. All financial transactions are in this currency.
presentationTimeZoneCodestring or null
policyIssuedAtstring or null
Policy issue date timestamp in UTC time ISO 8601 format.
policyIssuedLocalDateTimestring or null
detailIssuedAtstring or null
Latest policy transaction issue date timestamp in UTC time ISO 8601 format.
detailIssuedLocalDateTimestring 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
addressobject or null
Address recorded against the policy.
policyAuditobject or null
detailAuditobject or null
customerIdlong 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.
transactionValueAggregateAmountobject or null
displayTransactionValueAggregateAmountstring or null
authorizationPolicyobject or null
policyDocumentAccessGuidstring or null
externalMembershipslist of objects or null
External membership information associated with the policy.
excessdouble or null
Excess amount recorded against the policy in policy currency.
binderIdlong or nullDefaults to 0
Binder ID associated with the policy.