Create a submission

Create a new submission for a document to be analyzed

post/v2/submission

Request body

query_idstring nullable

User-defined ID of analyzed file - typically refers to internal ID of the analyzed document in user's CMS. Please ensure the query_id of any document is reviewed prior to submitting to ensure no PII is shared. Query_id is used for subsequent indexing of outputs from the document forensics analysis.

pipeline_configuration'FRAUD_ONLY' | 'CLASSIFICATION_ONLY' | 'QUALITY_ONLY'

Type of analysis pipeline to execute.

enable_decisionboolean

true to enable Adaptive Decision for the submitted document, false to disable it

enable_submission_characteristicsboolean

true to enable attachment of submission characteristics for the submitted document, false to disable it (see submission_characteristics_upload_url field in the response object)

Response

Submission created successfully

upload_urlstring uri required

Presigned URL to AWS S3 service where the actual file will be uploaded using the PUT method. Note that the content type in the PUT request has to be set to application/octet-stream.

Example file upload request using curl:

curl --request PUT \
  --url $UPLOAD_URL \
  --header 'content-type: application/octet-stream' \
  --data @path_to_file

submission_idstring required

Unique submission ID generated by Documents service that uniquely identifies the submitted file.

submission_characteristics_upload_urlstring uri

URL where submission characteristics can be attached to this submission - see the /v2/submission/{submission_id}/characteristics endpoint. Note that this URL is not pre-signed and requires access token in headers. The URL may be relative.

Changes

No recorded changes to this endpoint across all 1 revision of this API.