Read a filing review from its link
curl --request GET \
--url https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}import requests
url = "https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}', 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/filing-reviews/{reviewId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"review": {
"reviewStandard": "<string>",
"findings": [
{
"id": "<string>",
"severity": "must_fix",
"title": "<string>",
"description": "<string>",
"consequence": "<string>",
"evidence": {
"kind": "excerpt",
"lines": [
{
"text": "<string>",
"note": "<string>",
"flagged": true
}
],
"location": "<string>"
},
"source": "<string>",
"nextStep": "<string>"
}
],
"passedChecks": []
},
"filing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"sourceReference": "<string>",
"state": "<string>",
"companyName": "<string>",
"carrierIds": [
"<string>"
],
"groupId": "<string>",
"naicCompanyCodes": [
"<string>"
],
"naicGroupCode": "<string>",
"productName": "<string>",
"typeOfInsurance": "<string>",
"subTypeOfInsurance": "<string>",
"toiCode": "<string>",
"subToiCode": "<string>",
"filingType": "<string>",
"sourceStatus": "<string>",
"submissionDate": "2023-12-25",
"dispositionDate": "2023-12-25",
"stateStatus": "<string>",
"dispositionStatus": "<string>",
"rateImpact": {
"overallRateImpactPercent": 123,
"overallIndicatedChangePercent": 123
}
},
"history": {
"filings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"sourceReference": "<string>",
"state": "<string>",
"companyName": "<string>",
"carrierIds": [
"<string>"
],
"groupId": "<string>",
"naicCompanyCodes": [
"<string>"
],
"naicGroupCode": "<string>",
"productName": "<string>",
"typeOfInsurance": "<string>",
"subTypeOfInsurance": "<string>",
"toiCode": "<string>",
"subToiCode": "<string>",
"filingType": "<string>",
"sourceStatus": "<string>",
"submissionDate": "2023-12-25",
"dispositionDate": "2023-12-25",
"stateStatus": "<string>",
"dispositionStatus": "<string>",
"rateImpact": {
"overallRateImpactPercent": 123,
"overallIndicatedChangePercent": 123
},
"objections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"objectionDate": "2023-12-25",
"reviewerName": "<string>",
"textPreview": "<string>",
"textTruncated": true
}
]
}
],
"related": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"sourceReference": "<string>",
"state": "<string>",
"companyName": "<string>",
"carrierIds": [
"<string>"
],
"groupId": "<string>",
"naicCompanyCodes": [
"<string>"
],
"naicGroupCode": "<string>",
"productName": "<string>",
"typeOfInsurance": "<string>",
"subTypeOfInsurance": "<string>",
"toiCode": "<string>",
"subToiCode": "<string>",
"filingType": "<string>",
"sourceStatus": "<string>",
"submissionDate": "2023-12-25",
"dispositionDate": "2023-12-25",
"stateStatus": "<string>",
"dispositionStatus": "<string>",
"rateImpact": {
"overallRateImpactPercent": 123,
"overallIndicatedChangePercent": 123
},
"objections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"objectionDate": "2023-12-25",
"reviewerName": "<string>",
"textPreview": "<string>",
"textTruncated": 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,
"executionId": "<string>",
"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,
"executionId": "<string>",
"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,
"executionId": "<string>",
"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,
"executionId": "<string>",
"accessUrl": "<string>"
}Filing reviews
Read a filing review from its link
A review of one filing that Effective shared by link, with the filing’s public catalog record and the carrier’s recent filings for the same line and state, plus other carriers’ recent filings for it.
No sign-in is required: the review ID in the link is the only authority, and it reads only this review and the filings it lists. Unknown, revoked and expired links return the same 404. Requests are rate limited per address and per review.
GET
/
filing-reviews
/
{reviewId}
Read a filing review from its link
curl --request GET \
--url https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}import requests
url = "https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}', 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/filing-reviews/{reviewId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/filing-reviews/{reviewId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"review": {
"reviewStandard": "<string>",
"findings": [
{
"id": "<string>",
"severity": "must_fix",
"title": "<string>",
"description": "<string>",
"consequence": "<string>",
"evidence": {
"kind": "excerpt",
"lines": [
{
"text": "<string>",
"note": "<string>",
"flagged": true
}
],
"location": "<string>"
},
"source": "<string>",
"nextStep": "<string>"
}
],
"passedChecks": []
},
"filing": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"sourceReference": "<string>",
"state": "<string>",
"companyName": "<string>",
"carrierIds": [
"<string>"
],
"groupId": "<string>",
"naicCompanyCodes": [
"<string>"
],
"naicGroupCode": "<string>",
"productName": "<string>",
"typeOfInsurance": "<string>",
"subTypeOfInsurance": "<string>",
"toiCode": "<string>",
"subToiCode": "<string>",
"filingType": "<string>",
"sourceStatus": "<string>",
"submissionDate": "2023-12-25",
"dispositionDate": "2023-12-25",
"stateStatus": "<string>",
"dispositionStatus": "<string>",
"rateImpact": {
"overallRateImpactPercent": 123,
"overallIndicatedChangePercent": 123
}
},
"history": {
"filings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"sourceReference": "<string>",
"state": "<string>",
"companyName": "<string>",
"carrierIds": [
"<string>"
],
"groupId": "<string>",
"naicCompanyCodes": [
"<string>"
],
"naicGroupCode": "<string>",
"productName": "<string>",
"typeOfInsurance": "<string>",
"subTypeOfInsurance": "<string>",
"toiCode": "<string>",
"subToiCode": "<string>",
"filingType": "<string>",
"sourceStatus": "<string>",
"submissionDate": "2023-12-25",
"dispositionDate": "2023-12-25",
"stateStatus": "<string>",
"dispositionStatus": "<string>",
"rateImpact": {
"overallRateImpactPercent": 123,
"overallIndicatedChangePercent": 123
},
"objections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"objectionDate": "2023-12-25",
"reviewerName": "<string>",
"textPreview": "<string>",
"textTruncated": true
}
]
}
],
"related": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"sourceReference": "<string>",
"state": "<string>",
"companyName": "<string>",
"carrierIds": [
"<string>"
],
"groupId": "<string>",
"naicCompanyCodes": [
"<string>"
],
"naicGroupCode": "<string>",
"productName": "<string>",
"typeOfInsurance": "<string>",
"subTypeOfInsurance": "<string>",
"toiCode": "<string>",
"subToiCode": "<string>",
"filingType": "<string>",
"sourceStatus": "<string>",
"submissionDate": "2023-12-25",
"dispositionDate": "2023-12-25",
"stateStatus": "<string>",
"dispositionStatus": "<string>",
"rateImpact": {
"overallRateImpactPercent": 123,
"overallIndicatedChangePercent": 123
},
"objections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"objectionDate": "2023-12-25",
"reviewerName": "<string>",
"textPreview": "<string>",
"textTruncated": 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,
"executionId": "<string>",
"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,
"executionId": "<string>",
"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,
"executionId": "<string>",
"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,
"executionId": "<string>",
"accessUrl": "<string>"
}Path Parameters
The review ID from the review link, as in filings.effectiveai.app/r/{reviewId}, e.g. frev_7Kq2mXa9b3Lr5Tn8Pw1Zc4.
Required string length:
1 - 64