Skip to main content
GET
Get submission detail and job summaries
Returns the current partner-facing status of a submission and processing jobs. Use this to poll for progress if you are not using webhooks.

Status values

Statuses are lowercase strings with a human-readable statusLabel. They are partner-facing labels, not raw database enum names. All resources are scoped to your account. A submissionId from another account returns 404.

Example request

When complete, follow the resultId (or webhook) to GET /v1/results/{resultId}.

Authorizations

X-Api-Key
string
header
required

Plaintext API key issued for the tenant (stored hashed server-side).

Headers

x-request-id
string

Optional; echoed when possible. Server generates when absent.

Path Parameters

submissionId
string<uuid>
required

Response

Submission scoped to tenant; enforces optional metadata.partnerId scoping

submissionId
string<uuid>
required
subjectId
string<uuid>
required
partnerSubmissionId
string | null
required
partnerSubjectId
string
required
status
enum<string>
required

Stable public slug for submission pipeline state (partner JSON).

Available options:
received,
validating,
validated,
processing,
completed,
failed,
rejected
statusLabel
string
required

Human-readable label for status (e.g. Processing).

Minimum string length: 1
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
counts
object
required
jobs
object[]
required