Submit documents for verification checks

Ingests one or more documents, normalizes content (extracting email container attachments if applicable), persists the initial submission state, and concurrently dispatches all active verification checks.

Execution Pipeline:

  1. Tenant Resolution: Resolves tenant alias from authorizer context or the X-Tenant-Alias header.
  2. Document Normalization:
    • Accepts base64 encoded bytes (image), remote URLs (url), or pre-staged S3 references (fileIdentifier).
    • Email containers (.eml, .msg) are parsed: the email message body is converted to a PDF document, and any valid image/PDF attachments are extracted as distinct verifiable documents.
  3. Check Resolution:
    • If checks is provided, executes the specified checks.
    • If checks is omitted or empty, loads the tenant's default check configuration from verify-settings.
  4. Concurrent Dispatch: Checks are submitted concurrently to their respective downstream engines.
  5. Response: Returns submissionId and synchronous dispatch statuses (SUBMITTED or ERROR) along with the downstream apiUrl for polling.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Submission payload containing document(s), external correlation references, and optional check definitions.

Request payload for submitting documents to the verification pipeline.

string
required
^[a-zA-Z0-9_.:-]+$

Caller-provided reference ID for transactional correlation across upstream systems. Only letters, numbers, hyphens, underscores, dots, and colons are allowed.

document
object

Single document submission shortcut. (Either document or documents must be supplied).

documents
array of objects

List of documents to verify in this submission.

documents
metadata
object

Arbitrary key-value metadata to attach to the submission and propagate to downstream services.

externalAttributes
object

Additional key-value attributes forwarded to specialized downstream fraud engines.

checks
array of objects

Specific checks to run. If omitted or empty, checks will be loaded from the tenant's default verify-settings.

checks
Headers
string

Optional tenant alias override. Permitted only for users with ADMIN or SUBMITTER roles.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json