POST
/
api
/
v1
/
sov
Start SOV Parsing Job
curl --request POST \
  --url https://api.sovfixer.com/api/v1/sov \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "callback_url": "<string>",
  "document_type": "SOV",
  "client_ref": "<string>",
  "extra_data_*": "<string>",
  "output_formats": [
    "json"
  ],
  "update_callback_url": "<string>",
  "integrations": [
    "DTC"
  ],
  "workflow": "<string>"
}'
{
  "message": "OK",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

​
file
file
required

SOV to submit for processing. Must be a valid Excel file (.xls, .xlsx, .xlsm, .xlsb).

​
callback_url
string<uri>

Optional webhook URL for POSTing results. If provided, results will be provided upon completion in the same format as the GET /sov/{id} response.

Minimum length: 1
​
document_type
enum<string>
default:SOV

If set, specifies the type of file being sent. Defaults to SOV.

  • SOV - SOV
  • PREM_BDX - PREM_BDX
  • CLAIM_BDX - CLAIM_BDX
  • SOV_BDX - SOV_BDX
  • ACORD - ACORD
Available options:
SOV,
PREM_BDX,
CLAIM_BDX,
SOV_BDX,
ACORD
​
client_ref
string

Optional user reference identifier, usable for any purpose.

Minimum length: 1
​
extra_data_*
string

Optional extra data fields to be associated with this request. Any parameter following this pattern will be stored as extra data. Common fields include: insured_name, inception_date, expiration_date, sov_description, predominant_occupancy, predominant_construction, insured_business_description, total_insured_value.

Minimum length: 1
​
output_formats
enum<string>[]

If set, specifies the desired output format(s). Defaults to json.

​
update_callback_url
string<uri>

Optional webhook URL for POSTing results. If provided, will be used as the callback_url in subsequent reoutput api calls.

Minimum length: 1
​
integrations
enum<string>[]

If set, specifies the desired integrations to enrich the data with. WARNING: If set without a geocoder, you may get incorrect results. Defaults to your workflow's default--the integrations used when you email us.

​
workflow
string

If set, specifies the workflow to use for processing. Defaults to the organization's default workflow.

Minimum length: 1

Response

​
id
string
required

Newly-created SOV processing ID. Use this as the id for future requests.

​
message
string
default:OK

API Message.