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: application/json' \
  --data '{
  "files": [
    "<string>"
  ],
  "team_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_ref": "<string>",
  "insured_name": "<string>",
  "risk_summary": "<string>",
  "inception_date": "2023-12-25",
  "expiration_date": "2023-12-25",
  "notify_received": false,
  "notify_complete": false,
  "cc_emails": [
    "jsmith@example.com"
  ]
}'
{
  "message": "<string>",
  "url": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

​
files
string<uri>[]
required

A list of files to be uploaded.

​
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.

​
client_ref
string | null

Client reference identifier.

​
insured_name
string | null

Name of the insured.

​
risk_summary
string | null

Risk summary of the insured

​
inception_date
string<date> | null

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

​
expiration_date
string<date> | null

Date when the insurance policy should terminate.

​
notify_received
boolean
default:false

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

​
notify_complete
boolean
default:false

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

​
cc_emails
string<email>[]

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

Response

​
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.

​
id
string
required

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