Search
K
Claim Notification Messages

This API provides new claims and updates to existing claims to brokers via software houses.

This API provides new claims and updates to existing claims to brokers via software houses.

get
https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443/v1/claimNotificationMessages

Headers

Acceptstring

Content-Types that are acceptable for the response.Defaults to application/json.

Example:application/json

Correlation-IDstring

Unique id for the message. This is used for correlation of messages and tasks across multiple systems. Not mandatory, but recommended be be provided by consumer for traceability.

Example:dd420283-e9d0-4c61-8cfc-2a0e1c73a76e

Requesting-Systemstringrequired

Parameter to identify Consumer.This is unique for each consumer. This needs to pre agreed with Aviva.

Example:Consumer1

Authorizationstringrequired

Authentication credentials for HTTP authentication. eg. Bearer 0b79bab50daca910b000d4f1a2b675d604257e42

Example:Bearer 0b79bab50daca910b000d4f1a2b675d604257e42

Response

application/json

OK. Request has been successfully processed.

claimNotificationMessages

Defines an array of claim.

claimobject

Data related to claim.

Show Child Parameters
get/v1/claimNotificationMessages
 
application/json

claimNotificationMessages

array

Defines an array of claim.

claimobject

Data related to claim.

Show Child Parameters

claim

object

Data related to claim.

brokerAgentCodestring

A unique identifier assigned to the Agency by Aviva.

Example:SC004

brokerAgentNamestring

The name by which the Agency is known to Aviva.

Example:A New Dougie

brokerFRNCodestring

Universal broker agent code (Finanacial Register Number).

Example:123456

claimNumberstring

Claim reference number given to each claim by the insurer.

Example:1000189954

claimStatestring

Activity status of the overall claim at a point in time in the life of the claim. Indicates if claim is in draft state, open, closed or archived.

Example:Closed

closeDatestring(date-time)

The date on which the claim was closed by Aviva (eg.2023-03-27 12:32:34).

Example:2023-03-27 12:32:34

dateOfLossstring(date-time)

Date of loss/incident that resulted in claim occurred (eg.2023-03-25 12:32:34).

Example:2023-03-27 12:32:34

exposuresarray[object]

Data related to claim exposure Fields.

Show Child Parameters
faultRatingstring

Indicates if the policyholder is at fault. Possible values are Fault, Non-Fault

Example:Fault

financialsarray[object]

Data related to vehicle array on claim, exposure.The financials related to claims payments.

Show Child Parameters
injuredstring

Indicates if there’s an injured party on the claim.

Example:Y

insuredLiabilityPercentagenumber(BigDecimal)

Apportionment of fault applied to policyholder(eg.85.5).

Example:85.5

lossCausestring

Cause of loss in conjunction with ‘lossCauseCode’. Possible values are Fire, Collision, Road and traffic accident

Example:Fire

lossCauseCodestring

Code evidencing cause of loss (used for mapping).

Example:B149 25000

lossLocationobject

Data related to lossLocation.

Show Child Parameters
lossTypestring

Type of incident from which the losses have arisen. Possible values Property, Motor

Example:Property

notificationDatestring(date-time)

Date upon which the claim was notified to software houses or Aviva(eg.2023-03-27 12:32:34).

Example:2023-03-27 12:32:34

notificationOnlyboolean(boolean)

Indicates if incident is notified only or if claim being pursued.

policyobject

Data related to policy.

Show Child Parameters
propertiesarray[object]

Address of property related to exposure number.

Show Child Parameters
relationshipToInsuredstring

Relationship to insured held by person or organisation that reported the claim to broker or Aviva. Possible values are Policyholder (Other than Driver), Passenger, Driver, Third Party

Example:Policyholder (Other than Driver)

totalExcessAmountstring

Excess attached to policy.

Example:250

totalLossstring

Indicates if poliyholder’s vehicle is repairable/written off as a result of the incident. Possible values are Yes, No

Example:Yes

vatStatusstring

Indicates if policyholder is VAT registered.

Example:Yes

vehiclesarray[object]

Data related to vehicles on claim, exposure.

Show Child Parameters
Example

exposures

object

Data related to claim exposure Fields.

claimantIdstring

ID unique to claimant allocated to this exposure.

Example:ccawssys1:1536268

claimantNamestring

Name of person claiming on claim.

Example:John M

claimantRolestring(string[])

Define the type for claimantRole.

Example:['Claimant','Driver','Injured Party','Third Party']

claimantTypestring

Type of claimant.

Example:Other third party

coverageTypestring

Level of policy coverage in force.

Example:Comprehensive

coverageTypeCodestring

ABI/NU code relative to coverage type(e.g. N22 45 that is used to map to corresponding consumer/Acturis’ code and coverage type)

Example:B205 M15

exposureIdentifierstring

Detailed type of loss related to exposure number.

Example:Insured - Damage

exposureNumberstring

The reference ID assigned to an Exposure

Example:1000189954-1

exposureTypestring

Type of loss related to exposure number.

Example:Vehicle

Example

financials

object

Data related to vehicle array on claim, exposure.The financials related to claims payments.

amountnumber(BigDecimal)

Transaction amount. Amount of payment related to transaction(eg.1450.1200).

Example:1450.12

amountIDstring

Number to identify transaction (works in similar way to policy number and claims number).

Example:ccawssys1:502799

costCategorystring

Category of loss related to exposure insured by customer. Possible values are Vehicle, Property.

Example:Vehicle

costTypestring

Indicates if transaction is claim expense or claim cost.

Example:Claim Cost

exposureNumberstring

Provide exposureNumber.

Example:1000189954-1

typestring

Indicates if transaction is confirmed payment amount to customer or estimate/calculation and subject to change. Possible values are Reserve, Payment

Example:Reserve

Example