List catalog filings

curl --request GET \
  --url https://canary.effectiveai.app/api/v2/filings \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://canary.effectiveai.app/api/v2/filings', 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://canary.effectiveai.app/api/v2/filings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://canary.effectiveai.app/api/v2/filings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://canary.effectiveai.app/api/v2/filings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "filings": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "<string>",
      "sourceReference": "<string>",
      "state": "<string>",
      "companyName": "<string>",
      "carrierIds": [
        "<string>"
      ],
      "groupId": "<string>",
      "productName": "<string>",
      "typeOfInsurance": "<string>",
      "subTypeOfInsurance": "<string>",
      "toiCode": "<string>",
      "subToiCode": "<string>",
      "filingType": "<string>",
      "sourceStatus": "<string>",
      "submissionDate": "2023-12-25",
      "dispositionDate": "2023-12-25",
      "businessType": "<string>",
      "normalizedOutcome": "<string>",
      "filingTypeNormalized": "<string>",
      "stateStatusChangedDate": "2023-12-25",
      "description": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

GET

filings

List catalog filings

curl --request GET \
  --url https://canary.effectiveai.app/api/v2/filings \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://canary.effectiveai.app/api/v2/filings', 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://canary.effectiveai.app/api/v2/filings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://canary.effectiveai.app/api/v2/filings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://canary.effectiveai.app/api/v2/filings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "filings": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "<string>",
      "sourceReference": "<string>",
      "state": "<string>",
      "companyName": "<string>",
      "carrierIds": [
        "<string>"
      ],
      "groupId": "<string>",
      "productName": "<string>",
      "typeOfInsurance": "<string>",
      "subTypeOfInsurance": "<string>",
      "toiCode": "<string>",
      "subToiCode": "<string>",
      "filingType": "<string>",
      "sourceStatus": "<string>",
      "submissionDate": "2023-12-25",
      "dispositionDate": "2023-12-25",
      "businessType": "<string>",
      "normalizedOutcome": "<string>",
      "filingTypeNormalized": "<string>",
      "stateStatusChangedDate": "2023-12-25",
      "description": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "details": [
    {
      "location": "path",
      "path": [
        "<string>"
      ],
      "code": "required",
      "message": "<string>"
    }
  ],
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer

default:50

Required range: 1 <= x <= 200

cursor

string

Required string length: 1 - 128

carrier

Required string length: 1 - 500

group

Required string length: 1 - 500

state

Required string length: 1 - 500

Pattern: ^[a-zA-Z]{2}$

source

Available options:

serff,

florida_irfs

sourceReference

Exact native references (OR). Requires exactly one source.

Required string length: 1 - 500

companyName

Exact case-sensitive company names (OR).

Required string length: 1 - 500

companyNameContains

string

Case-insensitive substring of the company name.

Required string length: 1 - 500

productName

Exact case-sensitive product names (OR).

Required string length: 1 - 500

productNameContains

string

Case-insensitive substring of the product name.

Required string length: 1 - 500

businessType

Required string length: 1 - 500

normalizedOutcome

Available options:

APPROVED,

FILED,

ACKNOWLEDGED,

INFORMATIONAL,

REJECTED,

WITHDRAWN,

PENDING,

UNKNOWN

filingTypeNormalized

Available options:

FORM,

RATE,

RULE,

RATE_RULE,

FORM_RATE,

FORM_RULE,

FORM_RATE_RULE,

ENDORSEMENT,

LOSS_COST,

ADVERTISING,

CERTIFICATION,

CONTRACT,

CONSENT_TO_RATE,

DEVIATIONS,

INFORMATIONAL,

NEW_PROGRAM,

REPORT,

SERVICE_CONTRACT,

UNDERWRITING_GUIDE,

ANNUAL_FORMS_LIST,

MANUSCRIPT,

POLICY_FORM,

PREDICTIVE_MODEL,

ORGANIZATION_ADOPTION,

OTHER

excludeCarrier

Exclude filings containing any supplied carrier. Filings with unknown (null) carrier codes are not returned.

Required string length: 1 - 500

stateStatusChangedDateFrom

string<date>

stateStatusChangedDateTo

string<date>

toi

Required string length: 1 - 20

Pattern: ^\d+(?:\.\d+)*$

subToi

Required string length: 1 - 20

Pattern: ^\d+(?:\.\d+)*$

filingType

Required string length: 1 - 500

sourceStatus

Required string length: 1 - 500

submissionDateFrom

string<date>

submissionDateTo

string<date>

dispositionDateFrom

string<date>

dispositionDateTo

string<date>

sort

default:-submissionDate

Up to three ordered sort keys. Repeat sort in priority order; prefix a field with - for descending. Nulls last, then filing ID ascending. Default: -submissionDate.

Available options:

submissionDate,

dispositionDate,

stateStatusChangedDate,

companyName,

state,

sourceReference,

-submissionDate,

-dispositionDate,

-stateStatusChangedDate,

-companyName,

-state,

-sourceReference

Response

A page of filings.

filings

object[]

required

Show child attributes

nextCursor

string | null

required

Users

Carriers

MGAs

Products

Filings

Files

Managed Filings

List catalog filings

Authorizations

Query Parameters

Response