Statements

Statements let you generate structured documents (for examples: coversheets, employment verification, onboarding forms) based on candidate, placement and certification data you already have in your ATS.

Creating a statement

Use the POST /statement endpoint to create a new statement for a candidate. At a minimum, you pass:

template: the statement template to render (for example, coversheet). This is setup with Ready Health during the integration period.
externalUserId: the candidate user id
context: any data that will be used to describe or fill in the template.

Example request

{
  "template": "voe_statement",
  "externalUserId": "12345",
  "context": {
    "partnerId": "partner-uuid-here",
    "candidateId": "12345"
  }
}

The response will include a statement identifier that you can later use to retrieve the rendered statement with GET /statement/{id}.

Getting Started

Document Processing

Registry Searches

Statements

Creating a statement

Example request

​Creating a statement

​Example request

Creating a statement

Example request