Data Auto-Fill API

To establish and manage auto-fill integration points, use the External Service Integration API and create an integration with type data_autofill.

Endpoint Index

Action	Endpoint
Add an autofill operation	PUT /integrations/autofill
Fetch autofill operations	GET /integrations/autofill
Fetch an individual operation	GET /integrations/autofill/{locator}
Remove an operation	DELETE /integrations/autofill/{locator}

Details

Add an autofill operation¶

PUT /integrations/autofill

Request:

Name	Position	Type	Required
request	body	AutofillIntegrationCreateRequest	required

Response: map<string,string>

AutofillIntegrationCreateRequest¶

required
callSequence [string]
operation string

Fetch autofill operations¶

GET /integrations/autofill

Response: AutofillIntegrationResponse

AutofillIntegrationResponse¶

required
calls [AutofillCallResponse]

AutofillCallResponse¶

required
locator string
callSequence [string]
operation string

Fetch an individual operation¶

GET /integrations/autofill/{locator}

Request:

Name	Position	Type	Required
locator	path	string	required

Response: AutofillCallResponse

Remove an operation¶

DELETE /integrations/autofill/{locator}

Request:

Name	Position	Type	Required
locator	path	string	required

Response: void

API for “Per Event” Autofill

The following objects have an optional, autofill property which is a sequence (array) of strings identifying external service integration names:

Protocol for Communication from Socotra and External Services

Outbound (from Socotra)

Socotra will send an AutofillPayload object to each autofill service:

AutofillPayload¶

required
policyholderLocator string
productName string
operation string newBusiness | endorsement | renewal | reinstatement | cancellation | manual | feeAssessment
operationType string create | update
updates AutofillUpdateRequest

optional
policyLocator string
endorsementLocator string
quoteLocator string
renewalLocator string
configVersion integer

AutofillUpdateRequest¶

required
policyEndTimestamp timestamp
policyStartTimestamp timestamp

optional
endorsementName string
endorsementEffectiveTimestamp timestamp
fieldValues map<string,[string]>
addFieldGroups [AutofillFieldGroupCreateRequest]
updateFieldGroups [AutofillFieldGroupUpdateRequest]
removeFieldGroups [string]
addExposures [AutofillExposureCreateRequest]
updateExposures [AutofillExposureUpdateRequest]
removeExposures [string]

AutofillFieldGroupCreateRequest¶

required
fieldName string

optional
fieldValues map<string,[string]>

AutofillFieldGroupUpdateRequest¶

required
fieldGroupLocator string
fieldName string

optional
fieldValues map<string,[string]>

AutofillExposureCreateRequest¶

required
exposureName string
perils [PerilCreateRequest]
fieldGroups [FieldGroupCreateRequest]

optional
fieldValues map<string,[string]>

AutofillExposureUpdateRequest¶

required
addFieldGroups [AutofillFieldGroupCreateRequest]
updateFieldGroups [AutofillFieldGroupUpdateRequest]
removeFieldGroups [string]
addPerils [AutofillPerilCreateRequest]
updatePerils [AutofillPerilUpdateRequest]
exposureLocator string
removePerils [string]

optional
exposureName string
fieldValues map<string,[string]>

Note

While exposureName is technically optional, it will always be populated by the API when used in an Auto-Fill request. An exposureName included in the Auto-Fill response will be ignored.

AutofillPerilCreateRequest¶

required
name string
fieldGroups [FieldGroupCreateRequest]

optional
fieldValues map<string,[string]>

AutofillPerilUpdateRequest¶

required
addFieldGroups [AutofillFieldGroupCreateRequest]
updateFieldGroups [AutofillFieldGroupUpdateRequest]
removeFieldGroups [string]
perilLocator string

optional
fieldValues map<string,[string]>

Inbound (to Socotra)

The following object should be returned from the external service:

AutofillResponse¶

required
fieldValues map<string,[string]>

optional
endorsementEffectiveTimestamp timestamp
policyEndTimestamp timestamp
policyStartTimestamp timestamp
addFieldGroups [AutofillFieldGroupCreateRequest]
updateFieldGroups [AutofillFieldGroupUpdateResponse]
removeFieldGroups [string]
addExposures [AutofillExposureCreateRequest]
updateExposures [AutofillExposureUpdateResponse]
removeExposures [string]

For new business, the draft policy data will be updated based on the response. For endorsements or renewals, the endorsement or renewal itself will be updated.

After the first call, the process will be repeated for each subsequent external service defined for the product or transaction.

Note

If any of the properties is missing from the response, it will be interpreted to mean “unchanged.” To clear a value the property can be set to null or an empty value.

Policy Creation

For policy creation, none of these properties are allowed. They should not be sent to the external service, and if included in the response with a non-empty array as the value, then the transaction will fail:

updateFieldGroups
removeFieldGroups
updateExposures
removeExposures
updatePerils
removePerils

Note

Autofill message sizes are limited to 5MB. Transactions that require messages larger than 5MB will fail.