Record statements on an underwriting file

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "after": 1073741823,
  "statements": [
    {
      "op": "open",
      "products": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements"

payload = {
    "after": 1073741823,
    "statements": [
        {
            "op": "open",
            "products": ["<string>"]
        }
    ]
}
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({after: 1073741823, statements: [{op: 'open', products: ['<string>']}]})
};

fetch('https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements', 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}/statements",
  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([
    'after' => 1073741823,
    'statements' => [
        [
                'op' => 'open',
                'products' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  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/underwriting/files/{fileId}/statements"

	payload := strings.NewReader("{\n  \"after\": 1073741823,\n  \"statements\": [\n    {\n      \"op\": \"open\",\n      \"products\": [\n        \"<string>\"\n      ]\n    }\n  ]\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/underwriting/files/{fileId}/statements")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"after\": 1073741823,\n  \"statements\": [\n    {\n      \"op\": \"open\",\n      \"products\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements")

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  \"after\": 1073741823,\n  \"statements\": [\n    {\n      \"op\": \"open\",\n      \"products\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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>"
      }
    ]
  },
  "dryRun": true,
  "applyId": "<string>",
  "seqs": [
    123
  ],
  "replayed": true,
  "entries": [
    {
      "id": "<string>",
      "seq": 123,
      "status": "<string>",
      "actor": {
        "userId": "<string>",
        "side": "<string>",
        "role": "<string>",
        "owner": "<string>",
        "human": true
      },
      "recordedAt": "2023-11-07T05:31:56Z",
      "applyId": "<string>",
      "op": {
        "op": "open",
        "products": [
          "<string>"
        ]
      }
    }
  ],
  "runs": [
    {
      "id": "<string>",
      "rater": "<string>",
      "package": "<string>",
      "coveragePart": "<string>",
      "raterId": "<string>",
      "releaseVersion": 123,
      "bundleId": "<string>",
      "executionId": "<string>",
      "ok": true,
      "request": {},
      "inputsDigest": "<string>",
      "outputs": {},
      "refusal": {
        "code": "invalid_inputs",
        "violations": [
          {
            "code": "<string>",
            "message": "<string>",
            "path": "<string>",
            "value": "<unknown>",
            "constraint": "<string>",
            "cite": "<string>"
          }
        ],
        "violationsTruncated": true
      },
      "afterSeq": 123,
      "ratedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "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>"
      }
    ]
  },
  "dryRun": true,
  "applyId": "<string>",
  "seqs": [
    123
  ],
  "replayed": true,
  "entries": [
    {
      "id": "<string>",
      "seq": 123,
      "status": "<string>",
      "actor": {
        "userId": "<string>",
        "side": "<string>",
        "role": "<string>",
        "owner": "<string>",
        "human": true
      },
      "recordedAt": "2023-11-07T05:31:56Z",
      "applyId": "<string>",
      "op": {
        "op": "open",
        "products": [
          "<string>"
        ]
      }
    }
  ],
  "runs": [
    {
      "id": "<string>",
      "rater": "<string>",
      "package": "<string>",
      "coveragePart": "<string>",
      "raterId": "<string>",
      "releaseVersion": 123,
      "bundleId": "<string>",
      "executionId": "<string>",
      "ok": true,
      "request": {},
      "inputsDigest": "<string>",
      "outputs": {},
      "refusal": {
        "code": "invalid_inputs",
        "violations": [
          {
            "code": "<string>",
            "message": "<string>",
            "path": "<string>",
            "value": "<unknown>",
            "constraint": "<string>",
            "cite": "<string>"
          }
        ],
        "violationsTruncated": true
      },
      "afterSeq": 123,
      "ratedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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

Record statements on an underwriting file

Record what someone said or decided on an underwriting file: answers, list items, accepted values, referral decisions, quote requests, quotes and binds, as typed statements (op and its fields; no RSL needed), with after, the lastSeq you read. They are appended in order, all or nothing, as you in your first role; the manual decides what that role may do.

Before the response, the ratings the change asks are made with the manual’s bound rater bundles, through the same rater path as /v2/insurance/raters, and each is kept as a run with a rater execution record; then any entries the manual owes (such as an automatic quote) are appended. Only raters you may run (raters:run) are rated: any other rating, or one the rater cannot answer now, stays needed in the view’s ratings with its reason, and the next change rates it. Reading the file never rates. A quote or bind needs every rating its offer reads to be current. The response has the new seqs, every entry appended (each as its typed op), the runs made, and the same view getUnderwritingFile returns.

With dryRun=true nothing is stored: the response is what the statements would do, with dryRun: true and empty seqs. The what-if is rated too, so the preview is priced, and its runs are not kept and have no execution record. A dry run needs read access only (read-only keys work), ignores Idempotency-Key and is safe to repeat; its refusals are those of a write.

Refusals change nothing: 409 stale_after when the log moved past after (read again and resend with lastSeq); 403 authority_required when another role must do it; 409 wrong_stage, offer_blocked, rating_not_valid or file_closed; 422 statement_rejected for a statement the manual cannot apply. Each names statementIndex (and runtimeCode, for diagnosis only). Retrying with the same after is safe: a recorded first attempt makes the retry 409. With an Idempotency-Key, a retry of an applied request returns it again with replayed: true for 24 hours. Requires edit access to the file.

POST

insurance

underwriting

files

{fileId}

statements

Record statements on an underwriting file

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "after": 1073741823,
  "statements": [
    {
      "op": "open",
      "products": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements"

payload = {
    "after": 1073741823,
    "statements": [
        {
            "op": "open",
            "products": ["<string>"]
        }
    ]
}
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({after: 1073741823, statements: [{op: 'open', products: ['<string>']}]})
};

fetch('https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements', 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}/statements",
  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([
    'after' => 1073741823,
    'statements' => [
        [
                'op' => 'open',
                'products' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  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/underwriting/files/{fileId}/statements"

	payload := strings.NewReader("{\n  \"after\": 1073741823,\n  \"statements\": [\n    {\n      \"op\": \"open\",\n      \"products\": [\n        \"<string>\"\n      ]\n    }\n  ]\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/underwriting/files/{fileId}/statements")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"after\": 1073741823,\n  \"statements\": [\n    {\n      \"op\": \"open\",\n      \"products\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/insurance/underwriting/files/{fileId}/statements")

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  \"after\": 1073741823,\n  \"statements\": [\n    {\n      \"op\": \"open\",\n      \"products\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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>"
      }
    ]
  },
  "dryRun": true,
  "applyId": "<string>",
  "seqs": [
    123
  ],
  "replayed": true,
  "entries": [
    {
      "id": "<string>",
      "seq": 123,
      "status": "<string>",
      "actor": {
        "userId": "<string>",
        "side": "<string>",
        "role": "<string>",
        "owner": "<string>",
        "human": true
      },
      "recordedAt": "2023-11-07T05:31:56Z",
      "applyId": "<string>",
      "op": {
        "op": "open",
        "products": [
          "<string>"
        ]
      }
    }
  ],
  "runs": [
    {
      "id": "<string>",
      "rater": "<string>",
      "package": "<string>",
      "coveragePart": "<string>",
      "raterId": "<string>",
      "releaseVersion": 123,
      "bundleId": "<string>",
      "executionId": "<string>",
      "ok": true,
      "request": {},
      "inputsDigest": "<string>",
      "outputs": {},
      "refusal": {
        "code": "invalid_inputs",
        "violations": [
          {
            "code": "<string>",
            "message": "<string>",
            "path": "<string>",
            "value": "<unknown>",
            "constraint": "<string>",
            "cite": "<string>"
          }
        ],
        "violationsTruncated": true
      },
      "afterSeq": 123,
      "ratedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "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>"
      }
    ]
  },
  "dryRun": true,
  "applyId": "<string>",
  "seqs": [
    123
  ],
  "replayed": true,
  "entries": [
    {
      "id": "<string>",
      "seq": 123,
      "status": "<string>",
      "actor": {
        "userId": "<string>",
        "side": "<string>",
        "role": "<string>",
        "owner": "<string>",
        "human": true
      },
      "recordedAt": "2023-11-07T05:31:56Z",
      "applyId": "<string>",
      "op": {
        "op": "open",
        "products": [
          "<string>"
        ]
      }
    }
  ],
  "runs": [
    {
      "id": "<string>",
      "rater": "<string>",
      "package": "<string>",
      "coveragePart": "<string>",
      "raterId": "<string>",
      "releaseVersion": 123,
      "bundleId": "<string>",
      "executionId": "<string>",
      "ok": true,
      "request": {},
      "inputsDigest": "<string>",
      "outputs": {},
      "refusal": {
        "code": "invalid_inputs",
        "violations": [
          {
            "code": "<string>",
            "message": "<string>",
            "path": "<string>",
            "value": "<unknown>",
            "constraint": "<string>",
            "cite": "<string>"
          }
        ],
        "violationsTruncated": true
      },
      "afterSeq": 123,
      "ratedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Client-chosen key for safe retries: 1-128 letters, digits, -, _, . or :. Use a new random UUID for each intended operation and the same key when retrying it. Do not put customer data or credentials in the key.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9\-_.:]+$

Path Parameters

fileId

string<uuid>

required

Underwriting file ID: the id of createUnderwritingFile or listUnderwritingFiles.

Query Parameters

dryRun

enum<string>

default:false

true to compute what the statements would do and store nothing (200, dryRun: true). Defaults to false.

Available options:

true,

false

Body

application/json

after

integer

required

The lastSeq you last read; 0 for an empty log. If the log moved on, nothing is written (or, on a dry run, computed) and the response is 409 stale_after.

Required range: 0 <= x <= 2147483647

statements

object[]

required

Typed statements, appended in order, all or nothing.

Required array length: 1 - 200 elements

Open the underwriting file on products the manual sells.

Show child attributes

Response

A dry run: what the statements would do, with nothing stored.

file

object

required

Show child attributes

lastSeq

integer

required

Send as after with your next statements.

actingAs

object

required

Who you act as here.

Show child attributes

view

object

required

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

dryRun

boolean

required

True for dryRun=true: nothing was stored. entries, runs and view are what the statements would produce, priced; file is as stored.

applyId

string | null

required

This request; the entries it wrote carry it. Null on a dry run.

seqs

integer[]

required

Seqs of the entries your statements appended (the manual’s own entries after them are in entries); empty on a dry run.

replayed

boolean

required

True when this Idempotency-Key was already applied: nothing new was appended.

entries

object[]

required

The entries appended (on a dry run, that would be): your statements, then any the manual wrote itself after them.

Show child attributes

runs

object[]

required

The ratings this request made with the manual’s bound rater bundles, each kept for good with a rater execution record. On a dry run the what-if is rated too, so the preview is priced, and nothing is kept. Ratings it did not make are in view.ratings as needed, with their reason.

Show child attributes