Skip to main content
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: multipart/form-data' \
  --form file='@example-file' \
  --form 'callback_url=<string>' \
  --form 'client_ref=<string>' \
  --form 'company=<string>' \
  --form document_type=SOV \
  --form 'extra_data_*=<string>' \
  --form output_formats=json \
  --form 'team=<string>' \
  --form 'update_callback_url=<string>' \
  --form 'workflow=<string>'
{
  "id": "<string>",
  "message": "OK"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

multipart/form-data
​
file
file
required

Document to submit for processing. Must be a valid Excel file (.xls, .xlsx, .xlsm, .xlsb) or ACORD (.pdf). Max file size 75 MB.

​
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 string length: 1
​
client_ref
string

Optional user reference identifier, usable for any purpose.

Minimum string length: 1
​
company
string

If set, specifies the company for the submission. Can be a company UUID or company short name. Also requires team.

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

If set, specifies the type of file being sent. Defaults to SOV. ACORD is an alias 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
​
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 string 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.

Integration option.

  • PG - PG
  • PH - PH
  • PFPC - PFPC
Available options:
PG,
PH,
PFPC
​
output_formats
enum<string>[]

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

Output format option.

  • json - json
  • pingv2 - pingv2
  • amrisc - amrisc
Available options:
json,
pingv2,
amrisc
​
team
string

If set, specifies the team to use for processing. Can be a team UUID or team name. Also requires company.

Minimum string length: 1
​
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 string length: 1
​
workflow
string

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

Minimum string 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.