Cancellations API

See also

See Cancellations and Reinstatements for an overview of Cancellations functionality. See Reinstatements API for information about using Reinstatements in the API.

Grace Periods

Fetch a grace period

GET /gracePeriod/{gracePeriodLocator}
  • Request:

    Name

    Position

    Type

    Required

    gracePeriodLocator

    path

    string

    required

  • Response:GracePeriodResponse

GracePeriodResponse

{
  // Required
  endTimestamp : timestamp
  invoiceLocator : string
  locator : string
  policyholderLocator : string
  policyId : string
  policyLocator : string
  productLocator : string
  startTimestamp : timestamp

  // Optional
  cancellationLocator : string
  document : PolicyDocumentResponse
  settledTimestamp : timestamp
}

Cancellation

Create a Cancellation

POST /policies/{locator}/cancellations

CancellationRequest

{
  // Required
  effectiveTimestamp : timestamp
  name : string

  // Optional
  cancellationCategory : string
  cancellationMetadata : string
  conflictHandling : string block | invalidate
  issue : boolean
}

Fetch a Cancellation

GET /cancellations/{locator}

Update a Cancellation

PATCH /cancellations/{locator}

CancellationUpdateRequest

{
  // Optional
  cancellationCategory : string
  cancellationMetadata : string
  conflictHandling : string block | invalidate
  effectiveTimestamp : timestamp
  name : string
}

Issue a Cancellation

PATCH /cancellations/{locator}/issue

Rescind a Cancellation

PATCH /cancellations/{locator}/rescind

CancellationResponse

{
  // Required
  conflictHandling : string block | invalidate
  createdTimestamp : timestamp
  documents : [PolicyDocumentResponse]
  effectiveTimestamp : timestamp
  locator : string
  name : string
  policyLocator : string
  policyModificationLocator : string
  state : string draft | issued | rescinded | reinstated
  title : string

  // Optional
  cancellationCategory : string
  cancellationMetadata : string
  invoiceLocator : string
  issuedTimestamp : timestamp
  reinstatement : ReinstatementResponse
}

Fetch Pricing for a Cancellation

GET /cancellations/{locator}/price

Fetch cancellations for a policy

GET /policies/{locator}/cancellations

If there are no cancellations for the policy, an empty array will be returned.

Fetch grace periods for a policy

GET /policy/{policyLocator}/gracePeriods

After a grace period expires a cancellation named lapse will be created.