Skip to main content
GET
/
document
/
{id}
cURL
curl --request GET \
  --url https://api.readyhealth.com/document/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "externalUser": {
    "externalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "validationResult": "<string>",
  "scanStatus": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "fields": {},
  "validations": {},
  "tasks": {
    "id": "<string>",
    "actionType": "<string>",
    "status": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "result": {}
  },
  "file": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "originalName": "<string>",
    "mimeType": "<string>",
    "url": "<string>"
  },
  "context": {
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "requirement": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.readyhealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Response

200 - application/json
​
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