Get Policy

curl --request GET \
  --url https://api.korint.io/policies/{policyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant: <tenant>'

import requests

url = "https://api.korint.io/policies/{policyId}"

headers = {
    "tenant": "<tenant>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

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

fetch('https://api.korint.io/policies/{policyId}', 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.korint.io/policies/{policyId}",
  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>",
    "tenant: <tenant>"
  ],
]);

$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.korint.io/policies/{policyId}"

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

	req.Header.Add("tenant", "<tenant>")
	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://api.korint.io/policies/{policyId}")

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

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

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

{
  "type": "<string>",
  "id": "<string>",
  "productId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastModifiedAt": "2023-11-07T05:31:56Z",
  "assets": [
    "<string>"
  ],
  "customers": [
    "<string>"
  ],
  "periodDuration": {
    "amount": 123
  },
  "invoicingConfig": {
    "earlyPayment": {
      "amount": 123
    }
  },
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "parent": "<string>",
  "brokerageFirm": "<string>",
  "incrementalId": 123,
  "externalId": "<string>",
  "author": {
    "firstName": "<string>",
    "lastName": "<string>",
    "userId": "<string>",
    "email": "jsmith@example.com",
    "brokerRole": "<string>"
  },
  "signedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "isAwaitingFirstPayment": true,
  "endedAt": "2023-11-07T05:31:56Z",
  "nextRenewalAt": "2023-11-07T05:31:56Z",
  "stoppedAt": "2023-11-07T05:31:56Z",
  "suspendedAt": "2023-11-07T05:31:56Z",
  "reactivatedAt": "2023-11-07T05:31:56Z",
  "additionalQuoteComponents": {
    "id": "<string>",
    "premium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    }
  },
  "quote": {
    "id": "<string>",
    "entityId": "<string>",
    "provider": {
      "id": "<string>",
      "version": "<string>"
    },
    "rates": [
      {
        "id": "<string>",
        "rate": 123,
        "inputs": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totalPremium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        }
      }
    ],
    "basePrice": 123
  },
  "proratedQuote": {
    "id": "<string>",
    "entityId": "<string>",
    "provider": {
      "id": "<string>",
      "version": "<string>"
    },
    "rates": [
      {
        "id": "<string>",
        "rate": 123,
        "inputs": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totalPremium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        }
      }
    ],
    "basePrice": 123
  },
  "selectedTier": {},
  "stop": {
    "reason": "<string>",
    "details": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "<string>"
  },
  "brokerageFees": [
    {
      "brokerageFirmId": "<string>",
      "fee": 50
    }
  ],
  "billingAssignment": {
    "configId": "<string>",
    "defaultPayerId": "<string>",
    "componentOverrides": [
      {
        "componentId": "<string>",
        "payerCustomerId": "<string>"
      }
    ]
  }
}

{
  "code": "FORBIDDEN",
  "message": "Forbidden",
  "details": {}
}

{
  "code": "POLICY_NOT_FOUND",
  "message": "Policy {policyId} ({branchId}) not found",
  "details": {}
}

GET

policies

{policyId}

Get Policy

curl --request GET \
  --url https://api.korint.io/policies/{policyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant: <tenant>'

import requests

url = "https://api.korint.io/policies/{policyId}"

headers = {
    "tenant": "<tenant>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

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

fetch('https://api.korint.io/policies/{policyId}', 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.korint.io/policies/{policyId}",
  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>",
    "tenant: <tenant>"
  ],
]);

$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.korint.io/policies/{policyId}"

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

	req.Header.Add("tenant", "<tenant>")
	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://api.korint.io/policies/{policyId}")

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

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

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

{
  "type": "<string>",
  "id": "<string>",
  "productId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastModifiedAt": "2023-11-07T05:31:56Z",
  "assets": [
    "<string>"
  ],
  "customers": [
    "<string>"
  ],
  "periodDuration": {
    "amount": 123
  },
  "invoicingConfig": {
    "earlyPayment": {
      "amount": 123
    }
  },
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "parent": "<string>",
  "brokerageFirm": "<string>",
  "incrementalId": 123,
  "externalId": "<string>",
  "author": {
    "firstName": "<string>",
    "lastName": "<string>",
    "userId": "<string>",
    "email": "jsmith@example.com",
    "brokerRole": "<string>"
  },
  "signedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "isAwaitingFirstPayment": true,
  "endedAt": "2023-11-07T05:31:56Z",
  "nextRenewalAt": "2023-11-07T05:31:56Z",
  "stoppedAt": "2023-11-07T05:31:56Z",
  "suspendedAt": "2023-11-07T05:31:56Z",
  "reactivatedAt": "2023-11-07T05:31:56Z",
  "additionalQuoteComponents": {
    "id": "<string>",
    "premium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    }
  },
  "quote": {
    "id": "<string>",
    "entityId": "<string>",
    "provider": {
      "id": "<string>",
      "version": "<string>"
    },
    "rates": [
      {
        "id": "<string>",
        "rate": 123,
        "inputs": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totalPremium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        }
      }
    ],
    "basePrice": 123
  },
  "proratedQuote": {
    "id": "<string>",
    "entityId": "<string>",
    "provider": {
      "id": "<string>",
      "version": "<string>"
    },
    "rates": [
      {
        "id": "<string>",
        "rate": 123,
        "inputs": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "totalPremium": {
      "amountPreFeesAndTaxes": 123,
      "fees": [
        {
          "id": "<string>",
          "amount": 123,
          "brokerageFirmId": "<string>"
        }
      ],
      "totalFees": 123,
      "amountWithFeesPreTaxes": 123,
      "taxes": [
        {
          "id": "<string>",
          "amount": 123
        }
      ],
      "totalTaxes": 123,
      "amountWithFeesAndTaxes": 123
    },
    "components": [
      {
        "id": "<string>",
        "premium": {
          "amountPreFeesAndTaxes": 123,
          "fees": [
            {
              "id": "<string>",
              "amount": 123,
              "brokerageFirmId": "<string>"
            }
          ],
          "totalFees": 123,
          "amountWithFeesPreTaxes": 123,
          "taxes": [
            {
              "id": "<string>",
              "amount": 123
            }
          ],
          "totalTaxes": 123,
          "amountWithFeesAndTaxes": 123
        }
      }
    ],
    "basePrice": 123
  },
  "selectedTier": {},
  "stop": {
    "reason": "<string>",
    "details": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "<string>"
  },
  "brokerageFees": [
    {
      "brokerageFirmId": "<string>",
      "fee": 50
    }
  ],
  "billingAssignment": {
    "configId": "<string>",
    "defaultPayerId": "<string>",
    "componentOverrides": [
      {
        "componentId": "<string>",
        "payerCustomerId": "<string>"
      }
    ]
  }
}

{
  "code": "FORBIDDEN",
  "message": "Forbidden",
  "details": {}
}

{
  "code": "POLICY_NOT_FOUND",
  "message": "Policy {policyId} ({branchId}) not found",
  "details": {}
}

Authorizations

Authorization

string

header

required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant

string

required

Your tenant identifier. Requests without it are rejected.

Path Parameters

policyId

string

required

the policy's id

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt

string<date-time>

Optional: the whenAt datetime

simulatedAt

string<date-time>

Optional: the simulatedAt datetime

branchId

string

Optional: the branchId

Pattern: ^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Response

type

string

required

Entity type

string

required

Unique identifier for the policy

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

productId

string

required

Product ID

createdAt

string<date-time>

required

Date and time when the policy was created

lastModifiedAt

string<date-time>

required

Date and time when the policy was last modified

status

enum<string>

required

Status of the policy

Available options:

POLICY_CREATED,

POLICY_QUOTED,

POLICY_CONFIRMED,

POLICY_SIGNED,

POLICY_STARTED,

POLICY_STOPPED,

POLICY_SUSPENDED

assets

string[]

required

Array of asset identifiers associated with the policy

customers

string[]

required

Identifiers of the customers associated with the policy

Pattern: ^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

periodDuration

object

required

Policy period duration

Show child attributes

invoicingConfig

object

required

Nested DTO for invoicing configuration

Show child attributes

customFields

object[]

custom fields per product

Show child attributes

name

string

Optional: Name of the entity

parent

string

Unique identifier for the parent policy

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

brokerageFirm

string

Unique identifier for the brokerage firm

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

incrementalId

number

Incremental policy id

externalId

string

External policy id

branchType

enum<string>

Type of branch associated with the policy

Available options:

BASE,

NEW_BUSINESS,

MTA,

RENEWAL,

REPRICING

author

object

Author of the policy

Show child attributes

signedAt

string<date-time>

Date and time when the policy was signed

startedAt

string<date-time>

Date and time when the policy started

isAwaitingFirstPayment

boolean

Derived: signed but not yet active because the product gates activation on first payment and that payment is still outstanding (status CONFIRMED, signed, start date passed).

endedAt

string<date-time>

Date and time when the policy will end

nextRenewalAt

string<date-time>

Next renewal anniversary date, even for stopped policies

stoppedAt

string<date-time>

Date and time when the policy stopped

suspendedAt

string<date-time>

Date and time when the policy was suspended

reactivatedAt

string<date-time>

Date and time when the policy was reactivated after suspension

additionalQuoteComponents

object

Show child attributes

quote

object

policy quote

Show child attributes

proratedQuote

object

Prorated policy quote based on the invoicing frequency of the policy

Show child attributes

selectedTier

object

Selected pricing tier with perils and breakdown

stop

object

stop reason, details and createdAt

Show child attributes

brokerageFees

object[]

Brokerage fees

Show child attributes

billingAssignment

object

Billing assignment for multi-payer policies

Show child attributes