Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Body

multipart/form-data
external_id
string<uuid>
required

UUID of the document owner

file
file
required

The document as a binary file stream

validation
boolean

If set to true, a contextually relevant set of validations will be returned. Default is set to false and will not return any validations.

context
object

These fields are required only if validation: true.

Response

201 - application/json

The document is pending processing.

id
string
externalUser
object

Candidate information

validationResult
enum<string>
Available options:
VALID,
INVALID
scanStatus
enum<string>
Available options:
PENDING,
IN_PROGRESS,
SUCCESS,
FAILED
createdAt
string<date-time>
updatedAt
string<date-time>
deletedAt
string<date-time>
fields
object

See the document field schema for the attributes to expect once the latest scan is complete.

validations
object

See the document validations schema for the objects to expect once the latest validation is complete.

tasks
object
file
object
context
object