Create a new policy

Create a new organization insurance policy linked to a contract.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string|null

organizationId?string|null

contractId?|

Linked contract ID

partnerPolicyId?|

External partner policy reference

policyReference?|

Human-readable policy reference

name?|

Policy name

coverage?|null

ratePerNight?integer

Rate per night in pennies

ratePerMonth?integer

Pennies — for MONTHLY policies (per property per month)

ratePerReservation?integer

Pennies — for PER_RESERVATION policies (flat per reservation)

lossFundRatePerNight?integer

Pennies — SIR loss-fund charge per covered night

billingFrequency?|

NIGHTLY | MONTHLY | PER_RESERVATION (null = legacy nightly)

rateTableVersions?array<>|

Versioned, append-only rate table (VEL-517) — frozen at signature; amendments append dated versions.

eligibilityOverrides?|

Tier 3 of the eligibility cascade (VEL-522) — this policy's deltas over the resolved tier-1/2 rules. Null = inherit everything.

currency?string|null

termStart?|

Formatdate

termEnd?|

Formatdate

autoRenew?boolean

enrolledProperties?array<>|null

activeEnrollments?array<>|

Derived (serialized getter): enrolledProperties filtered to active=true.

status?|

onboardingSource?string|null

productId?string|null

productCode?string|null

planId?string|null

appliesTo?string|null

supportedStates?array<string>|

null = all states

supportedCountries?array<string>|

null = all countries

excludedPropertyTypes?array<string>|

null = no exclusions

coveredCategories?array<string>|

Reservation categories covered; null = all

minNights?|

null = no minimum

maxNights?|

null = no maximum

categoryExclusions?array<>|

Per-category exclusion rules layered over coveredCategories.

selectedSelfCoverage?integer|null

currentRenewalId?string|null

previousPolicyId?string|null

supersededByPolicyId?string|null

renewalNotice60SentAt?|

Formatdate-time

renewalNotice30SentAt?|

Formatdate-time

renewalNotice7SentAt?|

Formatdate-time

renewalManualReviewFlaggedAt?|

Formatdate-time

renewalCount?integer

createdBy?string|null

createdDate?|

Formatdate-time

lastModifiedBy?string|null

lastModifiedDate?|

Formatdate-time

version?|

Formatint64

additionalInsureds?array<>|

Named additional insureds (VEL-788).

coverageV4Managed?boolean

True for a Coverage v4 program-line anchor: identity and term only — coverage, levels and prices live in velaris-coverage, so rate tables, plan, coverage snapshot and elections are absent

productLine?|

Response Body

`application/json`

curl -X POST "https://example.com/api/policy" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "organizationId": "string",
  "contractId": "string",
  "partnerPolicyId": "string",
  "policyReference": "string",
  "name": "string",
  "coverage": {
    "contentsCoverage": 0,
    "liabilityCoverage": 0,
    "dwellingCoverage": 0,
    "totalCoverage": 0,
    "deductible": 0,
    "minimumClaim": 0,
    "coverageCurrency": "string",
    "endorsements": [
      "string"
    ],
    "endorsementSelections": [
      {}
    ]
  },
  "ratePerNight": 0,
  "ratePerMonth": 0,
  "ratePerReservation": 0,
  "lossFundRatePerNight": 0,
  "billingFrequency": "string",
  "rateTableVersions": [
    {}
  ],
  "eligibilityOverrides": {},
  "currency": "string",
  "termStart": "2019-08-24",
  "termEnd": "2019-08-24",
  "autoRenew": true,
  "enrolledProperties": [
    {
      "propertyId": "string",
      "propertyReferenceId": "string",
      "propertyName": "string",
      "enrolledDate": "2019-08-24",
      "unenrolledDate": "2019-08-24",
      "active": true,
      "rateOverridePerNight": 0,
      "planId": "string",
      "endorsementSelections": [
        {}
      ],
      "computedRatePerNight": 0,
      "computedRatePerMonth": 0
    }
  ],
  "activeEnrollments": [
    {
      "propertyId": "string",
      "propertyReferenceId": "string",
      "propertyName": "string",
      "enrolledDate": "2019-08-24",
      "unenrolledDate": "2019-08-24",
      "active": true,
      "rateOverridePerNight": 0,
      "planId": "string",
      "endorsementSelections": [
        {}
      ],
      "computedRatePerNight": 0,
      "computedRatePerMonth": 0
    }
  ],
  "status": "PENDING",
  "onboardingSource": "string",
  "productId": "string",
  "productCode": "string",
  "planId": "string",
  "appliesTo": "string",
  "supportedStates": [
    "string"
  ],
  "supportedCountries": [
    "string"
  ],
  "excludedPropertyTypes": [
    "string"
  ],
  "coveredCategories": [
    "string"
  ],
  "minNights": 0,
  "maxNights": 0,
  "categoryExclusions": [
    {}
  ],
  "selectedSelfCoverage": 0,
  "currentRenewalId": "string",
  "previousPolicyId": "string",
  "supersededByPolicyId": "string",
  "renewalNotice60SentAt": "2019-08-24T14:15:22Z",
  "renewalNotice30SentAt": "2019-08-24T14:15:22Z",
  "renewalNotice7SentAt": "2019-08-24T14:15:22Z",
  "renewalManualReviewFlaggedAt": "2019-08-24T14:15:22Z",
  "renewalCount": 0,
  "createdBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "version": 0,
  "additionalInsureds": [
    {
      "name": "string",
      "relationship": "string",
      "effectiveFrom": "2019-08-24",
      "effectiveTo": "2019-08-24",
      "addedBy": "string"
    }
  ],
  "pricingSource": "COVERAGE_V4",
  "coverageV4Managed": true,
  "productLine": "string"
}

Create a new policy

Request Body

Response Body

201application/json

`application/json`