Match a said or read answer to a planning question
curl --request POST \
--url https://api.effectiveai.app/api/v2/insurance/rating-programs/match \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"value": "<unknown>",
"answers": {}
}
'import requests
url = "https://api.effectiveai.app/api/v2/insurance/rating-programs/match"
payload = {
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"value": "<unknown>",
"answers": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
programs: [{programId: '<string>', version: 1, title: '<string>'}],
path: '<string>',
value: '<unknown>',
answers: {}
})
};
fetch('https://api.effectiveai.app/api/v2/insurance/rating-programs/match', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.effectiveai.app/api/v2/insurance/rating-programs/match",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'programs' => [
[
'programId' => '<string>',
'version' => 1,
'title' => '<string>'
]
],
'path' => '<string>',
'value' => '<unknown>',
'answers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.effectiveai.app/api/v2/insurance/rating-programs/match"
payload := strings.NewReader("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"value\": \"<unknown>\",\n \"answers\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.effectiveai.app/api/v2/insurance/rating-programs/match")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"value\": \"<unknown>\",\n \"answers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.effectiveai.app/api/v2/insurance/rating-programs/match")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"value\": \"<unknown>\",\n \"answers\": {}\n}"
response = http.request(request)
puts response.read_body{
"exact": "<unknown>",
"notAsked": [
{
"programId": "<string>",
"version": 1,
"reason": {
"code": "<string>",
"message": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"code": "business_rejection",
"error": "The program doesn't cover rideshare use.",
"businessCode": "RIDESHARE",
"violations": [
{
"code": "RIDESHARE",
"message": "The program doesn't cover rideshare use.",
"path": "Policy.vehicles[0].rideshare",
"value": true,
"constraint": "rideshare: where not self",
"cite": "manual:anchor \"eligibility\""
}
],
"violationsTruncated": false,
"requestId": "1793385750835-0"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}Market raters
Match a said or read answer to a planning question
Find what an answer said in words or read from a document means for one planning question, across the same market rater versions as Plan the next question. Send programs as you sent them there: a program without a version is read at the version this server rates with.
The result is exact with the value to store at path, candidates (a date written two ways), none, or refused with why. Saving never chooses among answers: for a question with listed answers only a listed value or label as written matches (case, spacing and punctuation folded); anything else is refused with search, and Search the answers of a planning question finds what was meant. What is read is how a value is written: dates in forms that parse one way, amounts such as 100k and $100,000, limits such as 100/300, a ZIP+4 as its ZIP, and a code kept shorter than it is typed as its kept form or its whole full form whose check holds (x-reduce, x-check), else refused with the rule it broke.
Send answers when the question’s answers depend on earlier ones, as a car’s model does on its make.
A version that cannot be read or rated is not asked: notAsked names it with why, and the match is the other versions’ alone. The request fails only when no version can be asked.
Needs access to rate every named version and your raters:run permission. Matching changes nothing, so the request is safe to repeat.
POST
/
insurance
/
rating-programs
/
match
Match a said or read answer to a planning question
curl --request POST \
--url https://api.effectiveai.app/api/v2/insurance/rating-programs/match \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"value": "<unknown>",
"answers": {}
}
'import requests
url = "https://api.effectiveai.app/api/v2/insurance/rating-programs/match"
payload = {
"programs": [
{
"programId": "<string>",
"version": 1,
"title": "<string>"
}
],
"path": "<string>",
"value": "<unknown>",
"answers": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
programs: [{programId: '<string>', version: 1, title: '<string>'}],
path: '<string>',
value: '<unknown>',
answers: {}
})
};
fetch('https://api.effectiveai.app/api/v2/insurance/rating-programs/match', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.effectiveai.app/api/v2/insurance/rating-programs/match",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'programs' => [
[
'programId' => '<string>',
'version' => 1,
'title' => '<string>'
]
],
'path' => '<string>',
'value' => '<unknown>',
'answers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.effectiveai.app/api/v2/insurance/rating-programs/match"
payload := strings.NewReader("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"value\": \"<unknown>\",\n \"answers\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.effectiveai.app/api/v2/insurance/rating-programs/match")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"value\": \"<unknown>\",\n \"answers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.effectiveai.app/api/v2/insurance/rating-programs/match")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"programs\": [\n {\n \"programId\": \"<string>\",\n \"version\": 1,\n \"title\": \"<string>\"\n }\n ],\n \"path\": \"<string>\",\n \"value\": \"<unknown>\",\n \"answers\": {}\n}"
response = http.request(request)
puts response.read_body{
"exact": "<unknown>",
"notAsked": [
{
"programId": "<string>",
"version": 1,
"reason": {
"code": "<string>",
"message": "<string>"
}
}
]
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"code": "business_rejection",
"error": "The program doesn't cover rideshare use.",
"businessCode": "RIDESHARE",
"violations": [
{
"code": "RIDESHARE",
"message": "The program doesn't cover rideshare use.",
"path": "Policy.vehicles[0].rideshare",
"value": true,
"constraint": "rideshare: where not self",
"cite": "manual:anchor \"eligibility\""
}
],
"violationsTruncated": false,
"requestId": "1793385750835-0"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"businessCode": "<string>",
"violations": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"value": "<unknown>",
"constraint": "<string>",
"cite": "<string>"
}
],
"violationsTruncated": true,
"executionId": "<string>",
"accessUrl": "<string>"
}Authorizations
Effective API key. Send Authorization: Bearer sk-eai-...
Body
application/json
The programs, each at the version this server rates with or at a pinned version. Each reads only the paths its own contract declares.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
The card’s path, such as Policy.drivers[0].occupation.
Maximum string length:
500Pattern:
^[A-Za-z_][A-Za-z0-9_]*(\[\d+\])*(\.[A-Za-z_][A-Za-z0-9_]*(\[\d+\])*)*$The answer as said or read: text, or a value.
Every answer so far. Send it when the card’s answers depend on earlier ones, such as a car model on its make. An answer already stored at path is left out when the programs are rated, so it never narrows its own choices.
Show child attributes
Show child attributes
Response
The matched value, the candidates, or none.
- Option 1
- Option 2
- Option 3
- Option 4
The stored value to answer with.
The programs that could not be asked: one that could not be read is asked nothing, and one that could not rate answers gave none of the choices they narrow. The match is the other programs’ alone, so an answer only these programs take reads as none. Absent when every program was asked.
Show child attributes
Show child attributes