curl --request GET \
--url https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}', 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/regulatory-requirements/{requirementId}",
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://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}"
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))
}HttpResponse<String> response = Unirest.get("https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"title": "<string>"
},
"requirement": "<string>",
"sourceText": "<string>",
"category": "MANDATORY_LANGUAGE",
"scope": "FORM",
"formTypes": [
"BASE_POLICY_FORM"
],
"actions": [
"CANCELLATION"
],
"toiCodes": [
"<string>"
],
"legalRefs": [
"<string>"
],
"sourceLocator": {
"heading": "<string>",
"chunkIndex": 1
}
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}Get a form checklist requirement
Get one requirement item returned by listRegulatoryRequirements. A retired item returns 404; list again. Costs $0.01; failed requests are free.
curl --request GET \
--url https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}', 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/regulatory-requirements/{requirementId}",
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://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}"
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))
}HttpResponse<String> response = Unirest.get("https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.canary.effectiveai.app/api/v2/insurance/regulatory-requirements/{requirementId}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "<string>",
"title": "<string>"
},
"requirement": "<string>",
"sourceText": "<string>",
"category": "MANDATORY_LANGUAGE",
"scope": "FORM",
"formTypes": [
"BASE_POLICY_FORM"
],
"actions": [
"CANCELLATION"
],
"toiCodes": [
"<string>"
],
"legalRefs": [
"<string>"
],
"sourceLocator": {
"heading": "<string>",
"chunkIndex": 1
}
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>",
"dataset": "naic"
}Authorizations
Effective API key. Send Authorization: Bearer sk-eai-...
Path Parameters
Requirement id from listRegulatoryRequirements.
Response
The requirement item.
Requirement item identity. Re-extraction can retire an item; it then returns 404.
The form checklist this item comes from.
Show child attributes
Show child attributes
The requirement, normalized into one sentence.
The excerpt of the checklist the item came from, so you can check it.
What the requirement governs, such as a notice period or mandatory wording.
MANDATORY_LANGUAGE, REQUIRED_CONTENT, PROHIBITED_CONTENT, NOTICE_PERIOD, PERMISSIBLE_REASON, PROHIBITED_REASON, DELIVERY, RECIPIENT, PROOF, FILING_STATUS, APPROVAL, OFFER_OR_AVAILABILITY, SIGNATURE, FORMAT, OTHER FORM: a requirement on a form. POLICY: a requirement on the policy or process.
FORM, POLICY Kind of form the requirement applies to.
BASE_POLICY_FORM, COVERAGE_FORM, ENDORSEMENT, RIDER, APPLICATION, DECLARATIONS, SCHEDULE, CERTIFICATE, ID_CARD, CANCELLATION_NOTICE, NONRENEWAL_NOTICE, CONDITIONAL_RENEWAL_NOTICE, RENEWAL_CHANGE_NOTICE, OTHER_NOTICE, DISCLOSURE, OFFER_FORM, CONSENT_FORM, SELECTION_REJECTION_FORM, ACKNOWLEDGMENT, QUESTIONNAIRE, CERTIFICATION, ELECTION_FORM, CLAIM_FORM, PROOF_OF_LOSS, FRAUD_WARNING, OTHER Policy action the requirement applies to.
CANCELLATION, NONRENEWAL, CONDITIONAL_RENEWAL, RENEWAL_WITH_CHANGE, DECLINATION, RESCISSION, ISSUANCE, OTHER TOI values the item applies to. [] means none given.
Laws the item cites, as written.
Where the excerpt sits in the checklist.
Show child attributes
Show child attributes