Skip to main content
POST
/
document
/
scan
/
async
cURL
curl --request POST \
  --url https://api.readyhealth.com/document/scan/async \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form external_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form validation=true \
  --form 'context={
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "requirement": "<string>"
}' \
  --form file=@example-file
{
  "id": "123",
  "scanStatus": "PENDING",
  "fields": null,
  "validations": null
}

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
string

One of VALID or INVALID

​
scanStatus
string

One of PENDING, IN_PROGRESS, FAILED or SUCCESS.

​
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
⌘I