Add underwriting guidelines to a product

curl --request POST \
  --url https://api.effectiveai.app/api/v2/insurance/uw-guidelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "<string>",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "source": "<string>"
}
'

import requests

url = "https://api.effectiveai.app/api/v2/insurance/uw-guidelines"

payload = {
    "scope": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "source": "<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',
    name: '<string>',
    source: '<string>'
  })
};

fetch('https://api.effectiveai.app/api/v2/insurance/uw-guidelines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.effectiveai.app/api/v2/insurance/uw-guidelines",
  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',
    'name' => '<string>',
    'source' => '<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.effectiveai.app/api/v2/insurance/uw-guidelines"

	payload := strings.NewReader("{\n  \"scope\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"source\": \"<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.effectiveai.app/api/v2/insurance/uw-guidelines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.effectiveai.app/api/v2/insurance/uw-guidelines")

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  \"name\": \"<string>\",\n  \"source\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "productId": "<string>",
  "name": "<string>",
  "fileId": "<string>",
  "versionId": "<string>",
  "version": 123,
  "updatedAt": "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "accessUrl": "<string>"
}

Underwriting

Add underwriting guidelines to a product

Save .uw.md source as new guidelines owned by a managed product, at version 1. The source is checked first: if it has problems, nothing is saved and the response is 400 invalid_request with each problem, usually with its line number, in details on source. Requires scope and edit access to the product. Not idempotent: names are not unique, so after an uncertain response list the product’s guidelines before retrying.

POST

insurance

uw-guidelines

curl --request POST \
  --url https://api.effectiveai.app/api/v2/insurance/uw-guidelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "<string>",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "source": "<string>"
}
'

import requests

url = "https://api.effectiveai.app/api/v2/insurance/uw-guidelines"

payload = {
    "scope": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "source": "<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',
    name: '<string>',
    source: '<string>'
  })
};

fetch('https://api.effectiveai.app/api/v2/insurance/uw-guidelines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.effectiveai.app/api/v2/insurance/uw-guidelines",
  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',
    'name' => '<string>',
    'source' => '<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.effectiveai.app/api/v2/insurance/uw-guidelines"

	payload := strings.NewReader("{\n  \"scope\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"source\": \"<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.effectiveai.app/api/v2/insurance/uw-guidelines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"<string>\",\n  \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"source\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.effectiveai.app/api/v2/insurance/uw-guidelines")

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  \"name\": \"<string>\",\n  \"source\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "productId": "<string>",
  "name": "<string>",
  "fileId": "<string>",
  "versionId": "<string>",
  "version": 123,
  "updatedAt": "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "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,
  "accessUrl": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

scope

string

required

Authorization scope UUID or stable slug prefixed with mc:.

Pattern: ^mc:[A-Za-z0-9][A-Za-z0-9-]{0,127}$

productId

string<uuid>

required

The managed product that will own the guidelines.

name

string

required

Name shown when choosing guidelines.

Required string length: 1 - 200

source

string

required

The guidelines as .uw.md Markdown, at most 1 MB.

Required string length: 1 - 1048576

Response

The new guidelines.

string

required

Stable guidelines ID.

productId

string

required

The managed product that owns these guidelines.

name

string

required

fileId

string

required

The stored .uw.md file. Read a version with downloadFile and versionId.

versionId

string

required

The latest version, which a newly opened file is pinned to.

version

integer

required

Latest version number, starting at 1.

updatedAt

string<date-time>

required

When the latest version was saved.

Managed Products

Insurance Types

Companies

Jurisdictions

Objections

Answers

Users

NAIC statutory data

Carriers

Carrier groups

MGAs

Product types

Products

Rating programs

Underwriting

Filings

Files

Managed Filing Checks

Managed Filings

Filing objections

Regulatory documents

OSHA

SERFF Insurance Types

Device sign-in

Add underwriting guidelines to a product

Authorizations

Body

Response