Introduction
API Documentation for Avanta Risk Management Inc.
Version: 1.0.0
Environments
Sandbox : https://sandbox-api.avantarisk.com
Production : https://api.avantarisk.com
Authentication
Avanta uses API keys to allow access to its API. As part of your registration process you must have received an API key.
Avanta expects for the API key to be included in all API requests to the server in a header that looks like the following:
Authorization: DrWcOyhTR0CgR6om5v3bww
HOA ID Products
HOA Fees
This endpoint retrieves HOA fees for the requested residential property.
HTTP Request
curl --location --request POST 'https://sandbox.api.avantarisk.com/fees' \
--header 'Authorization: DrWcOyhTR0CgR6om5v3bww==' \
--header 'x-avanta-ref-id: B0F45C43-8F17-43AB-9558-79EE78B3A013' \
--header 'x-avanta-ref-id-2: A0D45C43-8D17-43AB-9558-79AA78B3E013' \
--header 'Content-Type: application/json' \
--data-raw '{
"address_line1" : "423 Southridge Way",
"address_city" : "IRVING",
"address_state" : "TX",
"address_zip" : "75063"
}'
import http.client
import json
conn = http.client.HTTPSConnection("sandbox.api.avantarisk.com")
payload = json.dumps({
"address_line1": "423 Southridge Way",
"address_city": "IRVING",
"address_state": "TX",
"address_zip": "75063"
})
headers = {
'Authorization': 'DrWcOyhTR0CgR6om5v3bww==',
'x-avanta-ref-id': 'B0F45C43-8F17-43AB-9558-79EE78B3A013',
'x-avanta-ref-id-2': 'A0D45C43-8D17-43AB-9558-79AA78B3E013',
'Content-Type': 'application/json'
}
conn.request("POST", "/fees", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var myHeaders = new Headers();
myHeaders.append("Authorization", "DrWcOyhTR0CgR6om5v3bww==");
myHeaders.append("x-avanta-ref-id", "B0F45C43-8F17-43AB-9558-79EE78B3A013");
myHeaders.append("x-avanta-ref-id-2", "A0D45C43-8D17-43AB-9558-79AA78B3E013");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"address_line1": "423 Southridge Way",
"address_city": "IRVING",
"address_state": "TX",
"address_zip": "75063"
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://sandbox.api.avantarisk.com/fees", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
Returned JSON structures:
Success : 200
{
"x-avanta-ref-id" : "B0F45C43-8F17-43AB-9558-79EE78B3A013",
"x-avanta-ref-id-2" : "A0D45C43-8D17-43AB-9558-79AA78B3E013",
"avanta-response-id" : "A1D45C43-43AB-43AB-8F17-A013B0F45C43",
"address" : {
"fname_1" : "John",
"mname_1" : null,
"lname_1" : "Doe",
"fname_2" : null,
"mname_2" : null,
"lname_2" : null,
"property_address1" : "403 Southridge Way",
"property_address2" : null,
"property_city" : "Irving",
"property_state" : "TX",
"property_zip" : "75063",
"property_zip_plus4" : null
},
"status" : {
"code" : "100",
"key" : "ADDRESS_HAS_HOA_AND_FEE"
},
"fee" : {
"monthly_fee" : "1200"
},
}
Code 400: Bad Request
{
"code": 400,
"message": "'address_city' is required."
}
Code 401 : Unauthorized
{
"code": 401,
"message": "lacks valid authentication credentials for the target resource"
}
GET https://sandbox.api.avantarisk.com/fees
Summary: Returns fee information of the specific address
Parameters
Name | Located in | Description | Required | Type |
---|---|---|---|---|
x-avanta-ref-id | header | Customer Provided Reference ID of request. | Yes | string |
x-avanta-ref-id-2 | header | Additional Customer Provided Reference ID of request. | No | string |
address_line1 | query | Address line 1 | Yes | string |
address_line2 | query | Address line 2 | No | string |
address_state | query | State | Yes | string |
address_city | query | City | Yes | string |
address_zip | query | Zip code | Yes | string |
address_zip4 | query | Zip+4 code | No | string |
owner_1_first | query | Owner 1 First Name | No | string |
owner_1_middle | query | Owner 1 Middle Name | No | string |
owner_1_second | query | Owner 1 Last Name or Business Name | No | string |
owner_2_first | query | Owner 2 First Name | No | string |
owner_2_middle | query | Owner 2 Middle Name | No | string |
owner_2_second | query | Owner 2 Last Name or Business Name | No | string |
property_apn | query | Property APN - Assessor Parcel Number | No | string |
Response
Name | Description | Type |
---|---|---|
x-avanta-ref-id | Customer Provided Reference ID of request, this is copied from the original request. | string |
x-avanta-ref-id-2 | Additional Customer Provided Reference ID of requestt, this is copied from the original request if available. | string |
avanta-response-id | Avanta's Response ID of the request. | string |
address | Matched Address Entity, this is the Standardized Address from Avanta | Avanta Property |
fee | HOA Fee | Avanta HOA Fee |
status | Status of the Result | Avanta Result Status |
API Entities
Avanta Property
Name | Description | Optional |
---|---|---|
fname_1 | Owner First Name 1 | Yes |
mname_1 | Owner Middle Name 1 | Yes |
lname_1 | Owner Last Name 1 or Business Name | Yes |
fname_2 | Owner First Name 2 | Yes |
mname_2 | Owner Middle Name 2 | Yes |
lname_2 | Owner Last Name 2 or Business Name | Yes |
property_address1 | Matched Property Address1 | Yes |
property_address2 | Matched Property Address2 | Yes |
property_city | Matched Property City | Yes |
property_state | Matched Property State | Yes |
property_zip | Matched Property Zipcode | Yes |
property_zip_plus4 | Matched Property Zipcode+4 | Yes |
Avanta HOA Fee
Name | Description | Optional |
---|---|---|
monthly_fee | Calculated or Estimated Monthly Fee in Dollars | Yes |
Avanta Request Status
Name | Description |
---|---|
code | Avanta Status Code |
key | Avanta Status Key |
Avanta Status Codes
Code | Key | Description |
---|---|---|
100 | ADDRESS_HAS_HOA_AND_FEE | Address has One or More HOA’s & Fee |
110 | ADDRESS_HAS_HOA_AND_UNKNOWN_FEE | Address has One or More HOA’s & Unknown Fee |
120 | ADDRESS_HAS_HOA_AND_AVERAGE_FEE | Unable to Locate Condo or Apartment Unit #, returning an Average Fee for All Units |
200 | ADDRESS_DOES_NOT_HAVE_AN_HOA | Address Does Not Have an HOA. |
300 | CANNOT_LOCATE_ADDRESS | Cannot Locate The Requested address |
400 | UNABLE_TO_DETERMINE_HOA_AND_FEE | Unable To Determine HOA & Fee |
Status Codes
The Avanta API uses the following HTTP status codes:
HTTP Code | Description |
---|---|
200 | Success - Request successfully received. |
400 | Bad Request -- Your request is invalid. |
401 | Unauthorized -- Your API key is wrong. |
403 | Forbidden -- Not allowed to access the requested resource. |
404 | Not Found -- The specified endpoint could not be found. |
405 | Method Not Allowed -- You tried to access a resource with an invalid method. |
500 | Internal Server Error -- We had a problem with our server. Try again later. |
503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |