Save selected SERFF filings for import

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "<string>",
  "importSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loginId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "items": [
    {
      "sourceFilingId": "<string>",
      "trackingNumber": "<string>",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items"

payload = {
    "scope": "<string>",
    "importSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "loginId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "items": [
        {
            "sourceFilingId": "<string>",
            "trackingNumber": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ]
}
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>',
    importSessionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    loginId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    items: [
      {
        sourceFilingId: '<string>',
        trackingNumber: '<string>',
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ]
  })
};

fetch('https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items', 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/serff-import-items",
  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>',
    'importSessionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'loginId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'items' => [
        [
                'sourceFilingId' => '<string>',
                'trackingNumber' => '<string>',
                'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ]
  ]),
  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/serff-import-items"

	payload := strings.NewReader("{\n  \"scope\": \"<string>\",\n  \"importSessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"loginId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"sourceFilingId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/serff-import-items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"<string>\",\n  \"importSessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"loginId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"sourceFilingId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items")

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  \"importSessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"loginId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"sourceFilingId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ]\n}"

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

{
  "items": [
    {
      "item": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "scope": "<string>",
        "importSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "destination": "beta",
        "sourceFilingId": "<string>",
        "trackingNumber": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "loginId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "pending",
        "revision": 1,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "created": true
    }
  ]
}

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

SERFF Imports

Save selected SERFF filings for import

Register 1–100 distinct source filings as pending. Requires scope edit access, your active initialized import conversation, personal login and readable workspace Products. Restores owner-only conversation access before registration. Registration stores selections only; it does not execute an import. Duplicate source identities within the organization, scope and destination do not create another item. Identical retries return existing items without resetting status; conflicting selections or a source registered by another caller return 409, rolling back the entire batch. Returns results in input order.

POST

insurance

serff-import-items

curl --request POST \
  --url https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "<string>",
  "importSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loginId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "items": [
    {
      "sourceFilingId": "<string>",
      "trackingNumber": "<string>",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'

import requests

url = "https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items"

payload = {
    "scope": "<string>",
    "importSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "loginId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "items": [
        {
            "sourceFilingId": "<string>",
            "trackingNumber": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
    ]
}
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>',
    importSessionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    loginId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    items: [
      {
        sourceFilingId: '<string>',
        trackingNumber: '<string>',
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
      }
    ]
  })
};

fetch('https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items', 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/serff-import-items",
  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>',
    'importSessionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'loginId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'items' => [
        [
                'sourceFilingId' => '<string>',
                'trackingNumber' => '<string>',
                'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ]
    ]
  ]),
  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/serff-import-items"

	payload := strings.NewReader("{\n  \"scope\": \"<string>\",\n  \"importSessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"loginId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"sourceFilingId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/serff-import-items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"<string>\",\n  \"importSessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"loginId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"sourceFilingId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.canary.effectiveai.app/api/v2/insurance/serff-import-items")

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  \"importSessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"loginId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"items\": [\n    {\n      \"sourceFilingId\": \"<string>\",\n      \"trackingNumber\": \"<string>\",\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ]\n}"

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

{
  "items": [
    {
      "item": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "scope": "<string>",
        "importSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "destination": "beta",
        "sourceFilingId": "<string>",
        "trackingNumber": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "loginId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "pending",
        "revision": 1,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "created": true
    }
  ]
}

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

importSessionId

string<uuid>

required

destination

enum<string>

required

Available options:

beta,

production

Your saved personal login for the selected destination; passwords are never accepted.

items

object[]

required

Required array length: 1 - 100 elements

Show child attributes

Response

Registered or existing items.

items

object[]

required

Show child attributes

Managed Products

Insurance Types

Companies

Jurisdictions

Objections

Answers

Users

Webhooks

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 Imports

SERFF Insurance Types

Device sign-in

Save selected SERFF filings for import

Authorizations

Body

Response