Plan the next question for market rater versions

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "programs": [
    {
      "programId": "<string>",
      "version": 1,
      "title": "<string>"
    }
  ],
  "answers": {},
  "skipped": [],
  "after": null,
  "sections": [],
  "offered": [],
  "confirmed": [],
  "previous": [],
  "asOf": "2023-12-25",
  "fills": [],
  "choices": {},
  "overrides": []
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan"

payload = {
    "programs": [
        {
            "programId": "<string>",
            "version": 1,
            "title": "<string>"
        }
    ],
    "answers": {},
    "skipped": [],
    "after": None,
    "sections": [],
    "offered": [],
    "confirmed": [],
    "previous": [],
    "asOf": "2023-12-25",
    "fills": [],
    "choices": {},
    "overrides": []
}
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>'}],
    answers: {},
    skipped: [],
    after: null,
    sections: [],
    offered: [],
    confirmed: [],
    previous: [],
    asOf: '2023-12-25',
    fills: [],
    choices: {},
    overrides: []
  })
};

fetch('https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan', 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.canary.effectiveai.app/api/v2/insurance/rating-programs/plan",
  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>'
        ]
    ],
    'answers' => [
        
    ],
    'skipped' => [
        
    ],
    'after' => null,
    'sections' => [
        
    ],
    'offered' => [
        
    ],
    'confirmed' => [
        
    ],
    'previous' => [
        
    ],
    'asOf' => '2023-12-25',
    'fills' => [
        
    ],
    'choices' => [
        
    ],
    'overrides' => [
        
    ]
  ]),
  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.canary.effectiveai.app/api/v2/insurance/rating-programs/plan"

	payload := strings.NewReader("{\n  \"programs\": [\n    {\n      \"programId\": \"<string>\",\n      \"version\": 1,\n      \"title\": \"<string>\"\n    }\n  ],\n  \"answers\": {},\n  \"skipped\": [],\n  \"after\": null,\n  \"sections\": [],\n  \"offered\": [],\n  \"confirmed\": [],\n  \"previous\": [],\n  \"asOf\": \"2023-12-25\",\n  \"fills\": [],\n  \"choices\": {},\n  \"overrides\": []\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.canary.effectiveai.app/api/v2/insurance/rating-programs/plan")
  .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  \"answers\": {},\n  \"skipped\": [],\n  \"after\": null,\n  \"sections\": [],\n  \"offered\": [],\n  \"confirmed\": [],\n  \"previous\": [],\n  \"asOf\": \"2023-12-25\",\n  \"fills\": [],\n  \"choices\": {},\n  \"overrides\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan")

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  \"answers\": {},\n  \"skipped\": [],\n  \"after\": null,\n  \"sections\": [],\n  \"offered\": [],\n  \"confirmed\": [],\n  \"previous\": [],\n  \"asOf\": \"2023-12-25\",\n  \"fills\": [],\n  \"choices\": {},\n  \"overrides\": []\n}"

response = http.request(request)
puts response.read_body

{
  "asOf": "<string>",
  "answers": {},
  "task": {
    "kind": "answer_screen",
    "screen": {
      "id": "<string>",
      "kind": "<string>",
      "cards": [
        {
          "kind": "yesno",
          "path": "<string>",
          "text": "<string>",
          "section": "<string>",
          "screen": "<string>",
          "screenName": "<string>",
          "because": {
            "path": "<string>",
            "shown": "<string>"
          },
          "related": {
            "path": "<string>",
            "shown": "<string>"
          },
          "why": {
            "askedBy": "all",
            "blocks": [
              "<string>"
            ],
            "reasons": {},
            "stillSettled": 123
          },
          "help": "<string>",
          "evidence": [
            {
              "kind": "<string>",
              "label": "<string>"
            }
          ],
          "choices": [
            {
              "label": "<string>",
              "value": null
            }
          ],
          "list": "<string>",
          "format": "<string>",
          "pattern": "<string>",
          "min": null,
          "max": null,
          "whole": true,
          "key": "<string>",
          "nullable": true,
          "you": {
            "field": "<string>",
            "value": null
          },
          "more": true,
          "revisit": true,
          "error": "<string>",
          "document": "<string>",
          "answers": 123,
          "suggested": {
            "from": "<string>",
            "value": null,
            "name": "<string>",
            "source": "<string>"
          },
          "checklist": "<string>",
          "statement": "<string>",
          "noneAnswer": {
            "label": "<string>",
            "gate": "<string>"
          }
        }
      ],
      "name": "<string>"
    }
  },
  "open": [
    {
      "path": "<string>",
      "programs": [
        "<string>"
      ],
      "deferred": true
    }
  ],
  "next": {
    "kind": "yesno",
    "path": "<string>",
    "text": "<string>",
    "section": "<string>",
    "screen": "<string>",
    "screenName": "<string>",
    "because": {
      "path": "<string>",
      "shown": "<string>"
    },
    "related": {
      "path": "<string>",
      "shown": "<string>"
    },
    "why": {
      "askedBy": "all",
      "blocks": [
        "<string>"
      ],
      "reasons": {},
      "stillSettled": 123
    },
    "help": "<string>",
    "evidence": [
      {
        "kind": "<string>",
        "label": "<string>"
      }
    ],
    "choices": [
      {
        "label": "<string>",
        "value": null
      }
    ],
    "list": "<string>",
    "format": "<string>",
    "pattern": "<string>",
    "min": null,
    "max": null,
    "whole": true,
    "key": "<string>",
    "nullable": true,
    "you": {
      "field": "<string>",
      "value": null
    },
    "more": true,
    "revisit": true,
    "error": "<string>",
    "document": "<string>",
    "answers": 123,
    "suggested": {
      "from": "<string>",
      "value": null,
      "name": "<string>",
      "source": "<string>"
    },
    "checklist": "<string>",
    "statement": "<string>",
    "noneAnswer": {
      "label": "<string>",
      "gate": "<string>"
    }
  },
  "questions": [
    {
      "kind": "yesno",
      "path": "<string>",
      "text": "<string>",
      "section": "<string>",
      "screen": "<string>",
      "screenName": "<string>",
      "because": {
        "path": "<string>",
        "shown": "<string>"
      },
      "related": {
        "path": "<string>",
        "shown": "<string>"
      },
      "why": {
        "askedBy": "all",
        "blocks": [
          "<string>"
        ],
        "reasons": {},
        "stillSettled": 123
      },
      "help": "<string>",
      "evidence": [
        {
          "kind": "<string>",
          "label": "<string>"
        }
      ],
      "choices": [
        {
          "label": "<string>",
          "value": null
        }
      ],
      "list": "<string>",
      "format": "<string>",
      "pattern": "<string>",
      "min": null,
      "max": null,
      "whole": true,
      "key": "<string>",
      "nullable": true,
      "you": {
        "field": "<string>",
        "value": null
      },
      "more": true,
      "revisit": true,
      "error": "<string>",
      "document": "<string>",
      "answers": 123,
      "suggested": {
        "from": "<string>",
        "value": null,
        "name": "<string>",
        "source": "<string>"
      },
      "checklist": "<string>",
      "statement": "<string>",
      "noneAnswer": {
        "label": "<string>",
        "gate": "<string>"
      }
    }
  ],
  "ready": [
    "<string>"
  ],
  "changes": [
    {
      "program": "<string>",
      "from": "priced",
      "to": "priced",
      "because": "<string>",
      "reason": "<string>"
    }
  ],
  "choices": [
    {
      "path": "<string>",
      "text": "<string>",
      "kind": "<string>",
      "steps": [
        {
          "label": "<string>",
          "programs": [
            "<string>"
          ],
          "programIds": [
            "<string>"
          ],
          "common": true,
          "value": null
        }
      ],
      "nullable": true,
      "section": "<string>",
      "help": "<string>",
      "current": "<unknown>",
      "shape": "<string>",
      "code": "<string>",
      "parts": [
        "<string>"
      ]
    }
  ],
  "names": {},
  "issues": [
    {
      "path": "<string>",
      "code": "<string>",
      "expected": "<unknown>",
      "candidates": [
        null
      ]
    }
  ],
  "screens": [
    {
      "id": "<string>",
      "kind": "item",
      "cards": [
        {
          "kind": "yesno",
          "path": "<string>",
          "text": "<string>",
          "section": "<string>",
          "screen": "<string>",
          "screenName": "<string>",
          "because": {
            "path": "<string>",
            "shown": "<string>"
          },
          "related": {
            "path": "<string>",
            "shown": "<string>"
          },
          "why": {
            "askedBy": "all",
            "blocks": [
              "<string>"
            ],
            "reasons": {},
            "stillSettled": 123
          },
          "help": "<string>",
          "evidence": [
            {
              "kind": "<string>",
              "label": "<string>"
            }
          ],
          "choices": [
            {
              "label": "<string>",
              "value": null
            }
          ],
          "list": "<string>",
          "format": "<string>",
          "pattern": "<string>",
          "min": null,
          "max": null,
          "whole": true,
          "key": "<string>",
          "nullable": true,
          "you": {
            "field": "<string>",
            "value": null
          },
          "more": true,
          "revisit": true,
          "error": "<string>",
          "document": "<string>",
          "answers": 123,
          "suggested": {
            "from": "<string>",
            "value": null,
            "name": "<string>",
            "source": "<string>"
          },
          "checklist": "<string>",
          "statement": "<string>",
          "noneAnswer": {
            "label": "<string>",
            "gate": "<string>"
          }
        }
      ],
      "name": "<string>"
    }
  ],
  "progress": {
    "left": 123,
    "programs": [
      {
        "id": "<string>",
        "left": 123
      }
    ],
    "counted": true
  },
  "programs": [
    {
      "programId": "<string>",
      "version": 1,
      "bundleId": "<string>",
      "programFingerprint": "<string>",
      "status": "priced",
      "waitingOn": 123,
      "choices": [
        {
          "path": "<string>",
          "status": "exact",
          "asked": "<unknown>",
          "priced": "<unknown>",
          "nearest": "<unknown>",
          "options": [
            null
          ],
          "suggested": "<unknown>"
        }
      ],
      "result": {},
      "refusal": {
        "violations": [
          null
        ],
        "truncated": true
      },
      "missing": [
        {
          "path": "<string>",
          "reasons": [
            "<string>"
          ],
          "choices": [
            null
          ],
          "more": true,
          "list": "<string>"
        }
      ],
      "inputs": {},
      "evaluateMs": 123
    }
  ]
}

{
  "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

Plan the next question for market rater versions

Name the market rater versions a household may be rated by, send every answer so far, and get the next question and each version’s status. A version’s status is priced, declined, invalid or open, as for rating with allowMissing.

Effective stores nothing between calls: each call carries all answers, so the same request always returns the same question, and a retry is safe. One set of answers serves the whole basket, and each version reads only the paths its own input contract declares. next is a card the person answers: its kind and format say which input to show, and its path says where the answer goes in answers. It is null once every version is priced or declined. questions holds every open card in asking order, each with its screen, the record it belongs to: show a screen’s cards together.

Send each version’s status from the previous call as previous: changes then names each version whose status changed, with the refused answer for a decline. Send asOf to fill look-back windows such as “since March 2016”. Send a car’s full VIN at its vin_pattern: Effective decodes it, fills the car’s vpic_* answers and keeps only the pattern, and returns the answers as it read them in answers. What the VIN suggests, such as the car’s year, make, model, drive, fuel and body, rides on those questions’ cards as suggested with source vin_decode: show them together and let the person confirm or correct them. A client with its own decode may send the vpic_* answers instead. Send fills for what else you fill from an answer: a question that fills others is asked before them.

Coverage is chosen, not asked: choices in the response lists each limit, deductible or term the basket prices, with every program’s steps. Send the person’s choices as choices, by path. Each version is rated at its own nearest step, by the shape its contract gives the choice: a limit up, a limit pair up as one pair, a deductible down. It reports in its choices what it priced. When some versions do not sell a choice as asked, task.differences lists them with the steps they do offer: ask the person once, and send the pick as overrides.

issues lists answers or choices the versions’ contracts cannot read as sent, each with its path, a code and, where known, what is expected and candidates that may be meant. Correct them and plan again.

Needs access to rate every named version and your raters:run permission. Rating changes nothing, so the request is safe to repeat.

POST

insurance

rating-programs

plan

Plan the next question for market rater versions

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "programs": [
    {
      "programId": "<string>",
      "version": 1,
      "title": "<string>"
    }
  ],
  "answers": {},
  "skipped": [],
  "after": null,
  "sections": [],
  "offered": [],
  "confirmed": [],
  "previous": [],
  "asOf": "2023-12-25",
  "fills": [],
  "choices": {},
  "overrides": []
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan"

payload = {
    "programs": [
        {
            "programId": "<string>",
            "version": 1,
            "title": "<string>"
        }
    ],
    "answers": {},
    "skipped": [],
    "after": None,
    "sections": [],
    "offered": [],
    "confirmed": [],
    "previous": [],
    "asOf": "2023-12-25",
    "fills": [],
    "choices": {},
    "overrides": []
}
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>'}],
    answers: {},
    skipped: [],
    after: null,
    sections: [],
    offered: [],
    confirmed: [],
    previous: [],
    asOf: '2023-12-25',
    fills: [],
    choices: {},
    overrides: []
  })
};

fetch('https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan', 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.canary.effectiveai.app/api/v2/insurance/rating-programs/plan",
  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>'
        ]
    ],
    'answers' => [
        
    ],
    'skipped' => [
        
    ],
    'after' => null,
    'sections' => [
        
    ],
    'offered' => [
        
    ],
    'confirmed' => [
        
    ],
    'previous' => [
        
    ],
    'asOf' => '2023-12-25',
    'fills' => [
        
    ],
    'choices' => [
        
    ],
    'overrides' => [
        
    ]
  ]),
  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.canary.effectiveai.app/api/v2/insurance/rating-programs/plan"

	payload := strings.NewReader("{\n  \"programs\": [\n    {\n      \"programId\": \"<string>\",\n      \"version\": 1,\n      \"title\": \"<string>\"\n    }\n  ],\n  \"answers\": {},\n  \"skipped\": [],\n  \"after\": null,\n  \"sections\": [],\n  \"offered\": [],\n  \"confirmed\": [],\n  \"previous\": [],\n  \"asOf\": \"2023-12-25\",\n  \"fills\": [],\n  \"choices\": {},\n  \"overrides\": []\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.canary.effectiveai.app/api/v2/insurance/rating-programs/plan")
  .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  \"answers\": {},\n  \"skipped\": [],\n  \"after\": null,\n  \"sections\": [],\n  \"offered\": [],\n  \"confirmed\": [],\n  \"previous\": [],\n  \"asOf\": \"2023-12-25\",\n  \"fills\": [],\n  \"choices\": {},\n  \"overrides\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/insurance/rating-programs/plan")

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  \"answers\": {},\n  \"skipped\": [],\n  \"after\": null,\n  \"sections\": [],\n  \"offered\": [],\n  \"confirmed\": [],\n  \"previous\": [],\n  \"asOf\": \"2023-12-25\",\n  \"fills\": [],\n  \"choices\": {},\n  \"overrides\": []\n}"

response = http.request(request)
puts response.read_body

{
  "asOf": "<string>",
  "answers": {},
  "task": {
    "kind": "answer_screen",
    "screen": {
      "id": "<string>",
      "kind": "<string>",
      "cards": [
        {
          "kind": "yesno",
          "path": "<string>",
          "text": "<string>",
          "section": "<string>",
          "screen": "<string>",
          "screenName": "<string>",
          "because": {
            "path": "<string>",
            "shown": "<string>"
          },
          "related": {
            "path": "<string>",
            "shown": "<string>"
          },
          "why": {
            "askedBy": "all",
            "blocks": [
              "<string>"
            ],
            "reasons": {},
            "stillSettled": 123
          },
          "help": "<string>",
          "evidence": [
            {
              "kind": "<string>",
              "label": "<string>"
            }
          ],
          "choices": [
            {
              "label": "<string>",
              "value": null
            }
          ],
          "list": "<string>",
          "format": "<string>",
          "pattern": "<string>",
          "min": null,
          "max": null,
          "whole": true,
          "key": "<string>",
          "nullable": true,
          "you": {
            "field": "<string>",
            "value": null
          },
          "more": true,
          "revisit": true,
          "error": "<string>",
          "document": "<string>",
          "answers": 123,
          "suggested": {
            "from": "<string>",
            "value": null,
            "name": "<string>",
            "source": "<string>"
          },
          "checklist": "<string>",
          "statement": "<string>",
          "noneAnswer": {
            "label": "<string>",
            "gate": "<string>"
          }
        }
      ],
      "name": "<string>"
    }
  },
  "open": [
    {
      "path": "<string>",
      "programs": [
        "<string>"
      ],
      "deferred": true
    }
  ],
  "next": {
    "kind": "yesno",
    "path": "<string>",
    "text": "<string>",
    "section": "<string>",
    "screen": "<string>",
    "screenName": "<string>",
    "because": {
      "path": "<string>",
      "shown": "<string>"
    },
    "related": {
      "path": "<string>",
      "shown": "<string>"
    },
    "why": {
      "askedBy": "all",
      "blocks": [
        "<string>"
      ],
      "reasons": {},
      "stillSettled": 123
    },
    "help": "<string>",
    "evidence": [
      {
        "kind": "<string>",
        "label": "<string>"
      }
    ],
    "choices": [
      {
        "label": "<string>",
        "value": null
      }
    ],
    "list": "<string>",
    "format": "<string>",
    "pattern": "<string>",
    "min": null,
    "max": null,
    "whole": true,
    "key": "<string>",
    "nullable": true,
    "you": {
      "field": "<string>",
      "value": null
    },
    "more": true,
    "revisit": true,
    "error": "<string>",
    "document": "<string>",
    "answers": 123,
    "suggested": {
      "from": "<string>",
      "value": null,
      "name": "<string>",
      "source": "<string>"
    },
    "checklist": "<string>",
    "statement": "<string>",
    "noneAnswer": {
      "label": "<string>",
      "gate": "<string>"
    }
  },
  "questions": [
    {
      "kind": "yesno",
      "path": "<string>",
      "text": "<string>",
      "section": "<string>",
      "screen": "<string>",
      "screenName": "<string>",
      "because": {
        "path": "<string>",
        "shown": "<string>"
      },
      "related": {
        "path": "<string>",
        "shown": "<string>"
      },
      "why": {
        "askedBy": "all",
        "blocks": [
          "<string>"
        ],
        "reasons": {},
        "stillSettled": 123
      },
      "help": "<string>",
      "evidence": [
        {
          "kind": "<string>",
          "label": "<string>"
        }
      ],
      "choices": [
        {
          "label": "<string>",
          "value": null
        }
      ],
      "list": "<string>",
      "format": "<string>",
      "pattern": "<string>",
      "min": null,
      "max": null,
      "whole": true,
      "key": "<string>",
      "nullable": true,
      "you": {
        "field": "<string>",
        "value": null
      },
      "more": true,
      "revisit": true,
      "error": "<string>",
      "document": "<string>",
      "answers": 123,
      "suggested": {
        "from": "<string>",
        "value": null,
        "name": "<string>",
        "source": "<string>"
      },
      "checklist": "<string>",
      "statement": "<string>",
      "noneAnswer": {
        "label": "<string>",
        "gate": "<string>"
      }
    }
  ],
  "ready": [
    "<string>"
  ],
  "changes": [
    {
      "program": "<string>",
      "from": "priced",
      "to": "priced",
      "because": "<string>",
      "reason": "<string>"
    }
  ],
  "choices": [
    {
      "path": "<string>",
      "text": "<string>",
      "kind": "<string>",
      "steps": [
        {
          "label": "<string>",
          "programs": [
            "<string>"
          ],
          "programIds": [
            "<string>"
          ],
          "common": true,
          "value": null
        }
      ],
      "nullable": true,
      "section": "<string>",
      "help": "<string>",
      "current": "<unknown>",
      "shape": "<string>",
      "code": "<string>",
      "parts": [
        "<string>"
      ]
    }
  ],
  "names": {},
  "issues": [
    {
      "path": "<string>",
      "code": "<string>",
      "expected": "<unknown>",
      "candidates": [
        null
      ]
    }
  ],
  "screens": [
    {
      "id": "<string>",
      "kind": "item",
      "cards": [
        {
          "kind": "yesno",
          "path": "<string>",
          "text": "<string>",
          "section": "<string>",
          "screen": "<string>",
          "screenName": "<string>",
          "because": {
            "path": "<string>",
            "shown": "<string>"
          },
          "related": {
            "path": "<string>",
            "shown": "<string>"
          },
          "why": {
            "askedBy": "all",
            "blocks": [
              "<string>"
            ],
            "reasons": {},
            "stillSettled": 123
          },
          "help": "<string>",
          "evidence": [
            {
              "kind": "<string>",
              "label": "<string>"
            }
          ],
          "choices": [
            {
              "label": "<string>",
              "value": null
            }
          ],
          "list": "<string>",
          "format": "<string>",
          "pattern": "<string>",
          "min": null,
          "max": null,
          "whole": true,
          "key": "<string>",
          "nullable": true,
          "you": {
            "field": "<string>",
            "value": null
          },
          "more": true,
          "revisit": true,
          "error": "<string>",
          "document": "<string>",
          "answers": 123,
          "suggested": {
            "from": "<string>",
            "value": null,
            "name": "<string>",
            "source": "<string>"
          },
          "checklist": "<string>",
          "statement": "<string>",
          "noneAnswer": {
            "label": "<string>",
            "gate": "<string>"
          }
        }
      ],
      "name": "<string>"
    }
  ],
  "progress": {
    "left": 123,
    "programs": [
      {
        "id": "<string>",
        "left": 123
      }
    ],
    "counted": true
  },
  "programs": [
    {
      "programId": "<string>",
      "version": 1,
      "bundleId": "<string>",
      "programFingerprint": "<string>",
      "status": "priced",
      "waitingOn": 123,
      "choices": [
        {
          "path": "<string>",
          "status": "exact",
          "asked": "<unknown>",
          "priced": "<unknown>",
          "nearest": "<unknown>",
          "options": [
            null
          ],
          "suggested": "<unknown>"
        }
      ],
      "result": {},
      "refusal": {
        "violations": [
          null
        ],
        "truncated": true
      },
      "missing": [
        {
          "path": "<string>",
          "reasons": [
            "<string>"
          ],
          "choices": [
            null
          ],
          "more": true,
          "list": "<string>"
        }
      ],
      "inputs": {},
      "evaluateMs": 123
    }
  ]
}

{
  "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

Authorization

string

header

required

Effective API key. Send Authorization: Bearer sk-eai-...

Body

application/json

programs

object[]

required

Pinned program versions. Each reads only the paths its own contract declares.

Required array length: 1 - 10 elements

Show child attributes

answers

object

required

Every answer so far, keyed by root record.

Show child attributes

skipped

string[]

Paths the person put off, in order.

after

string | null

The path answered last.

sections

string[]

The order the host shows sections in.

offered

string[]

Document kinds already offered.

confirmed

string[]

The choices paths the person has confirmed. Keep each with the value confirmed and drop one whose value, or whose set of choices, changed.

object[]

Each program’s status from the previous call. changes lists the programs whose status differs now.

Maximum array length: 10

Show child attributes

asOf

string<date>

The date answers are as of, YYYY-MM-DD. It fills look-back windows such as “since March 2016”. No rater reads the clock.

fills

object[]

What the host fills from an answer, such as a car’s year and make from its VIN. A question that fills others is asked before them.

Maximum array length: 20

Show child attributes

choices

object

What the person buys, by path: a limit, a deductible, a term. Each program is rated at its nearest step, by the shape its contract gives the choice (x-shape): a limit or a per-day amount rounds up in every part, a limit pair up to the smallest pair at least both parts, a deductible down to the largest step at most it, and an included, tier or term choice must match. A choice a program cannot price is not_offered for it, and that program rates its default. When a program does not sell a choice as asked, task.differences says so and overrides takes the person’s pick.

Show child attributes

overrides

object[]

The person’s picks for programs that do not sell a choice as asked: each program is priced at its pick in place of its nearest step. Answer each of task.differences with one pick per program (accepting the suggestion is a pick equal to suggested). A pick is ignored, so its choice is asked again, once the choice is no longer asked, or when it names a program outside the basket or a step its program does not sell (a new version may drop one).

Maximum array length: 200

Show child attributes

Response

The next question and each version’s status.

asOf

string | null

required

The request’s asOf.

answers

object

required

The answers as Effective read them: a full VIN given at a car’s vin_pattern is cut down to its pattern, with what its decode filled (the car’s vpic_* answers). Send these back on the next call.

Show child attributes

task

object

required

The one thing the person does next: answer_screen while an open question is not put off; else confirm_choices while a choice is not confirmed; else review_results, each program where it stands.

Option 1
Option 2
Option 3

Show child attributes

open

object[]

required

Every open fact once, with the programs that need it: group programs (two of one insurer) by the union of their paths so a shared fact counts once.

Show child attributes

object

required

The next question card, the first of questions, or null when every program is settled.

Show child attributes

questions

object[]

required

Every open card, in asking order.

Show child attributes

ready

string[]

required

The programs that are settled, as programId@version.

changes

object[]

required

Each program whose status differs from previous.

Show child attributes

choices

object[]

required

What the person buys across the basket, asked once rather than as cards.

Show child attributes

names

object

required

Each list item’s name by its path, such as Policy.vehicles[0]: “the 2020 Toyota RAV4”.

Show child attributes

issues

object[]

required

Answers in answers or choices that the basket’s contracts cannot read as sent. Correct each and plan again.

Show child attributes

screens

object[]

required

The questions packed into what a host shows at once; next is the first’s first.

Show child attributes

progress

object

required

How much is left.

Show child attributes

programs

object[]

required

Show child attributes

Managed Products

Insurance Types

Companies

Jurisdictions

Objections

Answers

Form comparisons

Loss reviews

Access

Users

Groups

Agent email aliases

Webhooks

NAIC statutory data

Carriers

Carrier groups

MGAs

Product types

Products

Product timelines

Market raters

Filings

Files

Managed Filings

Managed Filing Checks

Filing objections

Regulatory documents

OSHA

SERFF Imports

SERFF Insurance Types

Your raters

Sessions

Skills

Device sign-in

Shares

Filing reviews

Plan the next question for market rater versions

Authorizations

Body

Response