Skip to main content
POST
/
api
/
v1
/
submission
Initiate New Submission
curl --request POST \
  --url https://vision.pingintel.com/api/v1/submission \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=<string>' \
  --form cc_emails=jsmith@example.com \
  --form 'client_ref=<string>' \
  --form expiration_date=2023-12-25 \
  --form inception_date=2023-12-25 \
  --form 'insured_name=<string>' \
  --form is_rush=false \
  --form need_by_date=2023-12-25 \
  --form notify_complete=false \
  --form notify_received=false \
  --form 'risk_summary=<string>' \
  --form 'target_terms=<string>' \
  --form team_uuid=3c90c3cc-0d44-4b50-8888-8dd25736052a
{
  "id": "<string>",
  "message": "<string>",
  "url": "<string>"
}

Authorizations

Authorization
string
header
required

Supports Token-prefixed API keys and Bearer-prefixed JWT-based authentication.

Body

multipart/form-data
files
string<uri>[]
required

A list of files to be uploaded.

cc_emails
string<email>[]

List of email addresses to CC on email notifications for this submission.

client_ref
string | null

Client reference identifier.

expiration_date
string<date> | null

Date when the insurance policy should terminate.

inception_date
string<date> | null

Date when the insurance policy was/will be/is targeted to begin.

insured_name
string | null

Name of the insured.

is_rush
boolean
default:false

Whether this submission should be treated as a rush submission.

need_by_date
string<date> | null

Date by which the submission is needed.

new_renewal
enum<string> | null

Whether the submission is for a new policy or a renewal.

  • New - New
  • Renewal - Renewal
Available options:
New,
Renewal,
null
notify_complete
boolean
default:false

Whether to send an email notification when the submission processing is complete. Defaults to False for API submissions.

notify_received
boolean
default:false

Whether to send an email notification when the submission is received. Defaults to False for API submissions.

risk_summary
string | null

Risk summary of the insured

target_terms
string | null

Optional target terms entered by the broker/user.

team_uuid
string<uuid> | null

UUID of the team to which the submission should be sent. Required if the API user has access to create submissions for multiple teams.

Response

id
string
required

Newly-created pingid. Use this as the identifier for future requests.

message
string
required

Server message indicating the request was successful.

url
string
required

URL to the submission. Use this to view the submission in the UI.