List submissions

One accepted multi-page PDF is one submission in this list. Use [Get submission](/docs/reference/submissions/get-submission) to retrieve page images and compact page evidence. Pages do not consume additional upload slots or create extra list entries.

GET/api/v1/submissions

Authorization

AuthorizationRequiredBearer <token>

Steve API key, usually scoped to a company. Legacy keys and keys created by platform administrators may be unscoped; company-scoped endpoints reject unscoped keys with 403 Forbidden. Format: Authorization: Bearer aok_...

In: header

Query Parameters

workflowstring

Filter submissions to a single workflow slug.

statusstring

Filter submissions by public business status.

Value in:

"created" | "processing" | "capture_quality_blocked" | "review" | "approved" | "synced" | "rejected" | "cancelled" | "failed"

fraudStatusstring | null

Filter submissions by fraud state.

Value in: "clean" | "flagged" | "blocked" | null

cursorstring

Opaque pagination cursor returned by a previous response.

limitinteger

Page size, an integer from 1 to 100. Any other value is rejected with 400 (validation-error on field limit).

Default: 20Minimum: 1Maximum: 100

Header Parameters

X-Request-Idstring

Optional caller-supplied request identifier. Maximum length is 128 characters.

Maximum length: 128

curl -X GET "https://api.meetsteve.io/api/v1/submissions?workflow=%3Cstring%3E&status=created&fraudStatus=clean&cursor=%3Cstring%3E&limit=20" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>"

Matching submissions

{
  "data": [
    {
      "id": "string",
      "submissionStatus": "created",
      "fraudStatus": "clean",
      "fraudScore": 0,
      "workflow": {
        "slug": "string",
        "name": "string",
        "version": 0
      },
      "extractedData": null,
      "confidence": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "clientSubmissionId": "string",
      "matchedItems": [
        {
          "field": "string",
          "index": 0,
          "text": "string",
          "sku": "string",
          "name": "string",
          "category": "string",
          "maker": "string",
          "quantity": 0,
          "amount": 0,
          "discount": 0,
          "netAmount": 0,
          "matchedBy": "exact_alias",
          "confidence": 0
        }
      ]
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string"
  }
}

List submissions

Authorization

Query Parameters

Header Parameters

Response

TypeScript