Vendor MasterAPI
Table of Content
Endpoints
Authentication
Type of Leads
Request Object for
lead
TypeList of Accepted
case_type
valuesAnatomy of
fields
arrayThe
ref
guideResponse Object
Understanding Responses
References for
case_type
- Auto AccidentSample Request
References for
case_type
- Workers CompensationSample Request
Endpoints
Environment
Link
Description
Staging
Staging environment should be used for testing while integration.
Production
Production environment should be used once the integration is tested perfectly on staging.
Authentication
The api-key
and api-token
header should be set in order to make requests to our API.
These credentials will be provided to you for both production and staging servers.
Request for lead
Type
lead
TypeThe request body for type
- lead
should comply with these rules.
Name
Required
Type
Description
arrived_at
True
Timestamp
Should be in UTC
.
test_mode
false
Boolean
Default : false
. Should be set as true if the API call is used to send test data.
lead_first_name
false
Text
First name of the lead.
lead_last_name
false
Text
Last name of the lead.
lead_email
True
Email Address of the Lead.
lead_phone
True
Phone
Phone number of the lead. This can be either in US Domestic format ( Eg: (541) 754-3010
) or else in E.164 format ( Eg: +14155552671
)
case_type
True
Text
The injury type identified in the phone conversation. For Admediary, we are accepting only MVA leads and this should be specified as Auto Accident
zip_code
True
US Zip Code
Location of the Lead
time_to_call
False
Text
If the lead has a time preference for callback, pass that in this parameter.
fields
True
Array
The request body for each case type differs as it has a specific set of references for each case type. Each element in the fields
array is detailed below.
List of Accepted case_type
values
case_type
valuesMentioned below are case_type
values that we support. For any case_type
that doesn’t match with items from this list, should be entered as meaningful text. For all such new case_type
the request body should have references of Auto Accident
. The sample for the request is provided later in this document.
Case Type
Value
Description
Auto Accident
Auto Accident
If the lead case is an auto accident.
Anatomy of fields array
The fields array in the request contains objects. Each of these objects has three properties
Property
Required
Description
ref
True
Key to identifying questions to our internal
title
False
If you believe that you want to share the question that was used, it should be passed in this field.
answer
True
The answer comes from a set of choices or adheres to a type. The " ref
guide " section explains the ref
and their rules.
Example :
The ref
guide
ref
guideBelow are all of the ref
values that can be used in the fields
array. Each ref
has a type and can be a choice of options, a boolean or text. We have included the default question that will get considered should the ref object have a missing title
property. The explanation of which ref
objects to be used for each case_type
is mentioned later in the document. The answers in the field object should come strictly from the set of values provided below.
Ref Key
Type
Choices
Description
Default Question
incident_date_option_b
Enum / Text
Less than 1 year
, Less than 2 years
, Less than 3 years
, MM-DD-YY or MM-DD-YYYY or MM-YYYY or YYYY
Single Choice. Should be used for date questions. The actual date can be specified in the mentioned format.
How long ago did the injury happen?
have_attorney
Yes/No
Yes
, No
Single Choice. Whether lead already has an attorney. In case of unsure, the answer to choose should be No
Do you already have a lawyer representing you?
primary_injury
Enum
Back or Neck Pain
,Broken Bones
, Cuts and Bruises
, Headaches
, Memory Loss
, Loss of Limb
, Other
Single Choice. Please use the closest possible injury type, If the answer from the caller doesn’t match the list or there is something additional to add for a particular choice, comments
ref can be used to furnish those details.
What is the primary type of injury?
doctor_treatment
Yes/No
Yes
, No
Single Choice. If the lead has undergone any treatment, hospitalization etc. In case of unsure, the answer to choose should be No
Did the injury require hospitalization, medical treatment, or surgery?
charges_filed
Yes/No
Yes
, No
Single Choice. If the lead has lodged a police complaint. In case of unsure, the answer to choose should be No
Was a police report filed?
action_taken
Yes/No
Yes
, No
Single Choice. If the lead has filed a case etc. In case of unsure, the answer to choose should be No
Have you taken any action regarding your claim?
were_you_at_fault
Yes/No
Yes
, No
Single Choice. Lead at fault. In case of unsure, the answer to choose should be No
Were you at fault for the accident?
were_you_injured
Yes/No
Yes
, No
Single Choice. Did the lead have any injury?. In case of unsure, the answer to choose should be Yes
, this field is optional and should be passed only when the lead mentions that they aren’t injured.
Were you injured?
injury_cause
Text
Car Accident
, Motorcycle Accident
, Truck Accident
, Bicycle Accident
, Pedestrian Accident
, Passenger Accident
Text value for what caused the injury
What is the cause of your injury?
missed_work
Yes/No
Yes
, No
Single Choice. Lead missed work because of the injury. In case of unsure, the answer to choose should be No
Did the injury require you to miss work?
terms
Yes/No
I agree
, I do not Agree
Single Choice. If the lead has lodged a police complaint.
Please read and accept our Terms of Service
comments
Text
NA
Text. Details about the case
Describe your case
Response Object
Mentioned below are the properties that will be present in the response object.
Key
Description
status
created
- to acknowledge we received the details. failed
- We received the details but the request was poorly formulated. error
- Something has gone wrong.
result
success
- we assert that we received this request
message
acknowledgment message for the request
Response Skeleton
References for case_type
- Auto Accident
case_type
- Auto AccidentThe following set of references should be passed for Auto Accident
case type.
incident_date_option_b
- OPTIONALinjury_cause
- OPTIONALdoctor_treatment
- OPTIONALwere_you_at_fault
- OPTIONALwere_you_injured
- OPTIONALhave_attorney
- OPTIONALprimary_injury
- OPTIONALcomments
- OPTIONAL
Sample Request - Auto Accident
Last updated