Skip to main content
POST
/
statement
cURL
curl --request POST \
  --url https://api.readyhealth.com/statement \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "template": "coversheet",
  "externalUserId": "12345",
  "context": {
    "partnerId": "partner-uuid-here",
    "candidateId": "12345"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "template": "<string>",
  "externalUserId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "file": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "mimeType": "<string>",
    "originalName": "<string>"
  },
  "context": {
    "partnerId": "<string>",
    "candidateId": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
template
string
required

Template key used to render the statement.

externalUserId
string
required

External identifier for the candidate in your system.

context
object
required

Contextual data for filling in blanks in the statement template.

Response

201 - application/json

The statement has been created.

id
string<uuid>

Identifier of the created statement.

status
string

Current status of the statement (for example, PENDING or READY).

template
string

Template key used to render the statement.

externalUserId
string

External identifier for the candidate in your system.

createdAt
string<date-time>
updatedAt
string<date-time>
file
object

If available, the rendered file for this statement.

context
object