Sample API Documentation
Authentication
This header is passed on every call to the API. The key is environment, 3rd party, and service specific.
Header Key
Header name | required | Data type | Indicate the search type |
authentication_key | required | (String) 64 characters | Application specific authentication key for the environment. |
Keys
PRODUCTION KEY:
Provided separately
TEST KEY:
c8a9047f63c76e81fa683ab650948b76135a1sl45dfjkfc368164bead4e8752c
Base URLs
- Production:
- Test:
API Calls Information
Colons and other special characters must be URL encoded.
We will send response code 200 with information regarding the success of the call in the status field. However, if there is an error or exception that occurs, a response code of 500 is returned.
GetByPolicyNo
Sample Request
http://api-test.client.com/ivr/GetByPolicyNo?transactionId=123&policyNumber=1234567
Parameter Information
Request Parameters | ||||
search-type | required | path | Data type | Indicate the search type |
transactionId | required | path | (String) May start w/ zero | Call Id, does support special characters, but they must be url encoded |
policyNumber | required | path | (String) policy number 1234567 | Policy number |
Responses
No Match found
{
"status": "no match",
"policy_number": "ABC",
"phone_number": null,
"policy_status": null,
"amount_due": 0,
"outstanding_balance": 0,
"due_date": null,
"state": null,
"payment_standing": null,
"usaa_member": false,
"verified_email": false,
"email_address": null,
"search_type": "GetByPolicyNo",
"contract_id": null,
"isp_data": null,
"is_core_policy": false,
"installment_plan": null,
"entity_id": null,
"entity_name": null
}
Successful Match
{
"status": "match",
"policy_number": "AVP 3825521-00",
"phone_number": "6109645654",
"policy_status": "Active",
"amount_due": 143.95,
"outstanding_balance": 3184.17,
"due_date": "2020-12-02 00:00:00.000000",
"state": "TN",
"payment_standing": "B",
"usaa_member": false,
"verified_email": false,
"email_address": "johnsmith671@gmail.com",
"search_type": "GetByPolicyNo",
"contract_id": "1588105",
"isp_data": null,
"is_core_policy": false,
"installment_plan": null,
"entity_id": "399105",
"entity_name": "John Smith 671"
}
GetByPhoneNo
Sample Request
http://api-test.client.com/ivr/GetByPhoneNo?transactionId=10066&phoneNumber=4802968370
Parameter Information
Request Parameters | ||||
search-type | required | path | Data type | Indicate the search type |
transactionId | required | path | (String) May start w/ zero | Call Id, does support special characters, but they must be url encoded |
phoneNumber | required | path | (String) phone 6105551212 | Phone number |
Responses
No Match Found
{
"status": "no match",
"policy_number": null,
"phone_number": "85643550",
"policy_status": null,
"amount_due": 0,
"outstanding_balance": 0,
"due_date": null,
"state": null,
"payment_standing": null,
"usaa_member": false,
"verified_email": false,
"email_address": null,
"search_type": "GetByPhoneNo",
"contract_id": null,
"isp_data": null,
"is_core_policy": false,
"installment_plan": null,
"entity_id": null,
"entity_name": null
}
Successful Match
{
"status": "match",
"policy_number": "AVP 2408924-03",
"phone_number": "8564355010",
"policy_status": "Active",
"amount_due": 137.65,
"outstanding_balance": 137.65,
"due_date": null,
"state": "PA",
"payment_standing": "B",
"usaa_member": false,
"verified_email": false,
"email_address": "test4124@gmail.com",
"search_type": "GetByPhoneNo",
"contract_id": "66257104",
"isp_data": null,
"is_core_policy": false,
"installment_plan": null,
"entity_id": "38631764",
"entity_name": "ALISON SMITH"
}
SendDocuments
Sample Request
http://api-test.client.com/ivr/SendDocuments?transactionId=1235513
Parameter Information
Request Parameters | ||||
search-type | required | path | Data Type | Indicate the search type |
transactionId | required | path | (String) May start w/ zero | Call Id, does support special characters, but they must be url encoded |
Responses
Failed Response
{
"success": false,
"status_message": "transactionId not found."
}
Successful Response
{
"success": true,
"status_message": "documents sent."
}
LogMetrics
Sample Request
http://api-test.client.com/ivr/LogMetrics?transactionId=10066
Body:
[
{
"time": 1510845755441,
"state": "S2",
"value": "english",
"key": "language"
},
{
"time": 1510845817662,
"state": "S101_Q",
"value": "1234567",
"key": "claimNumber"
}
]
Parameter Information
Request Parameters | ||||
search-type | required | path | Data Type | Indicate the search type |
transactionid | required | path | (String) May start w/ zero | Call Id, does support special characters, but they must be url encoded |
eventDescription | required | Body | Array of Objects (see example above) | Description of the event to be logged. The length of characters within each object in the array is 1000 |
Responses
Failed Response
{
"success": false,
"status_message": null
}
Successful Response
{
"success": true,
"status_message": "events logged"
}
Detailed Response Information
Policy Information Response
This will be returned from both the GetByPolicyNo and GetByPhoneNo calls
Field Name | Data Description | Comment |
status | (String) | “match”, “no match” |
policy_number | (String) | 13 digits: 3 letters, 7 digits, dash, 2 digits |
phone_number | (String) | 10 digit phone number |
policy_status | (String) | informational |
amount_due | Decimal (precision 2) | 145.75 |
outstanding_balance | Decimal (precision 2) | 345.75 |
due_date | Date MMDDYYYY | MMDDYYYY |
state | String 2 characters | 2-character state abbreviation |
payment_standing | string-enum 1 character | (N)o money owed, (M)oney Due, (B)ad Standing |
usaa_member | Boolean true or false | true/false usaa member |
verified_email | Boolean true or false | true/false has a verified email address |
email_address | (String) | Email address for the policy holder |
search_type | (String) | Type of search that was performed for this response GetByPolicyNo GetByPolicyNo-Core GetByPhoneNo GetByPhoneNo-Core |
contract_id | (String) | Internal ID of policy |
isp_data | (String) | Information from the Core system regarding the policy |
is_core_Policy | Boolean true or false | Identifies if the policy is in the ConceptOne or Core system |
installment_plan | (String) | Installment plan information |
entity_id | (String) | Internal ID of insured |
entity_name | (String) | Name of insured |
POST Status Response
This will be returned by the MakeAPayment, SendDocuments, and LogMetrics calls
Field Name | Data Description | Comment |
success | Boolean true or false | Transaction completed (true/false) |
status_message | (String) | Error message in the event of a failure |
Additional Examples and Notes
Invalid Authentication key for GetByPolicyNo and GetByPhoneNo:
Response
{
"status": "Unauthorized",
"policy_number": null,
"phone_number": null,
"policy_status": null,
"amount_due": 0,
"outstanding_balance": 0,
"due_date": null,
"state": null,
"payment_standing": null,
"usaa_member": false,
"verified_email": false,
"email_address": null
}
Invalid Authentication Key for MakePayment, SendDocuments, and LogMetrics
Response
{
"success": false,
"status_message": "Unauthorized"
}