Skip to main content
POST
Create an intake and scan it in the background

Authorizations

x-api-key
string
header
required

Body

multipart/form-data
file
file
required

File to upload

external_id
string
required

UUID of document owner in your system.

Maximum string length: 500
file_id
string

ID of a previously uploaded file.

client_reference
string

Your file correlation ID. Stored and echoed.

Maximum string length: 200
context
object

Candidate, placement and/or requirement data relevant to validation. Can accept any key-value pairs.

validate
object

Used for performing validation on the document.

Response

Intake created and queued. scan_status is PENDING.

id
string<uuid>

Intake ID.

external_id
string
client_reference
string | null
scan_status
enum<string>
Available options:
PENDING,
SUCCESS,
FAILED
context
object | null
split
object | null

Page ranges after split. Null while still PENDING (before split has run).

validation
object | null

Present when a requirement was sent on create.

fraud
object | null

Rollup over segments. Any fraudulent segment makes the intake fraudulent.

segments
object[]
error
object | null

Intake-level failure. Null unless scan_status is FAILED.

file
object | null

The upload as received. Segment PDFs are on each segment's file.

created_at
string<date-time>
updated_at
string<date-time> | null
deleted_at
string<date-time>

Only present on a deleted intake.