curl --request POST \
--url https://api.readyhealth.com/v2/intakes/scan/async \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form file='@example-file' \
--form 'external_id=<string>' \
--form 'file_id=<string>' \
--form 'client_reference=<string>' \
--form 'context={
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25"
}' \
--form 'validate={
"requirement": "<string>",
"placement_id": "<string>",
"requirement_id": "<string>",
"broadcast": true,
"source": true
}'import requests
url = "https://api.readyhealth.com/v2/intakes/scan/async"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"external_id": "<string>",
"file_id": "<string>",
"client_reference": "<string>",
"context": "{
\"first_name\": \"<string>\",
\"middle_name\": \"<string>\",
\"last_name\": \"<string>\",
\"date_of_birth\": \"2023-12-25\"
}",
"validate": "{
\"requirement\": \"<string>\",
\"placement_id\": \"<string>\",
\"requirement_id\": \"<string>\",
\"broadcast\": true,
\"source\": true
}"
}
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('external_id', '<string>');
form.append('file_id', '<string>');
form.append('client_reference', '<string>');
form.append('context', '{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25"
}');
form.append('validate', '{
"requirement": "<string>",
"placement_id": "<string>",
"requirement_id": "<string>",
"broadcast": true,
"source": true
}');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.readyhealth.com/v2/intakes/scan/async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.readyhealth.com/v2/intakes/scan/async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.readyhealth.com/v2/intakes/scan/async"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.readyhealth.com/v2/intakes/scan/async")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/v2/intakes/scan/async")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"external_id": "candidate-123",
"client_reference": "req-456",
"scan_status": "PENDING",
"context": {
"first_name": "Jane",
"last_name": "Doe"
},
"split": null,
"validation": null,
"fraud": null,
"payloads": [],
"segments": [],
"error": null,
"file": {
"url": "https://…",
"name": "bls.pdf",
"mime_type": "application/pdf"
},
"created_at": "2026-09-18T20:00:00.000Z",
"updated_at": "2026-09-18T20:00:00.000Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": null
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": null
}
}Create an Intake
Creates an intake from an uploaded file and processes it asynchronously. Intakes are split into segments.
curl --request POST \
--url https://api.readyhealth.com/v2/intakes/scan/async \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form file='@example-file' \
--form 'external_id=<string>' \
--form 'file_id=<string>' \
--form 'client_reference=<string>' \
--form 'context={
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25"
}' \
--form 'validate={
"requirement": "<string>",
"placement_id": "<string>",
"requirement_id": "<string>",
"broadcast": true,
"source": true
}'import requests
url = "https://api.readyhealth.com/v2/intakes/scan/async"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
"external_id": "<string>",
"file_id": "<string>",
"client_reference": "<string>",
"context": "{
\"first_name\": \"<string>\",
\"middle_name\": \"<string>\",
\"last_name\": \"<string>\",
\"date_of_birth\": \"2023-12-25\"
}",
"validate": "{
\"requirement\": \"<string>\",
\"placement_id\": \"<string>\",
\"requirement_id\": \"<string>\",
\"broadcast\": true,
\"source\": true
}"
}
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('external_id', '<string>');
form.append('file_id', '<string>');
form.append('client_reference', '<string>');
form.append('context', '{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25"
}');
form.append('validate', '{
"requirement": "<string>",
"placement_id": "<string>",
"requirement_id": "<string>",
"broadcast": true,
"source": true
}');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.readyhealth.com/v2/intakes/scan/async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.readyhealth.com/v2/intakes/scan/async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.readyhealth.com/v2/intakes/scan/async"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.readyhealth.com/v2/intakes/scan/async")
.header("x-api-key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/v2/intakes/scan/async")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"external_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"client_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"context\"\r\n\r\n{\r\n \"first_name\": \"<string>\",\r\n \"middle_name\": \"<string>\",\r\n \"last_name\": \"<string>\",\r\n \"date_of_birth\": \"2023-12-25\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validate\"\r\n\r\n{\r\n \"requirement\": \"<string>\",\r\n \"placement_id\": \"<string>\",\r\n \"requirement_id\": \"<string>\",\r\n \"broadcast\": true,\r\n \"source\": true\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"external_id": "candidate-123",
"client_reference": "req-456",
"scan_status": "PENDING",
"context": {
"first_name": "Jane",
"last_name": "Doe"
},
"split": null,
"validation": null,
"fraud": null,
"payloads": [],
"segments": [],
"error": null,
"file": {
"url": "https://…",
"name": "bls.pdf",
"mime_type": "application/pdf"
},
"created_at": "2026-09-18T20:00:00.000Z",
"updated_at": "2026-09-18T20:00:00.000Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": null
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": null
}
}Authorizations
Body
File to upload
UUID of document owner in your system.
500ID of a previously uploaded file.
Your file correlation ID. Stored and echoed.
200Candidate, placement and/or requirement data relevant to validation. Can accept any key-value pairs.
Show child attributes
Show child attributes
Used for performing validation on the document.
Show child attributes
Show child attributes
Response
Intake created and queued. scan_status is PENDING.
Intake ID.
PENDING, SUCCESS, FAILED Page ranges after split. Null while still PENDING (before split has run).
Show child attributes
Show child attributes
Present when a requirement was sent on create.
Show child attributes
Show child attributes
Rollup over segments. Any fraudulent segment makes the intake fraudulent.
Show child attributes
Show child attributes
Intake-level failure. Null unless scan_status is FAILED.
Show child attributes
Show child attributes
The upload as received. Segment PDFs are on each segment's file.
Show child attributes
Show child attributes
Only present on a deleted intake.