API Change Log

This page lists recent and upcoming changes to the Socotra REST API. Contact Socotra Support (support@socotra.com) with any questions.

Warning

Socotra may add fields to objects returned from any API without advance notice. We will always work with customers well in advance, generally with a six-month deprecation period, for any field that will be removed or have its type changed.

Note

See the Deprecations page for a list of currently deprecated features subject to removal.

2022-02-16

The obsolete entity DepositAccount has been removed from the system and all properties and references have been removed from API responses.

2021-10-13

Added the Auxiliary Data API for the new Auxiliary Data feature.

2021-06-16

Deprecation notice: The Liquid-based rating system is now deprecated and will be removed in a future release. The removal date has not yet been determined, but will be announced with at least a six-month advance notice. Socotra recommends use of the JavaScript-based Rating Plugin. Note: This does not affect rating for Premium Reports. Those continue to use Liquid rating.

2021-06-03

Added the Deployments API with endpoints for retrieving information about deployed configurations.

2021-03-24

Removal notice: The following deprecated feature flags are planned for removal on September 24, 2021. Customers should set the value of these flags to true in all tenants as soon as possible. Contact Socotra Support with any questions.

Quotes for New Business: property.quotes.for.new.business.enabled
Quotes for Endorsements and Renewals: property.quotes.for.endorsements.and.renewals.enabled
Premium Reporting: property.premium.reporting.enabled

2021-02-17

Deprecation notice: The following feature flags are deprecated and will be removed in a future release. Customers should set the value of these flags to true in all tenants. Contact Socotra Support with any questions.

Quotes for New Business: property.quotes.for.new.business.enabled
Quotes for Endorsements and Renewals: property.quotes.for.endorsements.and.renewals.enabled
Premium Reporting: property.premium.reporting.enabled

2020-12-22

The reverseTimestamp property on the PaymentResponse object has been renamed to reversedTimestamp.

2020-10-07

Added a new Scripting API with endpoints for uploading scripts and extracting logs

2020-09-02

Changes in support of endorsement and renewal quotation:

Added a plannedInvoices property to the EndorsementResponse and RenewalResponse
Added a quoted value for state in EndorsementResponse and RenewalResponse
Added a generatingEvent property for the PolicyDocumentConfiguration in EndorsementConfigurationResponse and RenewalConfigurationResponse
Added a conflictHandling property to the EndorsementActionRequest and RenewalActionRequest

2020-08-26

Merged the financial transaction object with the now-removed FinancialTransactionResponse2. The new object has all the fields in both of the former objects.

2020-08-05

Added the External Service Integrations API, used for configuring external raters
Added a new authenticate admin user endpoint

2020-07-08

To support the new Premium Reporting feature:

Added the premium reporting API
Added the optional field premiumReportName to the PolicyCreateRequest

2020-05-16

In the next few days, the field generatingEvent will be added to the PolicyDocumentConfiguration object to support an upcoming feature. This field will be a string with an enumerable set of values: either quote, issue, or accept.

2020-03-25

Added the Quotes API.

2019-10-31

The Deposit Account API has been removed.

2019-08-07

Due to deprecation of Deposit Accounts, sunset headers have been added to all Deposit Account API responses in accordance with IETF RFC 8594.

2019-07-24

The Deposit Account API is now deprecated, and will be removed not earlier than October 31, 2019.

This will include:

All deposit account API endpoints
The ability to get transactions by deposit account locator in Liquid templates

2019-07-10

For Policyholders that have no policies, the get policyholder policies endpoint will be changed to return an HTTP 404 Not Found response, rather than the current behavior of returning an empty array.