post https://your-url-here.com/ClaimAPI/claims
Returns the claim number
Request Parameters
{
"ClaimDetail": {
"Description": "string",
"FaultRating": "string",
"IncidentOnly": true,
"LossCause": "string",
"LossLocation": {
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"Country": "string",
"LocationDescription": "string",
"State": "string",
"ZipCode": "string"
},
"LossType": "string",
"NewContactInfo": {
"Contacts": [
{
"Contact": {
"ContactAddress": {
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"Country": "string",
"LocationDescription": "string",
"State": "string",
"ZipCode": "string"
},
"FirstName": "string",
"LastName": "string",
"Phone": "string"
},
"Roles": [
{
"Active": true,
"Comments": "string",
"Role": "string"
}
]
}
],
"MainContactRelation": "string",
"ReporterRelation": "string"
},
"Notes": [
{
"Description": "string",
"Subject": "string"
}
],
"PropertyFireDamage": {
"AnyoneInjured": true,
"ArsonInvolved": true,
"FireDeptResponded": true,
"FireSource": "string",
"HomeHabitable": true,
"HomeSecure": true,
"HowFireDiscovered": "string",
"SmokeDamageOnly": true
},
"PropertyIncidents": {
"DwellingIncident": {
"AlreadyRepaired": true,
"Description": "string",
"EstimateReceived": "string",
"Limit": "string",
"MaterialsDamaged": "string",
"RoomDamages": [
{
"NoOfRooms": 0,
"RoomType": "string"
}
]
},
"LivingExpensesIncident": {
"Description": "string",
"Limit": "string"
},
"OtherStructuresIncident": {
"AlreadyRepaired": true,
"Description": "string",
"EstimateReceived": "string",
"FencesDamaged": true,
"Limit": "string"
},
"PersonalPropertyIncident": {
"Description": "string",
"Limit": "string",
"StorageLocation": {
"Address": {
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"Country": "string",
"LocationDescription": "string",
"State": "string",
"ZipCode": "string"
}
}
}
},
"PropertyWaterDamage": {
"RoofProtected": true,
"WaterSource": "string",
"WaterTurnedOff": true
},
"ReportedDate": "2023-11-13T02:11:27.894Z",
"SpecialClaimPermission": "string",
"VehicleIncidents": [
{
"AirbagsDeployed": true,
"AssociatedContacts": [
{
"Contact": {
"ContactAddress": {
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"Country": "string",
"LocationDescription": "string",
"State": "string",
"ZipCode": "string"
},
"FirstName": "string",
"LastName": "string",
"Phone": "string"
},
"Roles": [
{
"Active": true,
"Comments": "string",
"Role": "string"
}
]
}
],
"Citations": [
{
"CitationAuthority": "string",
"CitationNumber": "string",
"CitationType": "string"
}
],
"Collision": true,
"Driver": {
"Contact": {
"ContactAddress": {
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"Country": "string",
"LocationDescription": "string",
"State": "string",
"ZipCode": "string"
},
"FirstName": "string",
"LastName": "string",
"Phone": "string"
},
"DriverLicenseNumber": "string",
"DriverLicenseState": "string",
"DriverRelation": "string",
"ReasonForUse": "string"
},
"EquipmentFailure": true,
"IncidentDescription": "string",
"LossDesc": "string",
"LossEstimate": "string",
"LossOccured": "string",
"LossParty": "string",
"Operable": true,
"Owner": {
"ContactAddress": {
"AddressLine1": "string",
"AddressLine2": "string",
"City": "string",
"Country": "string",
"LocationDescription": "string",
"State": "string",
"ZipCode": "string"
},
"FirstName": "string",
"LastName": "string",
"Phone": "string"
},
"OwnerPermission": true,
"ServicesToPerform": {
"Appraisal": true,
"OtherServices": true,
"RentalNoCoverage": true
},
"TotalLoss": true,
"VehStolen": true,
"Vehicle": {
"Color": "string",
"LicensePlate": "string",
"LicenseState": "string",
"LoanOnVehicle": true,
"Make": "string",
"Model": "string",
"MonthlyPayment": "string",
"MonthsRemaining": 0,
"PayoffAmount": "string",
"SerialNumber": "string",
"Style": "string",
"Vin": "string",
"Year": 0
},
"VehicleParked": true,
"VehicleType": "string"
}
]
},
"PolicySummary": {
"LossDate": "2023-11-13T02:11:27.895Z",
"PolicyNumber": "string",
"PolicyType": "string"
}
}
Request Schema
claim_request:
type: object
properties:
ClaimDetail:
type: object
$ref: '#/definitions/ClaimDetail'
PolicySummary:
type: object
$ref: '#/definitions/PolicySummary'
definitions:
ClaimDetail:
type: object
properties:
Description:
type: string
FaultRating:
type: string
IncidentOnly:
type: boolean
LossCause:
type: string
LossLocation:
type: object
$ref: '#/definitions/AddressDTO'
LossType:
type: string
NewContactInfo:
type: object
$ref: '#/definitions/NewContactInfo'
Notes:
type: array
items:
type: object
$ref: '#/definitions/NoteDTO'
PropertyFireDamage:
type: object
$ref: '#/definitions/PropertyFireDamage'
PropertyIncidents:
type: object
$ref: '#/definitions/PropertyIncidents'
PropertyWaterDamage:
type: object
$ref: '#/definitions/PropertyWaterDamage'
ReportedDate:
type: string
format: date-time
SpecialClaimPermission:
type: string
VehicleIncidents:
type: array
items:
type: object
$ref: '#/definitions/VehicleIncident'
AddressDTO:
type: object
properties:
AddressLine1:
type: string
AddressLine2:
type: string
City:
type: string
Country:
type: string
LocationDescription:
type: string
State:
type: string
ZipCode:
type: string
NewContactInfo:
type: object
properties:
Contacts:
type: array
items:
type: object
$ref: '#/definitions/ClaimContactDTO'
MainContactRelation:
type: string
ReporterRelation:
type: string
ClaimContactDTO:
type: object
properties:
Contact:
type: object
$ref: '#/definitions/ContactDTO'
Roles:
type: array
items:
type: object
$ref: '#/definitions/ClaimContactRoleDTO'
ContactDTO:
type: object
properties:
ContactAddress:
type: object
$ref: '#/definitions/AddressDTO'
FirstName:
type: string
LastName:
type: string
Phone:
type: string
ClaimContactRoleDTO:
type: object
properties:
Active:
type: boolean
Comments:
type: string
Role:
type: string
NoteDTO:
type: object
properties:
Description:
type: string
Subject:
type: string
PropertyFireDamage:
type: object
properties:
AnyoneInjured:
type: boolean
ArsonInvolved:
type: boolean
FireDeptResponded:
type: boolean
FireSource:
type: string
HomeHabitable:
type: boolean
HomeSecure:
type: boolean
HowFireDiscovered:
type: string
SmokeDamageOnly:
type: boolean
PropertyIncidents:
type: object
properties:
DwellingIncident:
type: object
$ref: '#/definitions/DwellingIncident'
LivingExpensesIncident:
type: object
$ref: '#/definitions/LivingExpensesIncident'
OtherStructuresIncident:
type: object
$ref: '#/definitions/OtherStructuresIncident'
PersonalPropertyIncident:
type: object
$ref: '#/definitions/PersonalPropertyIncident'
DwellingIncident:
type: object
properties:
AlreadyRepaired:
type: boolean
Description:
type: string
EstimateReceived:
type: string
Limit:
type: string
MaterialsDamaged:
type: string
RoomDamages:
type: array
items:
type: object
$ref: '#/definitions/RoomDamage'
RoomDamage:
type: object
properties:
NoOfRooms:
type: integer
RoomType:
type: string
LivingExpensesIncident:
type: object
properties:
Description:
type: string
Limit:
type: string
OtherStructuresIncident:
type: object
properties:
AlreadyRepaired:
type: boolean
Description:
type: string
EstimateReceived:
type: string
FencesDamaged:
type: boolean
Limit:
type: string
PersonalPropertyIncident:
type: object
properties:
Description:
type: string
Limit:
type: string
StorageLocation:
type: object
$ref: '#/definitions/StorageLocation'
StorageLocation:
type: object
properties:
Address:
type: object
$ref: '#/definitions/AddressDTO'
PropertyWaterDamage:
type: object
properties:
RoofProtected:
type: boolean
WaterSource:
type: string
WaterTurnedOff:
type: boolean
VehicleIncident:
type: object
properties:
AirbagsDeployed:
type: boolean
AssociatedContacts:
type: array
items:
type: object
$ref: '#/definitions/ClaimContactDTO'
Citations:
type: array
items:
type: object
$ref: '#/definitions/CitationDTO'
Collision:
type: boolean
Driver:
type: object
$ref: '#/definitions/Driver'
EquipmentFailure:
type: boolean
IncidentDescription:
type: string
LossDesc:
type: string
LossEstimate:
type: string
LossOccured:
type: string
LossParty:
type: string
Operable:
type: boolean
Owner:
type: object
$ref: '#/definitions/ContactDTO'
OwnerPermission:
type: boolean
ServicesToPerform:
type: object
$ref: '#/definitions/ServicesToPerform'
TotalLoss:
type: boolean
VehStolen:
type: boolean
Vehicle:
type: object
$ref: '#/definitions/Vehicle'
VehicleParked:
type: boolean
VehicleType:
type: string
CitationDTO:
type: object
properties:
CitationAuthority:
type: string
CitationNumber:
type: string
CitationType:
type: string
Driver:
type: object
properties:
Contact:
type: object
$ref: '#/definitions/ContactDTO'
DriverLicenseNumber:
type: string
DriverLicenseState:
type: string
DriverRelation:
type: string
ReasonForUse:
type: string
Vehicle:
type: object
properties:
Color:
type: string
LicensePlate:
type: string
LicenseState:
type: string
LoanOnVehicle:
type: boolean
Make:
type: string
Model:
type: string
MonthlyPayment:
type: string
MonthsRemaining:
type: integer
PayoffAmount:
type: string
SerialNumber:
type: string
Style:
type: string
Vin:
type: string
Year:
type: integer
PolicySummary:
type: object
properties:
LossDate:
type: string
format: date-time
PolicyNumber:
type: string
PolicyType:
type: string
Body Response - Schema
200 OK
claim_response:
type: object
properties:
ClaimNumber:
type: string
400's
ErrorInfo:
type: object
properties:
details:
type: array
items:
type: object
$ref: '#/definitions/ErrorDetails'
developerMessage:
type: string
errorCode:
type: string
status:
type: integer
userMessage:
type: string
definitions:
ErrorDetails:
type: object
properties:
message:
type: string
properties:
type: object
$ref: '#/definitions/ErrorDetailsProperties'
stackTrace:
type: string
ErrorDetailsProperties:
type: object
properties:
lineNumber:
type: integer
parameterLocation:
type: string
parameterName:
type: string
API Availability
The Financial Services Experience Cloud for Insurance - Integrations Bridge is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.
The Financial Services Experience Cloud for Insurance - Integrations Bridge has been in EA since November 2023.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.