Policy Summary with Brand Code

1 curl https://api-staging.nibtravelinsurance.com/policies/v1/nibau/policies/policyNumber \ 2 -H "Authorization: Bearer <token>"

1 { 2 "brandCode": "nibau", 3 "policyDetailId": 1000000, 4 "policyHeaderId": 1000000, 5 "policyNumber": "policyNumber", 6 "sequenceNumber": 1, 7 "policyStatusId": 1000000, 8 "policyStatus": "Active", 9 "detailStatusId": 1000000, 10 "detailStatus": "Completed", 11 "policyActionTypeId": 1000000, 12 "policyActionType": "Purchase", 13 "plan": { 14 "planId": 100, 15 "productId": 50, 16 "planDisplayGroupId": 1000000, 17 "saleCurrencyId": 1000000, 18 "code": "code", 19 "shortDescription": "shortDescription", 20 "longDescription": "longDescription", 21 "underwriterCode": "underwriterCode", 22 "isAnnualMultiTrip": true, 23 "quotePanelTypeId": 1000000 24 }, 25 "destinationRegion": "destinationRegion", 26 "destinationCountries": "destinationCountries", 27 "destinationCountryCodes": "destinationCountryCodes", 28 "referencePolicyWordingId": 1000000, 29 "regulatoryWordingTranslationName": "regulatoryWordingTranslationName", 30 "displayDestinationDescription": "displayDestinationDescription", 31 "currency": { 32 "id": 1000000, 33 "symbol": "symbol", 34 "code": "code", 35 "description": "description", 36 "hasMinorUnits": true 37 }, 38 "presentationTimeZoneCode": "presentationTimeZoneCode", 39 "policyIssuedAt": "policyIssuedAt", 40 "policyIssuedLocalDateTime": "policyIssuedLocalDateTime", 41 "detailIssuedAt": "detailIssuedAt", 42 "detailIssuedLocalDateTime": "detailIssuedLocalDateTime", 43 "departureAt": "departureAt", 44 "departureLocalDateTime": "departureLocalDateTime", 45 "coverEndAt": "coverEndAt", 46 "coverEndLocalDateTime": "coverEndLocalDateTime", 47 "address": { 48 "addressLine1": "addressLine1", 49 "addressLine2": "addressLine2", 50 "addressLine3": "addressLine3", 51 "addressLine4": "addressLine4", 52 "postalCode": "postalCode", 53 "provinceId": 1000000, 54 "provinceName": "provinceName", 55 "countryId": 1000000, 56 "countryName": "countryName" 57 }, 58 "policyAudit": { 59 "createdAt": "createdAt", 60 "updatedAt": "updatedAt", 61 "createdByUserId": 1000000, 62 "updatedByUserId": 1000000 63 }, 64 "detailAudit": { 65 "createdAt": "createdAt", 66 "updatedAt": "updatedAt", 67 "createdByUserId": 1000000, 68 "updatedByUserId": 1000000 69 }, 70 "customerId": 1000000, 71 "travellers": [ 72 { 73 "travellerId": 1000000, 74 "guid": "guid", 75 "displayOrder": 1, 76 "isPrimary": true, 77 "title": "title", 78 "firstName": "firstName", 79 "surname": "surname", 80 "age": 1, 81 "emailAddress": "emailAddress", 82 "landLinePhoneNumber": "landLinePhoneNumber", 83 "mobileNumber": "mobileNumber" 84 } 85 ], 86 "dependents": [ 87 { 88 "dependentId": 1000000, 89 "guid": "guid", 90 "displayOrder": 1, 91 "title": "title", 92 "firstName": "firstName", 93 "surname": "surname", 94 "age": 1 95 } 96 ], 97 "transactionValueAggregateAmount": { 98 "policyHeaderId": 1000000, 99 "transactionTypeId": 1000000, 100 "amount": 1.1, 101 "optionTypeId": 1000000, 102 "travellerSurrogateKey": "travellerSurrogateKey", 103 "dependentSurrogateKey": "dependentSurrogateKey" 104 }, 105 "displayTransactionValueAggregateAmount": "displayTransactionValueAggregateAmount", 106 "authorizationPolicy": { 107 "planId": 1000000, 108 "partnerId": 1000000, 109 "customerUserId": 1000000 110 }, 111 "policyDocumentAccessGuid": "policyDocumentAccessGuid", 112 "externalMemberships": [ 113 { 114 "name": "name", 115 "code": "code", 116 "number": "number" 117 } 118 ], 119 "excess": 1.1, 120 "binderId": 1000000 121 }

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

brandCodeenumOptional

Allowed values:

policyDetailIdlongOptionalDefaults to 0

policyHeaderIdlongOptionalDefaults to 0

policyNumberstringOptional

Policy number.

sequenceNumberintegerOptional

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

policyStatusIdlongOptionalDefaults to 0

policyStatusstringOptional

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

detailStatusIdlongOptionalDefaults to 0

detailStatusstringOptional

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

policyActionTypeIdlongOptionalDefaults to 0

policyActionTypeenumOptional

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

Allowed values:

planobjectOptional

Product information associated with the policy.

destinationRegionstringOptional

destinationCountriesstringOptional

List of destination country and region names

destinationCountryCodesstringOptional

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

referencePolicyWordingIdlongOptionalDefaults to 0

Reference ID to the policy wording document.

regulatoryWordingTranslationNamestringOptional

displayDestinationDescriptionstringOptional

currencyobjectOptional

This is currency for the policy. All financial transactions are in this currency.

presentationTimeZoneCodestringOptional

policyIssuedAtstringOptional

Policy issue date timestamp in UTC time ISO 8601 format.

policyIssuedLocalDateTimestringOptional

detailIssuedAtstringOptional

Latest policy transaction issue date timestamp in UTC time ISO 8601 format.

detailIssuedLocalDateTimestringOptional

departureAtstringOptional

Departure date timestamp in UTC time ISO 8601 format.

departureLocalDateTimestringOptional

coverEndAtstringOptional

Cover end date timestamp in UTC time ISO 8601 format.

coverEndLocalDateTimestringOptional

addressobjectOptional

Address recorded against the policy.

policyAuditobjectOptional

detailAuditobjectOptional

customerIdlongOptionalDefaults to 0

travellerslist of objectsOptional

List of travellers associated with the policy.

dependentslist of objectsOptional

List of dependents associated with the policy.

transactionValueAggregateAmountobjectOptional

displayTransactionValueAggregateAmountstringOptional

authorizationPolicyobjectOptional

policyDocumentAccessGuidstringOptional

externalMembershipslist of objectsOptional

External membership information associated with the policy.

excessdoubleOptional

Excess amount recorded against the policy in policy currency.

binderIdlongOptionalDefaults to 0

Binder ID associated with the policy.