talentkiwi

Create PDF project from ATS applicants

POST
/v1/ats/hr4you/create-pdf

Receive an ATS create-pdf request, resolve/provision the consultant as a TalentKiwi user, create a project with the requested candidates, kick off background ATS imports, and return a redirectUrl pointing at the new project.

Authentication is via the X-Shared-Secret header — the same SHA-256 hash lookup used for regular API keys.

Steps:

  1. Resolve the organisation from the API key.
  2. Fetch org-level HR4YOU credentials from DomainResourceMapping.
  3. Look up the consultant's e-mail via the HR4YOU /consultants/{userId} endpoint.
  4. Resolve or auto-provision the TalentKiwi user.
  5. Create a new project (default open project type).
  6. Optionally attach a job post (when projectId is provided).
  7. Create one candidate per applicantId, tag with ATS info.
  8. Enqueue a background import per candidate.
  9. Return the redirect URL.

Authorization

X-API-KEY<token>
Enter your secret API key to authorise requests.

You can obtain your key by contacting us: gian@dionitech.com

**Example**: `sk_live_12345abcde...`

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://loading/v1/ats/hr4you/create-pdf" \  -H "Content-Type: application/json" \  -d '{    "userId": 0,    "applicantIds": [      0    ],    "applicantDocumentTypeId": 0  }'
{
  "redirectUrl": "string"
}
{
  "message": "string"
}