Start an underwriting submission
curl --request POST \
--url https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agencyAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "received",
"submissionReference": "<string>",
"requestedEffectiveDate": "2023-12-25",
"requestedExpirationDate": "2023-12-25",
"receivedAt": "2023-11-07T05:31:56Z",
"agencyMessage": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions"
payload = {
"scope": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agencyAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "received",
"submissionReference": "<string>",
"requestedEffectiveDate": "2023-12-25",
"requestedExpirationDate": "2023-12-25",
"receivedAt": "2023-11-07T05:31:56Z",
"agencyMessage": "<string>",
"description": "<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({
scope: '<string>',
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
agencyAccountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
status: 'received',
submissionReference: '<string>',
requestedEffectiveDate: '2023-12-25',
requestedExpirationDate: '2023-12-25',
receivedAt: '2023-11-07T05:31:56Z',
agencyMessage: '<string>',
description: '<string>'
})
};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions', 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/uw-submissions",
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([
'scope' => '<string>',
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'agencyAccountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'status' => 'received',
'submissionReference' => '<string>',
'requestedEffectiveDate' => '2023-12-25',
'requestedExpirationDate' => '2023-12-25',
'receivedAt' => '2023-11-07T05:31:56Z',
'agencyMessage' => '<string>',
'description' => '<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/uw-submissions"
payload := strings.NewReader("{\n \"scope\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agencyAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"status\": \"received\",\n \"submissionReference\": \"<string>\",\n \"requestedEffectiveDate\": \"2023-12-25\",\n \"requestedExpirationDate\": \"2023-12-25\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"agencyMessage\": \"<string>\",\n \"description\": \"<string>\"\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/uw-submissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agencyAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"status\": \"received\",\n \"submissionReference\": \"<string>\",\n \"requestedEffectiveDate\": \"2023-12-25\",\n \"requestedExpirationDate\": \"2023-12-25\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"agencyMessage\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions")
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 \"scope\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agencyAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"status\": \"received\",\n \"submissionReference\": \"<string>\",\n \"requestedEffectiveDate\": \"2023-12-25\",\n \"requestedExpirationDate\": \"2023-12-25\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"agencyMessage\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"status": "draft",
"productId": "<string>",
"agencyAccountId": "<string>",
"submissionReference": "<string>",
"businessType": "new",
"requestedEffectiveDate": "2023-12-25",
"requestedExpirationDate": "2023-12-25",
"receivedAt": "2023-11-07T05:31:56Z",
"agencyMessage": "<string>",
"description": "<string>",
"guidelines": {
"id": "<string>",
"versionId": "<string>",
"version": 123
}
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}Underwriting
Start an underwriting submission
Create a submission for a managed product and an agency account (the insured) in scope. status defaults to received. The submission has no file yet: open one with openUwSubmissionFile. Requires edit access to the scope; the product and agency account must be readable there. Not idempotent: titles are not unique, so after an uncertain response list submissions before retrying.
POST
/
insurance
/
uw-submissions
Start an underwriting submission
curl --request POST \
--url https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agencyAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "received",
"submissionReference": "<string>",
"requestedEffectiveDate": "2023-12-25",
"requestedExpirationDate": "2023-12-25",
"receivedAt": "2023-11-07T05:31:56Z",
"agencyMessage": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions"
payload = {
"scope": "<string>",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agencyAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "received",
"submissionReference": "<string>",
"requestedEffectiveDate": "2023-12-25",
"requestedExpirationDate": "2023-12-25",
"receivedAt": "2023-11-07T05:31:56Z",
"agencyMessage": "<string>",
"description": "<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({
scope: '<string>',
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
agencyAccountId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
status: 'received',
submissionReference: '<string>',
requestedEffectiveDate: '2023-12-25',
requestedExpirationDate: '2023-12-25',
receivedAt: '2023-11-07T05:31:56Z',
agencyMessage: '<string>',
description: '<string>'
})
};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions', 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/uw-submissions",
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([
'scope' => '<string>',
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'agencyAccountId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'status' => 'received',
'submissionReference' => '<string>',
'requestedEffectiveDate' => '2023-12-25',
'requestedExpirationDate' => '2023-12-25',
'receivedAt' => '2023-11-07T05:31:56Z',
'agencyMessage' => '<string>',
'description' => '<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/uw-submissions"
payload := strings.NewReader("{\n \"scope\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agencyAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"status\": \"received\",\n \"submissionReference\": \"<string>\",\n \"requestedEffectiveDate\": \"2023-12-25\",\n \"requestedExpirationDate\": \"2023-12-25\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"agencyMessage\": \"<string>\",\n \"description\": \"<string>\"\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/uw-submissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agencyAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"status\": \"received\",\n \"submissionReference\": \"<string>\",\n \"requestedEffectiveDate\": \"2023-12-25\",\n \"requestedExpirationDate\": \"2023-12-25\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"agencyMessage\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/uw-submissions")
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 \"scope\": \"<string>\",\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agencyAccountId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"status\": \"received\",\n \"submissionReference\": \"<string>\",\n \"requestedEffectiveDate\": \"2023-12-25\",\n \"requestedExpirationDate\": \"2023-12-25\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"agencyMessage\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"status": "draft",
"productId": "<string>",
"agencyAccountId": "<string>",
"submissionReference": "<string>",
"businessType": "new",
"requestedEffectiveDate": "2023-12-25",
"requestedExpirationDate": "2023-12-25",
"receivedAt": "2023-11-07T05:31:56Z",
"agencyMessage": "<string>",
"description": "<string>",
"guidelines": {
"id": "<string>",
"versionId": "<string>",
"version": 123
}
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic",
"accessUrl": "<string>"
}Authorizations
Effective API key. Send Authorization: Bearer sk-eai-...
Body
application/json
Authorization scope UUID or stable slug prefixed with mc:.
Pattern:
^mc:[A-Za-z0-9][A-Za-z0-9-]{0,127}$The managed product the submission is for.
The agency account (the insured) in the same scope.
Required string length:
1 - 500Available options:
draft, received, in_review, needs_information, accepted_for_quoting, declined, withdrawn Required string length:
1 - 200Available options:
new, renewal Maximum string length:
20000Maximum string length:
20000Response
The new submission, with no file yet.
Stable submission ID.
Available options:
draft, received, in_review, needs_information, accepted_for_quoting, declined, withdrawn The managed product. Null until one is chosen; a file needs it.
The agency account, which is the insured.
The agency's own reference, if any.
Available options:
new, renewal, null The agency's message with the submission.
The guidelines version the submission's file is pinned to, or null before the file is opened.
Show child attributes
Show child attributes