Skip to main content
GET
Get one thing to process

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "mail": Include the mail this item came out of (door, sender, subject, body, reception date).
  • "actions-info": Projects { canBeDismissed, canBeDeleted, canBecomeReport }.
  • "download-url": Adds a presigned downloadUrl for the item's file, before any conversion.
  • "latest-analysis": Newest analysis run of the item (null when it has none), with the provider and unit its succeeded metadata step retained and the score each was retained on.
  • "sender-provider": Provider the sending address belongs to, when exactly one live contact of the organization carries it - the attribution that comes from the mail thread rather than from the document. Null when no contact, or contacts of several providers, answer to that address.
Available options:
mail,
actions-info,
download-url,
latest-analysis,
sender-provider

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
inboxMailId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
organizationId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
type
enum<string>
required
Available options:
unknown,
report,
quote
status
enum<string>
required
Available options:
pending,
processed,
dismissed
file
object
required
classifyParked
boolean
required
reportId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
processedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
inboxMail
object
actions
object
downloadUrl
string<uri>
latestAnalysis
object | null
senderProvider
object | null