get https://your-url-here.com/PolicyAPI/policies//metadata
Based on policy summary
Body Response - Schema
200 OK
policy_metadata_response:
type: object
properties:
Contacts:
type: array
items:
type: object
$ref: '#/definitions/Contact'
DwellingCoverageLimit:
type: string
LivingExpensesCoverageLimit:
type: string
Locations:
type: array
items:
type: object
$ref: '#/definitions/Location'
OtherStructuresCoverageLimit:
type: string
PersonalPropertyCoverageLimit:
type: string
PolicyLocations:
type: array
items:
type: object
$ref: '#/definitions/PolicyLocation'
PrimaryLocation:
type: object
$ref: '#/definitions/PolicyLocation'
Vehicles:
type: array
items:
type: object
$ref: '#/definitions/Vehicle'
definitions:
Contact:
type: object
properties:
ContactRoles:
type: array
items:
type: object
$ref: '#/definitions/ContactRole'
DateOfBirth:
type: string
format: date-time
EmailAddress:
type: string
FirstName:
type: string
Gender:
type: string
GenderName:
type: string
LastName:
type: string
LicenseNumber:
type: string
LicenseState:
type: string
LicenseStateName:
type: string
MaritalStatus:
type: string
MaritalStatusName:
type: string
PrimaryAddress:
type: object
$ref: '#/definitions/Location'
PrimaryPhoneNumber:
type: string
Ssn:
type: string
ContactRole:
type: object
properties:
Role:
type: string
RoleName:
type: string
Location:
type: object
properties:
AddressLine1:
type: string
AddressLine2:
type: string
City:
type: string
Country:
type: string
CountryName:
type: string
LocationDescription:
type: string
State:
type: string
StateName:
type: string
ZipCode:
type: string
PolicyLocation:
type: object
properties:
Address:
type: object
$ref: '#/definitions/Location'
Vehicle:
type: object
properties:
Color:
type: string
LicensePlate:
type: string
LicenseState:
type: string
LicenseStateName:
type: string
Make:
type: string
Model:
type: string
SerialNumber:
type: string
Style:
type: string
StyleName:
type: string
Vin:
type: string
Year:
type: integer
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.