get https://your-url-here.com/AccountAPI/accounts
Provides account details based on account search criteria
Body Response - Schema
200 OK
accounts_response:
type: object
required:
- _embedded
- total
properties:
_embedded:
type: object
required:
- accounts
properties:
accounts:
type: array
items:
$ref: '#/definitions/account'
total:
type: integer
format: int32
definitions:
account:
type: object
properties:
account_number:
type: string
account_status:
type: string
customer_since:
type: string
format: date-time
date_of_birth:
type: string
delinquent:
type: boolean
email:
type: string
fax_phone_number:
type: string
first_name:
type: string
home_phone_number:
type: string
last_name:
type: string
mobile_phone_number:
type: string
policies:
type: array
items:
type: object
$ref: "#/definitions/Policies"
primary_address:
type: object
$ref: "#/definitions/Location"
primary_phone_number:
type: string
tax_id:
type: string
work_phone_number:
type: string
Location:
type: object
properties:
address_line1:
type: string
address_line2:
type: string
address_line3:
type: string
city:
type: string
country:
type: string
country_name:
type: string
location_description:
type: string
name:
type: string
state:
type: string
state_name:
type: string
zip_code:
type: string
Policies:
type: object
properties:
policy_number:
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.