Skip to main content
POST
/
api
/
v1
/
submission
Create New Submission
curl --request POST \
  --url https://api.sovfixer.com/api/v1/submission \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_type": "SOV",
  "client_ref": "<string>",
  "extra_data_*": "<string>",
  "filename": "<string>"
}
'
{
  "message": "<string>",
  "id": 123
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

​
document_type
enum<string>
default:SOV

If set, specifies the desired type of data to extract. Defaults to SOV, which extracts building information and submission metadata.

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

Optional user reference identifier, usable for any purpose.

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

Optional filename for the submission. If not provided, a default filename will be generated.

Minimum string length: 1

Response

​
message
string
required

API Message.

​
id
integer
required

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