Get an intake
curl --request GET \
--url https://api.readyhealth.com/v2/intakes/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.readyhealth.com/v2/intakes/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.readyhealth.com/v2/intakes/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.readyhealth.com/v2/intakes/{id}"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://api.readyhealth.com/v2/intakes/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/v2/intakes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"external_id": "candidate-123",
"client_reference": "req-456",
"scan_status": "SUCCESS",
"context": {
"first_name": "Jane",
"last_name": "Doe"
},
"split": {
"page_count": 4,
"segments": [
{
"index": 0,
"page_start": 1,
"page_end": 2
},
{
"index": 1,
"page_start": 3,
"page_end": 4
}
]
},
"validation": {
"requirement": "bls",
"result": "VALID",
"document_id": "11111111-1111-1111-1111-111111111111",
"validations": []
},
"fraud": {
"result": "clean"
},
"payloads": [],
"segments": [
{
"id": "11111111-1111-1111-1111-111111111111",
"intake_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"index": 0,
"page_start": 1,
"page_end": 2,
"document_type": "bls",
"document_category": "certification",
"schema_id": "life_support/card",
"fields": {},
"derived_fields": {},
"external_fields": null,
"validation_result": "VALID",
"validations": [],
"attestations": [],
"expires_at": "2027-03-01",
"redacted_at": null,
"scan_status": "SUCCESS",
"fraud": {
"result": "clean",
"score": 0.01
},
"error": null,
"file": {
"url": "https://…",
"name": "bls.pdf",
"mime_type": "application/pdf"
},
"created_at": "2026-09-18T20:00:01.000Z",
"updated_at": "2026-09-18T20:00:08.000Z"
}
],
"error": null,
"file": {
"url": "https://…",
"name": "packet.pdf",
"mime_type": "application/pdf"
},
"created_at": "2026-09-18T20:00:00.000Z",
"updated_at": "2026-09-18T20:00:08.000Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": null
}
}Intakes
Get an Intake
Returns the intake with all of its segments.
GET
/
v2
/
intakes
/
{id}
Get an intake
curl --request GET \
--url https://api.readyhealth.com/v2/intakes/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.readyhealth.com/v2/intakes/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.readyhealth.com/v2/intakes/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.readyhealth.com/v2/intakes/{id}"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://api.readyhealth.com/v2/intakes/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/v2/intakes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"external_id": "candidate-123",
"client_reference": "req-456",
"scan_status": "SUCCESS",
"context": {
"first_name": "Jane",
"last_name": "Doe"
},
"split": {
"page_count": 4,
"segments": [
{
"index": 0,
"page_start": 1,
"page_end": 2
},
{
"index": 1,
"page_start": 3,
"page_end": 4
}
]
},
"validation": {
"requirement": "bls",
"result": "VALID",
"document_id": "11111111-1111-1111-1111-111111111111",
"validations": []
},
"fraud": {
"result": "clean"
},
"payloads": [],
"segments": [
{
"id": "11111111-1111-1111-1111-111111111111",
"intake_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"index": 0,
"page_start": 1,
"page_end": 2,
"document_type": "bls",
"document_category": "certification",
"schema_id": "life_support/card",
"fields": {},
"derived_fields": {},
"external_fields": null,
"validation_result": "VALID",
"validations": [],
"attestations": [],
"expires_at": "2027-03-01",
"redacted_at": null,
"scan_status": "SUCCESS",
"fraud": {
"result": "clean",
"score": 0.01
},
"error": null,
"file": {
"url": "https://…",
"name": "bls.pdf",
"mime_type": "application/pdf"
},
"created_at": "2026-09-18T20:00:01.000Z",
"updated_at": "2026-09-18T20:00:08.000Z"
}
],
"error": null,
"file": {
"url": "https://…",
"name": "packet.pdf",
"mime_type": "application/pdf"
},
"created_at": "2026-09-18T20:00:00.000Z",
"updated_at": "2026-09-18T20:00:08.000Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": null
}
}Authorizations
Path Parameters
Intake ID
Response
Intake
Intake ID.
Available options:
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.