Get an underwriting file
curl --request GET \
--url https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}', 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/underwriting/files/{fileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"file": {
"id": "<string>",
"title": "<string>",
"status": "draft",
"agencyAccountId": "<string>",
"productId": "<string>",
"underwriterIds": [
"<string>"
],
"manualId": "<string>",
"lastSeq": 123,
"stages": [
"absent"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"lastSeq": 123,
"actingAs": {
"userId": "<string>",
"side": "carrier",
"role": "<string>",
"roles": [
"<string>"
],
"owner": "<string>",
"human": true
},
"view": {
"format": "<string>",
"lastSeq": 1,
"offers": [
{
"id": "<string>",
"stage": "absent"
}
],
"ratings": [
{
"id": "<string>",
"offers": [
"<string>"
],
"rater": {
"raterId": "<string>",
"releaseVersion": 2
},
"package": "<string>",
"bundleId": "<string>",
"inputs": {},
"inputsDigest": "<string>",
"status": "needed",
"reason": "not_permitted",
"runId": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<string>"
}
}Underwriting workbench
Get an underwriting file
An underwriting file with its view as you may see it now: each offer’s id and stage, the ratings it needs and holds, and the engine’s own fields for its view format, such as what blocks each offer, decisions, outcomes and the questions to answer next. Tolerate fields you do not know. actingAs is who you act as; lastSeq is what to send as after.
Every write returns this same view after its change. The view is computed from the stored log and ratings when you read it, so time-based rules (quote validity, lapses) are current. Requires read access to the file; missing or inaccessible files return 404. Read-only.
GET
/
insurance
/
underwriting
/
files
/
{fileId}
Get an underwriting file
curl --request GET \
--url https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}', 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/underwriting/files/{fileId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"file": {
"id": "<string>",
"title": "<string>",
"status": "draft",
"agencyAccountId": "<string>",
"productId": "<string>",
"underwriterIds": [
"<string>"
],
"manualId": "<string>",
"lastSeq": 123,
"stages": [
"absent"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"lastSeq": 123,
"actingAs": {
"userId": "<string>",
"side": "carrier",
"role": "<string>",
"roles": [
"<string>"
],
"owner": "<string>",
"human": true
},
"view": {
"format": "<string>",
"lastSeq": 1,
"offers": [
{
"id": "<string>",
"stage": "absent"
}
],
"ratings": [
{
"id": "<string>",
"offers": [
"<string>"
],
"rater": {
"raterId": "<string>",
"releaseVersion": 2
},
"package": "<string>",
"bundleId": "<string>",
"inputs": {},
"inputsDigest": "<string>",
"status": "needed",
"reason": "not_permitted",
"runId": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<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>",
"runtimeCode": "<string>",
"statementIndex": 123,
"lastSeq": 123,
"target": "<string>",
"offer": "<string>",
"blockers": [
"<string>"
],
"rating": {
"status": "<string>",
"runIds": [
"<string>"
],
"waitingOn": [
"<string>"
],
"recovery": "<string>"
}
}Authorizations
Effective API key. Send Authorization: Bearer sk-eai-...
Path Parameters
Underwriting file ID: the id of createUnderwritingFile or listUnderwritingFiles.
Response
The underwriting file and its view.
Show child attributes
Show child attributes
Send as after with your next statements.
Who you act as here.
Show child attributes
Show child attributes
The workbench view as you may see it now. format, lastSeq, the offers’ id and stage, and ratings are this API’s contract; every other field is defined by the engine’s view format. Tolerate fields you do not know.
Show child attributes
Show child attributes