Create an insurance monitor configuration

Creates an insurance configuration owned by the calling account. The returned id is what a RequirementType: InsuranceCoverage requirement definition passes as dataSourceId — and this is the only way to obtain one, so a definition of that type cannot be created without it.

coverages is the substance of the resource: one entry per policy the payer requires, each with its own limit floors, required endorsements and accepted coverage sources. Requiring two policies (commonly Workers' Compensation plus Occupational Accident) is normal, and policyType must be unique across entries — a configuration requiring the same type twice could not say which floor applied.

Supplying an externalId already in use for this account returns 409 ResourceConflict — create is not an upsert. There is no list operation on this resource, so recover by holding the id from the original create.

coverages is fixed once the configuration exists. The PATCH on this resource supports externalId and metadata, so changing what a configuration requires means creating a new one and pointing the requirement definition at it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Caller-supplied reconciliation id, unique per account. A duplicate returns 409 ResourceConflict.

coverages
array of objects
required
length ≥ 1

The policies this configuration requires. policyType must be unique across entries.

coverages*

One policy an InsuranceMonitorConfiguration requires. A configuration carries one entry per required policy type, and the policy type is unique across entries.

string
enum
required
limits
array of objects

Minimum limits the coverage must carry, per limit type. A coverage is compliant when it meets or exceeds every one of them.

limits
appliedProvisions
array of objects

Endorsements the policy must carry.

appliedProvisions
acceptedSourceTypes
array of objects

Which coverage sources satisfy this requirement. A configuration that omits PlanEnrollment will not accept a Wingspan master-policy enrollment.

acceptedSourceTypes
Allowed:
string
enum

Whether the policy triggers on the occurrence or on the claim.

Allowed:
policySpecificAttributes
object

Per-policy-type extras. Only auto policies carry any today.

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json