Skip to main content
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
exposures
/
configuration
Get Exposure Configuration
curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/exposures/configuration \
  --header 'Authorization: <api-key>'
import requests

url = "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/exposures/configuration"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/v1/external/companies/{companyId}/exposures/configuration', 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://app.aiinsurance.io/api/v1/external/companies/{companyId}/exposures/configuration",
  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: <api-key>"
  ],
]);

$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://app.aiinsurance.io/api/v1/external/companies/{companyId}/exposures/configuration"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/exposures/configuration")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/exposures/configuration")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "fields": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "exposureName": {
        "type": "string",
        "title": "exposureName"
      },
      "exposureType": {
        "type": "string",
        "title": "exposureType"
      },
      "numberOfEmployees": {
        "type": "number",
        "title": "numberOfEmployees"
      },
      "riskLevel": {
        "type": "string",
        "title": "riskLevel",
        "oneOf": [
          {
            "const": "low",
            "title": "Low"
          },
          {
            "const": "medium",
            "title": "Medium"
          },
          {
            "const": "high",
            "title": "High"
          }
        ]
      }
    },
    "required": [
      "exposureName",
      "exposureType"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Response

Configuration for exposure fields

Configuration response for Field Model V1 exposures. Returns a JSON Schema describing the fields available for creating or updating exposures.

​
fields
object
required

JSON Schema (draft 2020-12) describing the valid fields for the exposure request body. Each property corresponds to a field referenceId in the company's configuration.