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>'

import requests

url = "https://api.sovfixer.com/api/v1/sov"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "callback_url": "<string>",
    "client_ref": "<string>",
    "company": "<string>",
    "document_type": "SOV",
    "extra_data_*": "<string>",
    "output_formats": "json",
    "team": "<string>",
    "update_callback_url": "<string>",
    "workflow": "<string>"
}
headers = {"Authorization": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('callback_url', '<string>');
form.append('client_ref', '<string>');
form.append('company', '<string>');
form.append('document_type', 'SOV');
form.append('extra_data_*', '<string>');
form.append('output_formats', 'json');
form.append('team', '<string>');
form.append('update_callback_url', '<string>');
form.append('workflow', '<string>');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://api.sovfixer.com/api/v1/sov', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sovfixer.com/api/v1/sov",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sovfixer.com/api/v1/sov"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sovfixer.com/api/v1/sov")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sovfixer.com/api/v1/sov")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "message": "OK"
}

{
  "error": "<string>"
}

{
  "detail": "<string>"
}

POST

api

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>'

import requests

url = "https://api.sovfixer.com/api/v1/sov"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "callback_url": "<string>",
    "client_ref": "<string>",
    "company": "<string>",
    "document_type": "SOV",
    "extra_data_*": "<string>",
    "output_formats": "json",
    "team": "<string>",
    "update_callback_url": "<string>",
    "workflow": "<string>"
}
headers = {"Authorization": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('callback_url', '<string>');
form.append('client_ref', '<string>');
form.append('company', '<string>');
form.append('document_type', 'SOV');
form.append('extra_data_*', '<string>');
form.append('output_formats', 'json');
form.append('team', '<string>');
form.append('update_callback_url', '<string>');
form.append('workflow', '<string>');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://api.sovfixer.com/api/v1/sov', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sovfixer.com/api/v1/sov",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sovfixer.com/api/v1/sov"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sovfixer.com/api/v1/sov")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sovfixer.com/api/v1/sov")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"company\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_type\"\r\n\r\nSOV\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"extra_data_*\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_formats\"\r\n\r\njson\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"team\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"update_callback_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"workflow\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "message": "OK"
}

{
  "error": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Body

multipart/form-data

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

Available options:

PG,

PH

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

string

required

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

message

string

default:OK

API Message.

⌘I

Overview

Ping.Extraction

Ping.Data

Ping.Vision

Start SOV Parsing Job

Authorizations

Body

Response