Fenris API Documentation
Download OpenAPI specification:
Fenris is an API-driven service for the modern insurance company. The Fenris suite of APIs provides the data and scores that inform insurance coverage decisions, evaluate risk, and improve the experience of applying for, rating, and servicing insurance accounts. The APIs save research time and minimize fillable form content errors by returning applicant data completed form fields for a client (applicant) to confirm, instead of requiring the client to complete forms manually.
This documentation has been used with the OpenAPI 3 specification. Definitions of the response fields are included under each service endpoint. Example requests and responses can be seen in the right-hand panel for each endpoint. The example request JSON can be collapsed and expanded using the minus and plus signs that appear on the right side of the JSON objects. For help getting authentication set up, please see our authentication documentation 
.
We also provide example code in many popular programming languages.
Once you have your authentication set up, please note that access lasts only 24 hours per generated token. You can make a request for any service you have access to with an example request for that service, found in the right-hand panel of the documentation.
Do you need an account to get started? Click here to request credentials.
If you are stuck or have a question not covered in our documentation, please send us an email at hello@fenrisd.com.
The Fenris Developer Data Collection is a set of artificial data records that can be used to test the Fenris services. The service’s responses to records from the artificial data are guaranteed to be constant, so that your integration tests will not break. Since the data in the set is synthetically generated, no personally identifying information (PII) is present, and the data can be shared openly. Best of all, your account is never charged for requests made with the developer data.
You can download our developer data here:
Postman is a third-party all-in-one API platform that can be helpful for testing and working with APIs. We host
a Postman collection
that uses the Fenris Developer Data to make example requests. For help getting started with Postman, please see the Postman documentation
The Fenris suite of services is comprised entirely of REST APIs. Representational State Transfer (REST) is a set of guidelines to manage communications on networks, including the Internet. One of the many benefits of using this pattern is that most development teams will be familiar with the protocol. You can read more about RESTful APIs here.
The Components of a RESTful API Client Request
The first component of a RESTful API request is the unique resource identifier. For all Fenris Services, this is the URL (Uniform Resource Locator). This is what allows the request to be routed to the correct service. This is also known as the request endpoint. The URL for each service can be found in the right-hand column of the documentation.
The next component of the request is the Method. The method lets the service know what the request needs to do. The current Fenris services support GET and POST requests, depending on the particular endpoint and desired process. GET allows for the access of resources at a specified URL. POST is used to send data to the service. POST requests are used to prevent information from being exposed in the URL.
The appropriate method for each request is described in the right-hand column of the documentation, to the left of the service endpoint, or in the left-hand navigation menu, next to the highlighted service.
The Request Headers component of a request is the metadata sent from the client to the server. This contains information about authentication and the format of the request, and the response.
The data used to create the request is provided in the body of the request.
Additional parameters can give the service additional details, such as a query of path parameters.
Using the Submission ID in a Request
Every Fenris API request has an optional submission-id parameter. This parameter is echoed directly back in the response. This value may be used to track your internal processes or systems associated with the request. For example, let’s say you have multiple lead scores and want to use Fenris Profile+ to evaluate the contact information and quality of the leads without losing the ability to route the lead back to its original source. While making a request to Fenris Profile+, you can include the submission-id parameter in your request's header to specify the original source, and that same string will be returned in the response's submissionId field.
Sending Test Requests
The submission-id parameter can also be used to mark a request as a test request by using the prefix test in the value of the submission ID.
Test the Property Details service with our Personal Developer Data. The developer data is synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Access details about a property
The Fenris Digital Property - Assessment Details API quickly and accurately provides a summary of reported information on building characteristics, valuation, and mortgages.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through header field containing a client-specified identifier to tieback to client data and systems. If the client does not define, processing relies on an auto-generated field to set the value. |
Request Body schema: application/jsonrequired
| addressLine1 | string non-empty Street address for a location, may also include secondary (e.g. apartment) information. This field is required for an address block to be valid. |
| addressLine2 | string This field will be appended to addressLine1 |
| city | string Name of the city in which the address is located. A city or a ZIP Code must be present for an address block to be valid. |
| state | string non-empty Standard two-character state abbreviation. A state abbreviation is required for an address block to be valid |
| zipCode | string Five-digit ZIP Code for the input address. A city or a ZIP Code must be present for an address block to be valid. |
| longitude | number <double> Longitude, in signed, decimal degrees for the input location. A longitude is required for a geocode block to be valid. |
| latitude | number <double> Latitude, in signed, decimal degrees for the input location. A latitude is required for a geocode block to be valid. |
| apn | string Optional Assessor's Parcel Number (APN) that will be used for the parcel lookup. Note that the APN will be tried before the address. The address is still required, and the last line of the address will be used to determine the county in which the APN is located. |
object (Owner) Optional owner's name of the parcel. This can be the first and last name of an individual or the name of an organization. The name is only used to resolve multiple matches when the property cannot be uniquely identified from the input address alone. |
Responses
Response Schema: */*
object (BuildingCharacteristics) Details of property and improvements based on county tax assessor data. | |
object (Valuation) Details about the value of the property. | |
object (Mortgage) Details about the mortgage for the property, based on county records. | |
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Enum: "SUCCESS" "NOT FOUND" Returns the status of search. |
| matchDescription | string Enum: "Default match logic" "Artificial match" "Not Found" How the search matched to given address or geocode. |
| document | object (Cacheable) The data returned based on the search. Null is returned if the search failed to find any data |
Request samples
- Payload
Old Aldrin Highway - Address
{- "addressLine1": "18595 Old Aldrin Highway",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": "80126"
}Response samples
- 200
Old Aldrin Highway
{ "requestId": "59c97ade-66e5-4086-99ee-a638fac845e4", "submissionId": "59c97ade-66e5-4086-99ee-a638fac845e4", "status": "SUCCESS", "matchDescription": "Artificial match", "document": { "buildingCharacteristics": { "useType": "Single Family Residential", "airConditioning": "Central", "basement": "Unfinished Basement", "totalArea": 2345, "buildingClass": "null", "buildingCondition": "Good", "buildingQuality": "C", "garageType": "Garage", "garageNumCars": 0, "lotSize": 7536, "bathrooms": 3, "partialBathrooms": 1, "bedrooms": 4, "totalRooms": 4, "stories": 0, "pool": null, "roofType": "GABLE", "roofCovering": "Composition Shingle", "yearBuilt": 1996, "heatingType": "Central", "heatingFuelType": null, "construction": "Frame", "units": 1, "ownerOccupied": "Owner-occupied property (SFR/Condo)", "ownerName": "MURDOCK, KYLE & SHARON", "buildings": 0, "exteriorWall": null, "foundation": null, "architecturalStyle": null }, "valuation": { "apn": "12354678", "marketValueMin": 558909, "marketValueMax": 657562, "landValue": 6920, "improvementValue": 29650, "assessmentYear": 2020, "assessedValue": 36570, "assessedMarketValue": 511457, "lastSalePrice": 0, "lastSaleDate": "2019-08-30" }, "mortgage": { "loanToValue": 57.0058, "balance": 351113, "totalLienBalance": 351113, "loanAmount": 365400, "lender": "THE MORTGAGE CO", "loanType": "New Conventional", "titleCompany": "NONE AVAILABLE" } } }
Test the Property Replacement Cost service with our Personal Developer Data. The developer data is synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Access details about a property's replacement cost.
The Fenris Digital Property - Replacement Cost API quickly and accurately provides a summary of replacement cost information on a given building.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through header field containing a client-specified identifier to tieback to client data and systems. If the client does not define, processing relies on an auto-generated field to set the value. |
Request Body schema: application/jsonrequired
| addressLine1 | string non-empty Street address for a location, may also include secondary (e.g. apartment) information. This field is required for an address block to be valid. |
| addressLine2 | string This field will be appended to addressLine1 |
| city | string Name of the city in which the address is located. A city or a ZIP Code must be present for an address block to be valid. |
| state | string non-empty Standard two-character state abbreviation. A state abbreviation is required for an address block to be valid |
| zipCode | string Five-digit ZIP Code for the input address. A city or a ZIP Code must be present for an address block to be valid. |
| longitude | number <double> Longitude, in signed, decimal degrees for the input location. A longitude is required for a geocode block to be valid. |
| latitude | number <double> Latitude, in signed, decimal degrees for the input location. A latitude is required for a geocode block to be valid. |
Responses
Response Schema: */*
| status | string Returns the status of search: Usually, Success or Not Found |
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| matchDescription | string Enum: "Default match logic" "Artificial match" "Not Found" Indicates the match strategy that provided the returned information. |
| architecturalStyle | string Enum: "2-Family Home" "3-Family Home" "4-Family Home" "A-Frame" "Adams" "Adirondack" "Adobe" "American Four Square" "Architecturally Unique" "Art Deco" "Art Moderne" "Arts and Crafts Style" "Basic" "Bay Region" "Beaux Arts" "Bi-Level" "Brownstone" "Brownstone - End Unit" "Brownstone, Bowfront Victorian" "Brownstone, Bowfront Victorian - End Unit" "Brownstone, Stand Alone" "Brownstone, Victorian" "Brownstone, Victorian - End Unit" "Bungalow" "California Ranch" "Cape Cod" "Carpenter Gothic" "Castle-Like" "Chalet" "Charleston" "Chateau" "City House" "City House - End Unit" "City House, Art Deco" "City House, Art Deco - End Unit" "City House, Art Moderne" "City House, Art Moderne - End Unit" "City House, Beaux Arts Classical" "City House, Beaux Arts Classical - End Unit" "City House, Gothic" "City House, Gothic - End Unit" "City House, International Style" "City House, International Style - End Unit" "City House, Italianate" "City House, Italianate - End Unit" "City House, Neo-Classical" "City House, Neo-Classical - End Unit" "City House, Renaissance" "City House, Renaissance - End Unit" "City House, Renaissance Revival" "City House, Renaissance Revival - End Unit" "City House, Romanesque" "City House, Romanesque - End Unit" "City House, Second Empire" "City House, Second Empire - End Unit" "City House, Sullivanesque" "City House, Sullivanesque - End Unit" "Classical Revival" "Co-Op" "Colonial" "Colonial, Custom" "Colonial, Dutch" "Colonial, Early American" "Colonial, Eclectic" "Colonial, French" "Colonial, German" "Colonial, Manor" "Colonial, New England Style" "Colonial, Plantation" "Colonial, Revival" "Colonial, Revival Eclectic" "Colonial, Southern" "Colonial, Spanish" "Colonial, Tract" "Completely Custom" "Conch" "Condo" "Contemporary" "Contemporary, California" "Contemporary, English" "Contemporary, French" "Contemporary, Tudor" "Contractor Modern" "Converted Barn" "Cottage" "Country Style" "Craftsman Style" "Deconstruction" "Designed by a Famous Architect" "Doublewide" "Duplex" "Earth Shelter, Bermed" "Earth Shelter, Hillside" "Earth Shelter, Underground" "Eastlake" "Eclectic, French" "Eclectic, Neoclassical" "English Style" "European Influenced" "Farmhouse" "Federal" "Fourplex" "French Provincial (also French Revival)" "French Style" "Geodesic Dome" "Georgian" "Georgian Revival" "German Stone" "Gingerbread" "Gothic Revival" "Greek Revival" "Gulf Coast Style" "High Ranch" "International Style" "Italian Villa" "Italianate" "Katrina Cottage" "Key West Style" "Log" "Log Kit" "Mansard" "Mansion" "Mediterranean" "Mission Style" "Moderne" "Monterey Style" "Neo-Classical" "Neo-Colonial" "Neo-French" "Neo-Mediterranean" "Neo-Tudor" "Neo-Victorian" "New England Colonial" "Normandy Style" "Octagon" "One-of-a-Kind" "Palatial" "Park Model" "Period" "Post Modern" "Prairie Style" "Public Building-Like" "Pueblo" "Queen Anne" "Quonset Hut" "Raised Cape" "Raised Ranch" "Rambler" "Rammed Earth" "Ranch" "Regency" "Renaissance Revival" "Richardsonian Romanesque" "Romanesque" "Saltbox" "Santa Barbara" "Santa Fe Style" "Second Empire" "Shaker" "Shingle Style" "Shotgun Style" "Singlewide" "Soil Cement" "Southampton Style" "Spanish Mission" "Spanish Revival" "Spanish Style" "Split Entry" "Split Level" "Stick, Eastern" "Stick, Western" "Strawbale" "Sullivanesque" "Townhouse" "Townhouse - End Unit" "Townhouse, Federal Style" "Townhouse, Federal Style - End Unit" "Townhouse, Georgian Style" "Townhouse, Georgian Style - End Unit" "Townhouse, Stand Alone" "Tract Home" "Tri-Level" "Triplewide" "Triplex" "Tudor" "Tuscan" "Usonian" "Vernacular/Folk" "Victorian" "Western Mountain" "Wrightian" The architectural style of the property. |
| constructionQuality | string Enum: "basic / economic" "basic" "modest / fair" "average / standard" "average" "above average / upgraded" "above average" "expensive / custom" "expensive" "very expensive / luxury" "very expensive" "opulent / museum quality" "exceptional" The estimated quality of the construction and finishes. |
| physicalShape | string The physical shape of the property. Example values include rectangular, contemporary, or unique. |
| constructionType | string Enum: "a - frame" "autoclaved aerated concrete" "brick masonry" "brick veneer" "foam form concrete" "framing, steel" "framing, wood" "framing, wood with elevated slab" "hoop arch" "log" "masonry, block" "masonry, brick" "masonry, stone" "metal frame" "metal frame (slant)" "milled timbers" "modular, wood frame" "pole frame" "post and beam" "poured concrete" "prefabricated" "quonset" "rammed earth" "reinforced concrete frame" "soil cement" "stick" "stone masonry" "stone veneer" "strawbale" "structural Insulated panel" "stucco on frame" "stucco on masonry" "timber / post & beam" "veneer, brick" "veneer, brick with wood frame" "veneer, stone" "wood framing" The construction method used to build the property. |
| exterior | string Enum: "adobe" "aluminum siding" "asbestos replacement, cement fiber" "asphalt" "autoclaved aerated concrete, exposed" "autoclaved aerated concrete, painted" "board and batten" "brick masonry" "brick veneer, face brick" "brick veneer, glazed" "brick veneer, Jumbo" "brick veneer, large" "brick veneer, Norman" "brick veneer, roman" "brick veneer, standard" "brick wall, cavity" "brick wall, reinforced" "brick with block backup" "brownstone" "cedar siding" "cement fiber" "clapboard" "concrete block" "concrete block, glazed" "concrete block, slumpstone" "concrete block, split face" "concrete wall, cast in place" "concrete, reinforced" "decorative wood shingle" "drivit/eifs" "glass block" "glass panels" "half log siding" "hardboard" "limestone" "local stone" "log (>11\" diameter)" "log (<11\" diameter)" "metal siding" "metal siding, aluminum, simulated wood" "metal siding, baked enamel" "metal siding, corrugated aluminum" "metal siding, corrugated aluminum, painted" "metal siding, corrugated composition" "metal siding, corrugated fiberglass" "metal siding, corrugated galvanized iron" "metal siding, porcelain" "none" "paint" "panels, brick" "panels, cement fiber" "panels, concrete block" "panels, fiberglass" "panels, glass and aluminum" "panels, glass and metal" "panels, polycarbonate (greenhouse)" "panels, rubble" "panels, sandwich" "panels, stone" "panels, stucco" "plywood with batts" "polyethylene film (greenhouse)" "precast concrete" "precast concrete panel" "precast concrete panel, granite finish" "precast stone" "rammed earth" "redwood siding" "siding, barn board" "siding, board and batten" "siding, cedar beveled" "siding, cedar shingles" "siding, glasweld" "siding, hardboard" "siding, lap board" "siding, log" "siding, plywood" "siding, redwood beveled" "siding, spaced board" "siding, tongue and grove" "siding, vinyl" "solid stone" "steel siding" "stone rubble" "stone veneer, arizona stone" "stone veneer, granite" "stone veneer, lava stone" "stone veneer, limestone" "stone veneer, rubble" "stone veneer, sandstone" "stucco" "stucco over masonry" "stucco with half timbering" "stucco, slick finish" "stucco, smooth coat" "stucco, tuscan finish" "t1-11 siding" "tabby siding" "tilt-up, concrete wall" "veneer, common brick" "veneer, face brick" "veneer, rubble" "veneer, stone" "vinyl siding" "wood shake/shingle" "wood siding" "wood stresskin panels" The type of the exterior wall of the structure. |
| roofCovering | string Enum: "acrylic" "aluminum" "architectural shingle" "asbestos shingle" "asbestos shingle replacement" "asphalt shingle" "asphalt shingle with solar panels" "barrel tile" "bituthene, self-seal" "built-up composition, high rise, 3 ply" "built-up composition, low rise, 3 ply" "built-up tar and gravel" "cedar shingle/shake" "cement fiber" "clay tile" "composition roll" "composition shingle" "composition, built-up" "concrete tile" "copper clad stainless steel" "copper, standing seam" "corrugated aluminum" "corrugated composition" "corrugated fiberglass" "corrugated galvanized iron" "dibiten" "dibiton" "dimensional asphalt shingle" "earth covered" "elastomeric" "epdm membrane" "fiberglass shingle" "glass panels" "glazed tile" "hail proof shingle" "lamarite shingle" "ludowici tile" "metal other than standing seam" "metal, standing seam" "metal, corrugated" "metal, ribbed" "minera shingle" "mineral shingle" "plastic, elastomeric membrane" "plastic, elastomeric membrane, loose, trocal" "plastic, elastomeric membrane, neoprene" "polycarbonate panels" "polyethylene film" "polyurethane foam" "pvc membrane" "red slate" "rubber" "shakes, cedar" "shakes, wood" "shingles, aluminum tab" "shingles, architectural" "shingles, asbestos replacement" "shingles, asphalt" "shingles, cedar" "shingles, composition" "shingles, composition asphalt" "shingles, dimensional asphalt" "shingles, fiberglass tabs" "shingles, minera" "shingles, mineral" "shingles, porcelain enamel" "shingles, wood" "silicone, 3 ply, rolled" "slate" "slate, graduated" "slate, patterned" "slate, synthetic" "spanish tile" "standing seam copper" "standing seam metal" "steel" "steel with solar panels" "tar and gravel" "tile, barrel" "tile, clay, flat bed" "tile, clay, glazed, interlock" "tile, clay, spanish" "tile, concrete, flat" "tile, concrete, interlock" "tile, concrete, premium" "tile, ludowici" "tile, slate" "tile, slate, graduated" "tile, slate, patterned" "tile, slate, red" "tile, slate, synthetic" "tile with solar panels" "tpo membrane" "wood shake" "wood shingle" "urethane foam, silicone cover" The type of the roof on the structure. |
| roofConfiguration | string The roof configuration of the building. This field is only available for CA properties. |
| foundationType | string Enum: "brick" "concrete block" "concrete slab" "fieldstone" "holland clay tile" "no permanent foundation" "pier" "pier and beam" "pilings" "poured concrete" "short pier" "stone" "stone rubble and mortar" "treated wood" The foundation type of the building. This field is only available for CA properties. |
| numStories | integer <int32> Number of stories in the structure. This field is only available for CA properties. |
| siteSlope | string The slope of the building site. |
| locale | string Enum: "beachfront" "city, large" "city, medium" "city, small" "coastal" "exclusive pocket" "gated community" "island, accessible by boat only" "island, accessible by bridge" "remote, moderate" "remote, slight" "remote, very" "resort" "rural" "suburban" "town" "urban" "waterfront" The location type of the property. |
| yearBuilt | string The year of the occupation certificate. |
| livingAreaSqFt | integer <int64> The total area of all buildings on this property in square feet. |
object (CostBreakdown) A breakdown of replacement costs. This data is only available for CA properties. | |
object (CostDetails) A range of estimates for the replacement cost of the property. This data is only available for commercial properties. | |
| replacementCost | integer <int64> The total estimated replacement cost for the property. |
| locationType | string Enum: "Residential" "Commercial" The type of the property location. |
Request samples
- Payload
Old Aldrin Highway - Address
{- "addressLine1": "18595 Old Aldrin Highway",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": "80126"
}Response samples
- 200
Old Aldrin Highway
{ "status": "SUCCESS", "requestId": "c203665b-de49-412e-a8ea-9b8084ef1dae", "submissionId": "c203665b-de49-412e-a8ea-9b8084ef1dae", "matchDescription": "Default match logic", "architecturalStyle": "California Ranch", "constructionQuality": "above average / upgraded", "physicalShape": "rectangular", "constructionType": "framing, wood", "exterior": "vinyl siding", "roofCovering": "metal other than standing seam", "roofConfiguration": "hip", "foundationType": "poured concrete", "numStories": 1, "siteSlope": null, "locale": "suburban", "yearBuilt": "1964", "livingAreaSqFt": 888, "costBreakdown": { "architectFeesAndPermits": 17000, "houseMaterialsAndLabor": 150000, "overhead": 21000, "profit": 21000, "costWithoutDebrisRemoval": 209000, "debrisRemoval": 10000, "costIncludingDebrisRemoval": 219000 }, "costDetails": null, "replacementCost": 209000, "locationType": "Residential" }
Test the Property Hazards and Perils service with our Personal Developer Data. The developer data is synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Access details about the geographic risks for a property
The Fenris Digital Property - Hazards and Perils API quickly and accurately provides a targeted assessment of geographic risks for property policy underwriting. The categories covered by this service are:
- Climate
- Geology
- Fire
- Man-made
- Coastal
- Weather
- Crime
- Wildfire
- Flood
In addition to the categories above, you can obtain information on insurance premium taxes in applicable states, such as Kentucky.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through header field containing a client-specified identifier to tieback to client data and systems. If the client does not define, processing relies on an auto-generated field to set the value. |
Request Body schema: application/jsonrequired
| addressLine1 | string non-empty Street address for a location, may also include secondary (e.g. apartment) information. This field is required for an address block to be valid. |
| addressLine2 | string This field will be appended to addressLine1 |
| city | string Name of the city in which the address is located. A city or a ZIP Code must be present for an address block to be valid. |
| state | string non-empty Standard two-character state abbreviation. A state abbreviation is required for an address block to be valid |
| zipCode | string Five-digit ZIP Code for the input address. A city or a ZIP Code must be present for an address block to be valid. |
| longitude | number <double> Longitude, in signed, decimal degrees for the input location. A longitude is required for a geocode block to be valid. |
| latitude | number <double> Latitude, in signed, decimal degrees for the input location. A latitude is required for a geocode block to be valid. |
Responses
Response Schema: */*
object (BuildingCharacteristics) Details of property and improvements based on county tax assessor data. | |
object (Valuation) Details about the value of the property. | |
object (Mortgage) Details about the mortgage for the property, based on county records. | |
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Enum: "SUCCESS" "NOT FOUND" Returns the status of search. |
| matchDescription | string Enum: "Default match logic" "Artificial match" "Not Found" How the search matched to given address or geocode. |
object (PropertyRisk) The data returned based on the search. Null is returned if the search failed to find any data |
Request samples
- Payload
Old Aldrin Highway - Address
{- "addressLine1": "18595 Old Aldrin Highway",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": "80126"
}Submit an outcome
Submit an outcome after requesting a score or prefill. The request must include only one of the following: a requestId from the previous request or a submissionId from the previous request.
Authorizations:
Request Body schema: application/jsonrequired
| originalRequestId | string The requestId of the original request made to the Fenris service. The data from that request will have the outcome appended in order to train new versions of the model. |
| originalSubmissionId | string The |
object (JoinField) The name and value of a custom field to join outcomes to request data. This field value should be unique across The requests to the scoring service. | |
| outcome required | string The outcome of the process or value of the target variable to be used in training. The string will be coerced into an appropriate type (boolean, numeric, date, etc) in order to retrain the model. Standard synonyms for boolean variables (Yes/No, Y/N, true/false, T/F, etc.) are accepted. |
Responses
Request samples
- Payload
{- "originalRequestId": "a442d998-7ffd-4e34-acba-495ec27c293b",
- "originalSubmissionId": "Poliy 1234567AB",
- "joinField": {
- "fieldName": "string",
- "fieldValue": "string"
}, - "outcome": "Y"
}Test the Auto Prefill service with our Personal Developer Data. The developer data are synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
There are two return options for the Auto Prefill endpoint; a base response and an enhanced response. The enhanced response includes everything in the based response along with additional enhanced vehicle information. The response types are toggled with the responseType parameter in the request body.
Setting the responseType to M returns only the base data. This is the default. Setting the responseType to C returns both the base data and the enhanced vehicle information. A license is required for the enhanced vehicle information.
The enhanced vehicle information is returned in the vehiclesEnhanced field in the response. This field is a list of vehicles found for the request, with each item in the list containing details for the vehicle, including the vehicle's vin number and registration.
Examples of each type of response can be seen in the right-hand panel, under Response samples, by toggling the options under Example. Additional details of the response fields can be seen in the Responses section below under the 200 Response Schema. The vehiclesEnhanced details can be seen by clicking the expansion carrot.
Prefill an auto insurance application.
The Fenris Digital Auto Prefill service provides information that can be used to quickly and accurately populate an auto insurance application, such as drivers and vehicle information.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
| Content-Type | string Example: application/json The body of the request is in JSON format, using UTF-8 character encoding |
| Authorization | string Example: Bearer <<token>> The token returned from authentication. See Authentication for more detail. |
Request Body schema: application/jsonrequired
required | object (Person) |
required | object (Address) Input address for the search. |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. | |
| responseType | string Default: "M" Enum: "M" "C" "MC" Defines if VIN data is returned. One of:
|
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Enum: "Success" "Success - Restricted State" "Success - No VIN" "VIN Return Only" "Not Found" "Not Found - Restricted State" Status of search and if requested (responseType=C) indication about registered vehicles search. One of:
|
| matchDescription | string Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not found" "Artificial match" "Household artificial match" The match strategy that provided the returned information. |
| addressDescription | string Enum: "Address verified" "City, state and ZIP verified, but street address not found" "More than one possible address found" "Street address verified but unit is missing/wrong" "Address verification failed" "Address verification not attempted" "Artificial address matched" Whether the address was verified or not. |
object (Primary) Data about the Primary Named Insured (PNI) and the household. See PNI for details. | |
Array of objects (Driver) An array of the drivers associated with this household. | |
Array of objects (Vehicle) An array of vehicles associated with this household. | |
Array of objects (EnhancedVehicle) An array of vehicle information including VIN and registration. |
Request samples
- Payload
Response Type M
{- "person": {
- "firstName": "Kyle",
- "lastName": "Murdock",
- "dateOfBirth": "05/20/1970"
}, - "address": {
- "addressLine1": "18595 Old Aldrin Highway",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": "80126"
}, - "responseType": "M"
}Response samples
- 200
This is a synthetic data response for M Response Type.
{ "requestId": "75c193b6-0dc5-4b63-a484-f9fef538c610", "submissionId": "75c193b6-0dc5-4b63-a484-f9fef538c610", "status": "Success", "matchDescription": "Artificial match", "addressDescription": "Artificial address matched", "primary": { "gender": "Male", "maritalStatus": "Married", "memberCode": "Primary Household Member", "parsedAddress": { "addressLine1": "18595 OLD ALDRIN HIGHWAY", "city": "HIGHLANDS RANCH", "state": "CO", "zipCode": "80126", "addressType": "Street Address" }, "homeOwnerStatus": "Definite Owner", "lengthOfResidence": "6-10 yrs", "numberOfGenerations": 2, "presenceOf16Or17YearOlds": true, "babyBoomer": false, "dualIncomeNoKids": false, "millennial": false, "vehicleHouseholdNum": 3 }, "drivers": [ { "firstName": "KYLE", "middleName": "", "lastName": "MURDOCK", "dateOfBirth": "05/20/1970", "age": 53, "gender": "Male", "maritalStatus": "Married", "memberCode": "Primary Household Member", "verificationDate": "06/04/2021" }, { "firstName": "SHARON", "middleName": "", "lastName": "MURDOCK", "dateOfBirth": "12/08/1971", "age": 51, "gender": "Female", "maritalStatus": "Married", "memberCode": "Primary Household Member", "verificationDate": "06/04/2021" }, { "firstName": "ANDY", "middleName": "", "lastName": "MURDOCK", "dateOfBirth": "03/10/2003", "age": 20, "gender": "Male", "maritalStatus": "Single", "memberCode": "Primary Household Member", "verificationDate": "06/04/2021" } ], "vehicles": [ { "confidence": 90, "description": "2019 GMC SIERRA", "year": "2019", "make": "GMC", "model": "SIERRA", "type": "Truck", "fuelType": "Gas", "mileage": "40,001 - 50,000", "marketValue": 21217 }, { "confidence": 70, "description": "2016 HONDA ODYSSEY", "year": "2016", "make": "HONDA", "model": "ODYSSEY", "type": "Passenger Car", "fuelType": "Gas", "mileage": "40,001 - 50,000", "marketValue": 11588 }, { "confidence": 70, "description": "2012 NISSAN ROGUE", "year": "2012", "make": "NISSAN", "model": "ROGUE", "type": "Passenger Car", "fuelType": "Gas", "mileage": "90,001 - 100,000", "marketValue": 7774 } ], "vehiclesEnhanced": [] }
The Fenris Digital Driver Record service provides summary information of potential violations on a driver's record. This includes a summary status of the driver's record, counts of the found minor and major violations, the dates of the latest minor and major violations found, and a calculated rating factor for the driver based on the found incidents. The rating factor is priority to Fenris, generated with industry experts, and gives an estimate of how the driver's rates for different tiers of insurance policies may be impacted. The Fenris Driver Record service provides invaluable insights for streamlining applications and quoting auto insurance policies.
Test the Driver Record service with our Personal Developer Data. The developer data are synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Check for violations on driver's record
A request for a driver's record needs to include either the address on the license of the person of interest, or the driver's license number and license state. The address component of the request is not required if the driver's license is provided.
This information is primarily based on a search of court records and is not a replacement for a complete Motor Vehicle Records (MVR) search. Because regulations vary across the United States, some states provide more limited access to data. Driver record data is more limited in the following states; AR, CA, CO, DC, DE, GA, HI, KS, LA, ME, MI, MN, MO, MT, NV, NH, NY, OH, OR, TN, WV, WY.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
required | object (DriverRecordPerson) The person of interest, to perform a driver record search for. |
object (Address) The address on the license of the person of interest; required if the driver's license is not supplied. |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Enum: "Clean" "No Evidence Found" "Minor Violations Found" "Major Violations Found" "No Results Found" "Not Attempted" "Clean - Developer Data" "No Evidence Found - Developer Data" "Minor Violations Found - Developer Data" "Major Violations Found - Developer Data" "No Results Found - Developer Data" Returns the status of the driver record search. One of the following values is returned:
|
| licenseSearchStatus | string Enum: "Supplied" "Found" "Not Found" "Not Attempted" Status of search for driver's license number. One of the following values is returned:
|
| minorCount | integer <int32> Default: 0 Number of violations of this type |
| minorLatest | string Date of the most recent violation of this type found on record |
| majorCount | integer <int32> Default: 0 Number of violations of this type |
| majorLatest | string Date of the most recent violation of this type found on record |
| accidentCount | integer <int32> Default: 0 Number of violations of this type |
| accidentLatest | string Date of the most recent violation of this type found on record |
| duiCount | integer <int32> Default: 0 Number of violations of this type |
| duiLatest | string Date of the most recent violation of this type found on record |
object (RatingFactor) Rating factor for this driver, based on the incidents found. Note that the rating factor does not include the opportunity discounts. |
Request samples
- Payload
Minor Violations
{- "person": {
- "firstName": "Jenny",
- "lastName": "Everywhere",
- "dateOfBirth": "11/10/1962",
- "licenseNumber": "510395035146",
- "licenseState": "TX"
}
}Response samples
- 200
Minor Violations
{ "requestId": "1fb4c776-bb61-4c37-9240-4c40dec7a8a8", "submissionId": "1fb4c776-bb61-4c37-9240-4c40dec7a8a8", "status": "Minor Violations Found - Developer Data", "licenseSearchStatus": "Supplied", "minorCount": 2, "minorLatest": "12/15/2023", "majorCount": 0, "majorLatest": null, "accidentCount": 0, "accidentLatest": null, "duiCount": 0, "duiLatest": null, "ratingFactor": { "preferred": 2.3, "standard": 1.48, "nonStandard": 1.44, "fullSpectrum": 1.29 } }
Decode a VIN
The VIN Decoder service provides automobile information for a requested VIN (Vehicle Identification Number).
Authorizations:
query Parameters
| vin required | string Example: vin=JN8AS5MV0CW000000 VIN to decode. |
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
| Authorization | string Example: Bearer <<token>> A Bearer token for authentication. |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Enum: "Success" "Failure" Status of decoding. |
| matchDescription | string A description of the match logic used to find this VIN. |
| make | string The make of the vehicle. |
| model | string The model of the vehicle. |
| modelYear | string The model year of the vehicle. |
| trim | string The vehicle's name-based trim style as defined by the manufacturer. |
| vehicleType | string Enum: "Motorcycle" "Passenger Car" "Truck" "Bus" "Trailer" "Multipurpose Passenger Vehicle (MPV)" "Low Speed Vehicle (LSV)" "Incomplete Vehicle" "Off Road Vehicle" |
| bodyClass | string The body class of the vehicle. |
object A set of string values providing additional details about the vehicle. The names in this object are reported by the manufacturer and will change depending on the year, make, and model of the vehicle. |
Response samples
- 200
Kyle Murdock
{ "requestId": "ef13d6eb-a903-4587-9fa5-7f9ef4591ee9", "submissionId": "ef13d6eb-a903-4587-9fa5-7f9ef4591ee9", "status": "Success", "matchDescription": "VIN decoded clean. Check Digit (9th position) is correct", "make": "OLDSMOBILE", "model": "Alero", "modelYear": "1999", "trim": "GLS", "vehicleType": "Passenger Car", "bodyClass": "Sedan/Saloon", "vinDetails": { "manufacturerName": "GENERAL MOTORS LLC", "engineNumberofCylinders": "6", "errorCode": "0", "windows": "4", "displacement(L)": "3.4", "otherEngineInfo": "Name Plate: Chevrolet, Pontiac, Oldsmobile", "plantCountry": "UNITED STATES (USA)", "plantCompanyName": "NA-GM Corp", "doors": "4", "engineManufacturer": "LAN", "plantCity": "LANSING - SOUTH PLANT", "displacement(CC)": "3400.0", "frontAirBagLocations": "1st Row (Driver and Passenger)", "vehicleDescriptor": "1G3NF52E*XC", "fuelDelivery/FuelInjectionType": "Sequential Fuel Injection (SFI)", "engineConfiguration": "V-Shaped", "seatBeltType": "Manual", "displacement(CI)": "207.48072992208", "plantState": "MICHIGAN" } }
Test the Drivers License service with our Personal Developer Data. The developer data are synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Search for a drivers license number
The Fenris Digital Driver's License search service provides a driver's license number and state for an input person.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
required | object (DriversLicenseSearchPerson) The person of interest to perform a license search for. |
required | object (Address) The home address of the person of interest. |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Enum: "Success" "Success - Developer Data" "Not Found" Returns the status of the driver's license search. One of the following values is returned:
|
| licenseState | string The state where the driver's license was issued. |
| licenseNumber | string The driver's license number. |
| maskedLicenseNumber | string The masked driver's license number, where only the last four characters are visible and the rest of the characters are obfuscated. |
Request samples
- Payload
Kyle Murdock
{- "person": {
- "firstName": "Kyle",
- "lastName": "Murdock",
- "dateOfBirth": "05/20/1970"
}, - "address": {
- "addressLine1": "18595 Old Aldrin Highway",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": "80126"
}
}Response samples
- 200
Kyle Murdock
{ "requestId": "9c19139d-77c3-426c-aff4-00090b41900c", "submissionId": "9c19139d-77c3-426c-aff4-00090b41900c", "status": "Success", "licenseState": "CO", "licenseNumber": "349370820846", "maskedLicenseNumber": "********0846" }
Many smaller and medium-sized companies don't have access to data science resources and the breadth of data needed to create effective machine-learning models. The Fenris Commercial Scoring API Suite hosts a set of both industry generic and tailored machine learning models to give our customers a competitive edge when it comes to understanding their leads and prospective customers.
For a model trained with your data, our data scientists tailor our machine learning algorithms to the criteria that you use in your business to define a high-quality lead. Once a model is trained and deployed, when a request to score a lead is sent to the service we match the lead to our proprietary database to create an enriched prospect profile. This improves the predictive power of the model by augmenting your lead data with our own attributes. The enriched data is scored using your tailored model to segment the lead based on predicted propensity to buy your insurance product.
Generate a score
Return a score for the requested business.
Authorizations:
path Parameters
| outcome required | string The outcome to be predicted (i.e., the target variable of the model). |
| lineOfBusiness required | string The insurance line of business for this model. |
| productLine required | string The product line within the line of business for the model to consider. |
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
| names required | Array of strings non-empty [ items non-empty ] Business name(s) which can include alternative names (legal, trade, DBA) or person's first and last name. |
required | object (Address) Address for the business location or just the state |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. | |
object |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| value | number |
| decile | integer <int32> |
| model | string |
object (Prediction) | |
| matchDescription | string Default: "Default match logic" Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not Found" "Artificial match" "Household artificial match" How the search matched to the individual or household. |
object |
Request samples
- Payload
{- "names": [
- "Cherry on Top Cupcake",
- "Cherry on Top Bakery",
- "Cherry Cupcake Midtown",
- "Cherry Cupcakes"
], - "address": {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}, - "otherAddresses": [
- {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}
], - "otherFields": {
- "property1": { },
- "property2": { }
}
}Generate a score
Return a score for the requested business.
Authorizations:
path Parameters
| outcome required | string The outcome to be predicted (i.e., the target variable of the model). |
| lineOfBusiness required | string The insurance line of business for this model. |
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
| names required | Array of strings non-empty [ items non-empty ] Business name(s) which can include alternative names (legal, trade, DBA) or person's first and last name. |
required | object (Address) Address for the business location or just the state |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. | |
object |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| value | number |
| decile | integer <int32> |
| model | string |
object (Prediction) | |
| matchDescription | string Default: "Default match logic" Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not Found" "Artificial match" "Household artificial match" How the search matched to the individual or household. |
object |
Request samples
- Payload
{- "names": [
- "Cherry on Top Cupcake",
- "Cherry on Top Bakery",
- "Cherry Cupcake Midtown",
- "Cherry Cupcakes"
], - "address": {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}, - "otherAddresses": [
- {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}
], - "otherFields": {
- "property1": { },
- "property2": { }
}
}Generate a score
Return a score for the requested business.
Authorizations:
path Parameters
| outcome required | string The outcome to be predicted (i.e., the target variable of the model). |
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
| names required | Array of strings non-empty [ items non-empty ] Business name(s) which can include alternative names (legal, trade, DBA) or person's first and last name. |
required | object (Address) Address for the business location or just the state |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. | |
object |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| value | number |
| decile | integer <int32> |
| model | string |
object (Prediction) | |
| matchDescription | string Default: "Default match logic" Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not Found" "Artificial match" "Household artificial match" How the search matched to the individual or household. |
object |
Request samples
- Payload
{- "names": [
- "Cherry on Top Cupcake",
- "Cherry on Top Bakery",
- "Cherry Cupcake Midtown",
- "Cherry Cupcakes"
], - "address": {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}, - "otherAddresses": [
- {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}
], - "otherFields": {
- "property1": { },
- "property2": { }
}
}The Fenris Lead Insight Service designed to insure that the leads you are buying meet your parameters of quality before they are purchased. Using anonymous data, the Fenris Lead Insight Service generates a score indicating the probability of a lead will convert. This insight allows you to route the request to the appropriate channel or return the lead to the seller.
Highly customizable, the Fenris Lead Insight service houses both generic line of business models for probability to convert as well as tailored customer models for assessing the quality of a lead.
For a model trained with your data, our data scientists tailor our machine learning algorithms to the criteria that you use in your business to define a high-quality lead. Once the tailored model is trained and deployed, the new lead information can be seamlessly scored in a matter of milliseconds.
Score a Home Insurance Lead.
Score a Home Insurance lead with the specified model type specified, e.g. returnlikelihood, sellability, quotability.
Authorizations:
path Parameters
| type required | string |
Request Body schema: application/jsonrequired
| thirdPartyLeadCertificationId | string |
| affiliate | string |
| campaign | string |
| source | Array of strings |
| state | string |
| gender | string |
| dateOfBirth | string <date> |
| ageInYears | integer <int64> |
| landingPage | string |
object | |
| age | string |
| currentlyInsured | string |
| currentInsuranceCompany | string |
| propertyType | string |
| occupancy | string |
| foundation | string |
| homeSecurity | string |
| yearBuilt | string |
| stories | string |
| bedrooms | string |
| bathrooms | string |
| squareFootage | string |
| roofType | string |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| decile | integer <int32> |
| model | string |
object (Prediction) |
Request samples
- Payload
{- "thirdPartyLeadCertificationId": "string",
- "affiliate": "string",
- "campaign": "string",
- "source": [
- "string"
], - "state": "string",
- "gender": "string",
- "dateOfBirth": "2019-08-24",
- "ageInYears": 0,
- "landingPage": "string",
- "otherParams": {
- "property1": "string",
- "property2": "string"
}, - "age": "string",
- "currentlyInsured": "string",
- "currentInsuranceCompany": "string",
- "propertyType": "string",
- "occupancy": "string",
- "foundation": "string",
- "homeSecurity": "string",
- "yearBuilt": "string",
- "stories": "string",
- "bedrooms": "string",
- "bathrooms": "string",
- "squareFootage": "string",
- "roofType": "string"
}Score a Commercial Insurance Lead.
Score a Commercial Insurance lead with the specified model type specified, e.g. .
Authorizations:
path Parameters
| type required | string |
Request Body schema: application/jsonrequired
| thirdPartyLeadCertificationId | string |
| affiliate | string |
| campaign | string |
| source | Array of strings |
| state | string |
| gender | string |
| dateOfBirth | string <date> |
| ageInYears | integer <int64> |
| landingPage | string |
object |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| decile | integer <int32> |
| model | string |
object (Prediction) |
Request samples
- Payload
{- "thirdPartyLeadCertificationId": "string",
- "affiliate": "string",
- "campaign": "string",
- "source": [
- "string"
], - "state": "string",
- "gender": "string",
- "dateOfBirth": "2019-08-24",
- "ageInYears": 0,
- "landingPage": "string",
- "otherParams": {
- "property1": "string",
- "property2": "string"
}
}Score an Auto Insurance Lead.
Score an Auto Insurance lead with the specified model type specified, e.g. returnlikelihood, sellability, quotability.
Authorizations:
path Parameters
| type required | string |
Request Body schema: application/jsonrequired
| thirdPartyLeadCertificationId | string |
| affiliate | string |
| campaign | string |
| source | Array of strings |
| state | string |
| gender | string |
| dateOfBirth | string <date> |
| ageInYears | integer <int64> |
| landingPage | string |
object | |
| vehicleYear | integer <int32> |
| ageVehicle | integer <int32> |
| secondVehicleYear | integer <int32> |
| ageSecondVehicle | integer <int32> |
| ticketsOrClaimsLast3Years | string |
| dui | string |
| currentInsuranceProvider | string |
| desiredCoverageLevel | string |
| vehiclePrimaryUse | string |
| annualMileage | string |
| vehicleOwnership | string |
| continuousCoverage | string |
| activeLicense | string |
| everFiledSR22 | string |
| homeowner | string |
| married | string |
| educationLevel | string |
| creditScore | string |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| decile | integer <int32> |
| model | string |
object (Prediction) |
Request samples
- Payload
{- "thirdPartyLeadCertificationId": "string",
- "affiliate": "string",
- "campaign": "string",
- "source": [
- "string"
], - "state": "string",
- "gender": "string",
- "dateOfBirth": "2019-08-24",
- "ageInYears": 0,
- "landingPage": "string",
- "otherParams": {
- "property1": "string",
- "property2": "string"
}, - "vehicleYear": 0,
- "ageVehicle": 0,
- "secondVehicleYear": 0,
- "ageSecondVehicle": 0,
- "ticketsOrClaimsLast3Years": "string",
- "dui": "string",
- "currentInsuranceProvider": "string",
- "desiredCoverageLevel": "string",
- "vehiclePrimaryUse": "string",
- "annualMileage": "string",
- "vehicleOwnership": "string",
- "continuousCoverage": "string",
- "activeLicense": "string",
- "everFiledSR22": "string",
- "homeowner": "string",
- "married": "string",
- "educationLevel": "string",
- "creditScore": "string"
}Score a Life Insurance Lead.
Score a Life Insurance lead with the specified model type specified, e.g. returnlikelihood, sellability, quotability.
Authorizations:
path Parameters
| type required | string |
Request Body schema: application/jsonrequired
| thirdPartyLeadCertificationId | string |
| affiliate | string |
| campaign | string |
| source | Array of strings |
| state | string |
| gender | string |
| dateOfBirth | string <date> |
| ageInYears | integer <int64> |
| landingPage | string |
object | |
| currentInsuranceProvider | string |
| married | string |
| occupation | string |
| homeowner | string |
| desiredCoverageLevel | string |
| deviceType | string |
| familyHistory | string |
| height | string |
| weight | string |
| majorCondition | string |
| preExistingCondition | string |
| tcpa | string |
| tobaccoUse | string |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| decile | integer <int32> |
| model | string |
object (Prediction) |
Request samples
- Payload
{- "thirdPartyLeadCertificationId": "string",
- "affiliate": "string",
- "campaign": "string",
- "source": [
- "string"
], - "state": "string",
- "gender": "string",
- "dateOfBirth": "2019-08-24",
- "ageInYears": 0,
- "landingPage": "string",
- "otherParams": {
- "property1": "string",
- "property2": "string"
}, - "currentInsuranceProvider": "string",
- "married": "string",
- "occupation": "string",
- "homeowner": "string",
- "desiredCoverageLevel": "string",
- "deviceType": "string",
- "familyHistory": "string",
- "height": "string",
- "weight": "string",
- "majorCondition": "string",
- "preExistingCondition": "string",
- "tcpa": "string",
- "tobaccoUse": "string"
}Score a Health Insurance Lead.
Score a Health Insurance lead with the specified model type specified, e.g. returnlikelihood, sellability, quotability.
Authorizations:
path Parameters
| type required | string |
Request Body schema: application/jsonrequired
| thirdPartyLeadCertificationId | string |
| affiliate | string |
| campaign | string |
| source | Array of strings |
| state | string |
| gender | string |
| dateOfBirth | string <date> |
| ageInYears | integer <int64> |
| landingPage | string |
object | |
| tobaccoUse | string |
| preExistingConditions | string |
| height | string |
| tcpa | string |
| additionalInsured | string |
| coverageTime | string |
| entranceUrl | string |
| currentInsurancePlan | string |
| householdIncome | string |
| householdSize | string |
| over65 | string |
| subsidyStatus | string |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| score | string |
| decile | integer <int32> |
| model | string |
object (Prediction) |
Request samples
- Payload
{- "thirdPartyLeadCertificationId": "string",
- "affiliate": "string",
- "campaign": "string",
- "source": [
- "string"
], - "state": "string",
- "gender": "string",
- "dateOfBirth": "2019-08-24",
- "ageInYears": 0,
- "landingPage": "string",
- "otherParams": {
- "property1": "string",
- "property2": "string"
}, - "tobaccoUse": "string",
- "preExistingConditions": "string",
- "height": "string",
- "tcpa": "string",
- "additionalInsured": "string",
- "coverageTime": "string",
- "entranceUrl": "string",
- "currentInsurancePlan": "string",
- "householdIncome": "string",
- "householdSize": "string",
- "over65": "string",
- "subsidyStatus": "string"
}Many smaller and medium-sized companies don't have access to data science resources and the breadth of data needed to create effective machine-learning models. The Fenris Scoring API Suite hosts a set of both industry generic and tailored machine learning models to give our customers a competitive edge when it comes to understanding their leads and prospective customers.
The generic propensity to buy models housed in this suite can identify applicants in your sales funnel the leads who are 10x more likely to make a purchase, with the models be tuned by line of business or product line.
For a model trained with your data, our data scientists tailor our machine learning algorithms to the criteria that you use in your business to define a high-quality lead. Once a model is trained and deployed, when a request to score a lead is sent to the service we match the lead to our proprietary database to create an enriched prospect profile. This improves the predictive power of the model by augmenting your lead data with our own attributes. The enriched data is scored using your tailored model to segment the lead based on predicted propensity to buy your insurance product.
Generate a score
Return a score for the requested person and address.
Authorizations:
path Parameters
| outcome required | string The outcome to be predicted (i.e., the target variable of the model). |
| lineOfBusiness required | string The insurance line of business for this model. |
| productLine required | string The product line within the line of business for the model to consider. |
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
required | object (Person) |
required | object (Address) Input address for the search. |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. | |
object |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| matchDescription | string Default: "Default match logic" Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not Found" "Artificial match" "Household artificial match" How the search matched to the individual or household. |
| score | string Enum: "Excellent" "Very Good" "Good" "Fair" "Poor" "Not Found" Quality of input with respect to target. |
| decile | integer <int32> [ 1 .. 10 ] Decile of response (1-10) based on likelihood of input compared to target |
| model | string Model used to compute response. Returns "Model Failed" if an error occurs in processing. |
object |
Request samples
- Payload
{- "person": {
- "firstName": "Kyle",
- "middleName": "string",
- "lastName": "Murdock",
- "dateOfBirth": "05/20/1970"
}, - "address": {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}, - "otherAddresses": [
- {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}
], - "otherParams": {
- "property1": "string",
- "property2": "string"
}
}Generate a score
Return a score for the requested person and address.
Authorizations:
path Parameters
| outcome required | string The outcome to be predicted (i.e., the target variable of the model). |
| lineOfBusiness required | string The insurance line of business for this model. |
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
required | object (Person) |
required | object (Address) Input address for the search. |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. | |
object |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| matchDescription | string Default: "Default match logic" Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not Found" "Artificial match" "Household artificial match" How the search matched to the individual or household. |
| score | string Enum: "Excellent" "Very Good" "Good" "Fair" "Poor" "Not Found" Quality of input with respect to target. |
| decile | integer <int32> [ 1 .. 10 ] Decile of response (1-10) based on likelihood of input compared to target |
| model | string Model used to compute response. Returns "Model Failed" if an error occurs in processing. |
object |
Request samples
- Payload
{- "person": {
- "firstName": "Kyle",
- "middleName": "string",
- "lastName": "Murdock",
- "dateOfBirth": "05/20/1970"
}, - "address": {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}, - "otherAddresses": [
- {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}
], - "otherParams": {
- "property1": "string",
- "property2": "string"
}
}Generate a score
Return a score for the requested person and address.
Authorizations:
path Parameters
| outcome required | string The outcome to be predicted (i.e., the target variable of the model). |
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
required | object (Person) |
required | object (Address) Input address for the search. |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. | |
object |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| matchDescription | string Default: "Default match logic" Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not Found" "Artificial match" "Household artificial match" How the search matched to the individual or household. |
| score | string Enum: "Excellent" "Very Good" "Good" "Fair" "Poor" "Not Found" Quality of input with respect to target. |
| decile | integer <int32> [ 1 .. 10 ] Decile of response (1-10) based on likelihood of input compared to target |
| model | string Model used to compute response. Returns "Model Failed" if an error occurs in processing. |
object |
Request samples
- Payload
{- "person": {
- "firstName": "Kyle",
- "middleName": "string",
- "lastName": "Murdock",
- "dateOfBirth": "05/20/1970"
}, - "address": {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}, - "otherAddresses": [
- {
- "addressLine1": 18595,
- "addressLine2": "string",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": 80126
}
], - "otherParams": {
- "property1": "string",
- "property2": "string"
}
}Test the Commercial Lines Prefill service with our Business Developer Data. The developer data is synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Prefill information about a business.
Using only a business name and address, the Fenris Digital Business Insurance Prefill API locates and returns extensive business details. This API leverages the Fenris best-in-class match rates to return a robust set of data fields in a matter of seconds.
Our client's tell us that if they are the first to quote a business, they will have greater than 60% chance of closing that lead. Business Insurance Prefill provides crucial time-saving results for agents and brokers who are trying to gather applicant information and for underwriters who are key in the quote/close policy phase.
Business Search Details
The Commercial Insurance Prefill service works by matching a request including one or more business names, and one or more business addresses to several data repositories.
When a request is received, the provided business name(s) are cleansed by removing common business terms that are often swapped or abbreviated (e.g., Ltd, LLC, Inc.), and the address(es) are standardized to USPS form using the Fenris address standardization service.
The cleansed names and addresses are then used to search the Fenris Commercial Reference Data. This search attempts to find the business at the location(s) entered using fuzzy matching on the name(s).
If no match is found for the name and address, the search is expanded by looking across the state for businesses that match the input name (Note: many businesses have multiple names, and this is reflected in the reference data that is searched).
If no match is found in the commercial reference data with either approach, then the same names and addresses are used to search the Fenris consumer reference data.
While the Fenris reference data is being searched, the service also queries the Secretary of State data for the state in the address field of the request. This search is based only on the business name and the input state.
Once the searches are complete, the service aggregates all of the matched data from the sources and returns
it. There are three fields in the return that provide information about the results of the searches. They
are status, matchDescription, and
addressDescription`.
Authorizations:
header Parameters
| fenris-match-logic | string Enum: "FAST" "DEFAULT" |
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
| names required | Array of strings non-empty [ items non-empty ] Business name(s) which can include alternative names (legal, trade, DBA) or person's first and last name. |
required | object (Address) Address for the business location or just the state |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. |
Responses
Response Schema: */*
Request samples
- Payload
Cherry on Top Cupcake
{- "names": [
- "Cherry on Top Cupcake",
- "Cherry on Top Bakery",
- "Cherry Cupcake Midtown",
- "Cherry Cupcakes"
], - "address": {
- "addressLine1": "32301 Juergensen ST NW",
- "city": "Washington",
- "state": "DC",
- "zipCode": "20007"
}
}Response samples
- 200
Cherry on Top Cupcake
{ "requestId": "ca63610a-255c-4948-9574-974835cb1672", "submissionId": "ca63610a-255c-4948-9574-974835cb1672", "status": "Success", "matchDescription": "Default match logic", "addressDescription": "Address verified", "name": "Cherry on Top Cupcake", "address": { "addressLine1": "32301 Juergensen ST NW", "city": "Washington", "state": "DC", "zipCode": "20007", "addressType": "Street Address" }, "phone": "8002236862", "country": "United States", "headquarters": true, "employees": "1-20", "estimatedEmployees": 15, "estimatedPayroll": 1200000, "revenue": "$1 - 9.99 Million", "estimatedRevenue": 2556000, "operatingHours": "", "areaSquareMeters": 150, "parent": { "linkedInUrl": "https://www.linkedin.com/company/cherry-on-top-cupcake", "domain": "cherryontopcupcake.com", "website": "http://www.cherryontopcupcake.com", "alternateDomains": [], "alternateNames": [ "Cherry on Top Cupcake", "Cherry on Top Bakery", "Cherry Cupcake Midtown", "Cherry Cupcakes" ], "numberOfContacts": 80, "primaryIndustry": "retail bakeries", "primaryNAICSCode": "311811", "otherNAICSCodes": [], "primarySICCode": "54610000", "otherSICCodes": [], "employees": "101-500", "estimatedEmployees": 120, "revenue": "$10 - 49.99 Million", "estimatedRevenue": 23000000, "yearEstablished": "2009", "entityType": "LLC", "normalizedIndustry": "Food and Beverages", "numberOfLocations": 9, "estimatedPayroll": 1700000 } }
Test the Commercial Lines Financial Information service with our Business Developer Data. The developer data is synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Retrieve information about the financial health of a business.
The Fenris Digital Business Financial Information API locates and returns details on the financial health of the searched business, including scores estimating the businesses' risk of becoming severely delinquent or filing for bankruptcy.
This API leverages the Fenris best-in-class match rates to return a robust set of data fields in a matter of seconds.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
| names required | Array of strings non-empty [ items non-empty ] Business name(s) which can include alternative names (legal, trade, DBA) or person's first and last name. |
required | object (Address) Address for the business location or just the state |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. |
Responses
Response Schema: */*
Request samples
- Payload
Cherry on Top Cupcake
{- "names": [
- "Cherry on Top Cupcake",
- "Cherry on Top Bakery",
- "Cherry Cupcake Midtown",
- "Cherry Cupcakes"
], - "address": {
- "addressLine1": "32301 Juergensen ST NW",
- "city": "Washington",
- "state": "DC",
- "zipCode": "20007"
}
}Response samples
- 200
Cherry on Top Cupcake
{ "requestId": "7c344ebd-7f5e-4be9-864f-c9e478d71da9", "submissionId": "7c344ebd-7f5e-4be9-864f-c9e478d71da9", "status": "Success", "matchDescription": "Default match logic", "addressDescription": "Address verified", "name": "Cherry on Top Cupcake", "address": { "addressLine1": "32301 Juergensen ST NW", "city": "Washington", "state": "DC", "zipCode": "20007", "addressType": "Street Address" }, "primaryNAICSCode": "311811", "otherNAICSCodes": [], "failRate": 5, "failLevel": 2, "failReasons": [], "creditScore": 420, "creditClass": 4, "creditPercentile": 30, "creditReasons": [ "Insufficient Information on or Lack of Non-Financial Accounts", "Number of Non-Financial Trades", "Years Company has Been in Business in Database", "Industry" ], "bankruptcy": "N" }
Test the Customer 360 service with our Personal Developer Data. The developer data is synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Access general information about an individual or household.
The Customer 360 API quickly and accurately populates household information into application forms, making the insurance application process seamless.
The Customer 360 service returns information that can also be used to advise an agent or system about the financial and family status of the applicant. This includes information such as the presence of children and mortgage data. This information can be used to make sure that the applicant has the coverage that fits their needs.
Authorizations:
header Parameters
| Submission-Id | string Example: cafe-item-123 A pass through field from the request header containing a client-specified identifier to tieback to client data and systems. If the client does not define this value, an auto-generated field is used. |
Request Body schema: application/jsonrequired
required | object (Person) |
required | object (Address) Input address for the search. |
Array of objects (Address) Optional address(es) to be used in addition to input address for the search. |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Returns the status of search: Usually, Success or Not Found |
| matchDescription | string Default: "Default match logic" Enum: "Default match logic" "First and last name switched" "Changed last name" "Household match" "Multiple matches found" "Not Found" "Artificial match" "Household artificial match" How the search matched to the individual or household. |
| addressDescription | string Enum: "Address verified" "City, state and ZIP verified, but street address not found" "More than one possible address found" "Street address verified but unit is missing/wrong" "Address verification failed" "Address verification not attempted" "Artificial address matched" Whether the address was verified or not. |
object (PrimaryNamedInsured) | |
object (HouseholdInfo) | |
object (FinancialInfo) | |
Array of objects (HouseholdMember) |
Request samples
- Payload
Kyle Murdock
{- "person": {
- "firstName": "Kyle",
- "lastName": "Murdock",
- "dateOfBirth": "05/20/1970"
}, - "address": {
- "addressLine1": "18595 Old Aldrin Highway",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": "80126"
}
}Response samples
- 200
{ "requestId": "2eb08998-e8f9-45ec-985a-1d28130ce173", "submissionId": "2eb08998-e8f9-45ec-985a-1d28130ce173", "status": "Success", "matchDescription": "Artificial match", "addressDescription": "Artificial address matched", "primary": { "firstName": "KYLE", "lastName": "MURDOCK", "dateOfBirth": "05/20/1970", "age": 53, "gender": "Male", "maritalStatus": "Married", "memberCode": "Primary Household Member", "address": { "addressLine1": "18595 OLD ALDRIN HIGHWAY", "city": "HIGHLANDS RANCH", "state": "CO", "zipCode": "80126", "addressType": "Street Address" }, "homeOwnerStatus": "Definite Owner", "lengthOfResidence": "6-10 yrs", "occupation": "Professional/Technical" }, "householdInfo": { "numberOfGenerations": 2, "babyBoomer": false, "dualIncomeNoKids": false, "genX": true, "millennial": false, "numberOfAdults": 3, "presenceChildren": true, "children": { "totalChildren": 2, "children0to2": 0, "children3to5": 0, "children6to10": 0, "children11to15": 1, "children16to17": 1, "childrenUnknownAge": 0 }, "hobbies": [ "Baking", "Scrapbooking", "Woodworking" ] }, "financialInfo": { "income": "$150,000 - $174,999", "netWorth": "$250,000 - $499,999", "wealthResources": "$25,000 - $49,999", "investmentResources": "Less than $4,999", "liquidResources": "$15,000 - $19,999", "shortTermLiability": "$5,000 - $9,999", "mortgageData": { "firstMortgageAmount": 500000, "secondMortgageAmount": null, "originalMortgageAmount": 500000, "homeEquityLoan": null, "interestRate": "3.80%", "interestRateType": "Fixed Rate Loan", "loanType": "Conventional", "loanDate": "04/20/2013", "refiIndicator": false }, "equityInfo": { "salePrice": 450000, "marketValue": 600000, "assessedValue": 550000, "currentLoanToValue": "", "equity": 250000, "saleDate": "04/20/2013" }, "investments": [] }, "householdMembers": [ { "firstName": "KYLE", "lastName": "MURDOCK", "dateOfBirth": "05/20/1970", "age": 53, "gender": "Male", "maritalStatus": "Married", "memberCode": "Primary Household Member" }, { "firstName": "SHARON", "lastName": "MURDOCK", "dateOfBirth": "12/08/1971", "age": 51, "gender": "Female", "maritalStatus": "Married", "memberCode": "Primary Household Member" }, { "firstName": "ANDY", "lastName": "MURDOCK", "dateOfBirth": "03/10/2003", "age": 20, "gender": "Male", "maritalStatus": "Single", "memberCode": "Primary Household Member" } ] }
Assess contact quality
When dealing with internet lead generation, you can expect invalid contacts containing errors due to typos on forms or intentionally false information. What if you could practically ensure valid leads with accurate contact information? The Fenris Digital ("Fenris") Profile+ service validates the contact information on leads to ensure that you are contacting real people instead of wasting time trying to contact people who don't exist, at fake addresses, with autogenerated, made-up email addresses. The first chance a client has to evaluate whether they can contact a lead occurs when they first receive the POST data. By using Fenris Profile+ service, clients get instant feedback on the quality of the contact information so that they can route the request to the appropriate channel or return the lead to the seller.
How does it work?
The Fenris Profile+ Service works by comparing the input contact information such as person's name, postal address, e-mail address, phone number to Fenris' reference database of more than 250 million individuals and 130 million households to determine whether the input person exists in its reference data to determine the viability of making contact with the lead. These results are also passed to Fenris' proprietary Profile+ scoring engine to compute a score that enables quick assessment on the viability of outreach to each lead based on all of the input contact data submitted.
What are the benefits?
We match each lead to our proprietary, multi-sourced database covering more than 97% of the US population, evaluating validity for each element so you can sift out fraudulent entries. You can decide at that point to purchase or return the lead, or you can run validated leads through the Fenris data enrichment and lead scoring APIs for an even more granular assessment of lead quality and likelihood to buy.
Usage
The Fenris Profile+ endpoint receives a lead's contact data and returns information on the validity of the elements submitted. Note that all items in the request are optional. Information will be provided only for the submitted elements.
Developer Data
Test the Fenris Profile+ service with our Personal Developer Data. The developer data is synthetically generated and contains no PII. Requests made with developer data are not charged to your account.
Authorizations:
header Parameters
| fenris-model-type | string Example: generic Allows users with a deployed tailored model to use the generic Fenris Profile+ model by specify generic as the value. |
Request Body schema: application/jsonrequired
object (ProfilePerson) | |
object (Address) A mailing or street address. | |
string The contact email address. Supported formats include: | |
| phone | string The contact phone number. Supported formats include:
|
| ipAddress | string The contact IP address. The typical formats include:
|
| lineOfBusiness | string The line of business to score the lead for. This is an optional parameter used when a customer has multiple models trained. |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Enum: "Success" "Success - Developer Data" TruProfile service status |
object (AddressValidation) | |
object (PersonValidation) | |
object (PhoneValidation) | |
object (EmailValidation) | |
object (IpValidation) | |
object (ProfileScore) |
Request samples
- Payload
Kyle Murdock
{- "person": {
- "firstName": "Kyle",
- "lastName": "Murdock",
- "dateOfBirth": "05/20/1970"
}, - "address": {
- "addressLine1": "18595 Old Aldrin Highway",
- "city": "Highlands Ranch",
- "state": "CO",
- "zipCode": "80126"
}, - "phone": "123-123-4567",
- "ipAddress": "1.2.3.4",
- "lineOfBusiness": "auto"
}Response samples
- 200
Kyle Murdock
{ "requestId": "dd6dfe57-0b92-4319-8bfc-7c6ab6823b84", "submissionId": "dd6dfe57-0b92-4319-8bfc-7c6ab6823b84", "status": "Success - Developer Data", "address": { "standardized": true, "singleDeliveryPoint": true, "residential": true, "addressFound": true, "householdFound": true, "personAtAddress": true }, "person": { "recognizedFirstName": true, "recognizedLastName": true, "personFound": true, "dateOfBirthVerified": true }, "phone": { "valid": false, "mobileOrLandline": false }, "email": { "valid": true }, "ipAddress": { "valid": true, "notKnownProxy": true } }
Echo a Message
The echo API is a simple "Hello World!" service that echoes the message sent to it. It is designed to assist developers in testing authentication and connectivity to the Fenris API platform.
Authorizations:
Request Body schema: application/jsonrequired
| message | string A string message to send to the echo service. |
Responses
Response Schema: */*
| requestId | string Unique identifier for the request, used for auditing and support. |
| submissionId | string Returns the value from request header or if the value is not set in the header, then the unique identifier for the request. |
| status | string Default: "SUCCESS" Input was returned successfully. |
| message | string The string message returned by the echo service. |
Request samples
- Payload
{- "message": "I think you're great!"
}Response samples
- 200
{ "requestId": "3800a4cd-1372-48ce-a6fa-2b7fe5888258", "submissionId": "3800a4cd-1372-48ce-a6fa-2b7fe5888258", "status": "SUCCESS", "message": "I think you're great!" }