Create PDF project from ATS applicants
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:
- Resolve the organisation from the API key.
- Fetch org-level HR4YOU credentials from
DomainResourceMapping. - Look up the consultant's e-mail via the HR4YOU
/consultants/{userId}endpoint. - Resolve or auto-provision the TalentKiwi user.
- Create a new project (default open project type).
- Optionally attach a job post (when
projectIdis provided). - Create one candidate per
applicantId, tag with ATS info. - Enqueue a background import per candidate.
- Return the redirect URL.
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"
}Submit a file for parsing (sync or async) POST
Parse candidate documents (CVs, resumes, cover letters) and extract structured data. **Processing Modes:** - **Asynchronous (default)**: Submit job and poll for results using the provided status URL - **Synchronous**: Get immediate results (suitable for smaller files) **Supported Formats:** - PDF files (.pdf) - Microsoft Word documents (.doc, .docx) - Image files (.jpg, .jpeg, .png) - Plain text files (.txt) **File Requirements:** - Maximum total pages: 50 pages across all files - Files are automatically converted to PDF for processing **Language Support:** Currently supported languages include German, English. More languages can be requested.
Get job results (for async jobs) GET
Retrieve the parsed results from a completed asynchronous job. **Prerequisites:** - Job must have `completed` status (check via `/status` endpoint) - Job must belong to your API key **Response Structure:** The results contain structured candidate information including: - Personal details (name, contact information) - Work experience and employment history - Education background - Skills and competencies - Additional parsed fields based on document content