Developer API

Hirezira API Documentation

A REST API to redact candidate contact details programmatically. Base URL https://api.hirezira.com/v1

Authentication

All requests are authenticated with a secret API key sent as a Bearer token. Create keys from your dashboard settings. Never expose a sk_live key in client-side code.

#7dd3fc">curl https://api.hirezira.com/v1/me \
  -H "#7dd3fc">Authorization: Bearer sk_live_your_api_key"

Upload Resume

Submit a resume for redaction by POSTing a publicly reachable fileUrl (PDF, DOCX or TXT) to /v1/redact. Processing is asynchronous; you receive a job you can poll or subscribe to via webhook.

#7dd3fc">curl https://api.hirezira.com/v1/redact \
  -H "#7dd3fc">Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "fileUrl": "https://files.acme.com/resume.pdf" }'

Get JSON Response

When processing completes, the job returns the candidate name, a summary of what was removed, and a signed URL for the sanitized file.

200 OK

{
  "candidateName": "removed",
  "email": "removed",
  "phone": "removed",
  "linkedin": "removed",
  "sanitizedResume": "https://files.hirezira.com/sanitized/abc123.pdf",
  "removed": {
    "email": #fca5a5">1,
    "phone": #fca5a5">1,
    "linkedin": #fca5a5">1,
    "address": #fca5a5">1,
    "pincode": #fca5a5">1
  },
  "status": "ready"
}

Download Sanitized Resume

Fetch the sanitizedResume URL with your API key to download the client-ready file. Formatting is preserved and contact details are fully removed — not just hidden.

Download

#7dd3fc">curl -L https://files.hirezira.com/sanitized/abc123.pdf \
  -H "#7dd3fc">Authorization: Bearer sk_live_your_api_key" \
  -o client-ready-resume.pdf

Webhook Support

Register a webhook URL to be notified the moment a resume finishes processing, so you never have to poll. Each delivery is signed so you can verify authenticity.

webhook payload

// POST from Hirezira to your endpoint when a job finishes
{
  "event": "resume.redacted",
  "jobId": "job_abc123",
  "status": "ready",
  "sanitizedResume": "https://files.hirezira.com/sanitized/abc123.pdf"
}

Rate Limits

Limits are applied per API key and scale with your plan:

Plan	Requests / min	Monthly resumes
Starter	60	100
Agency	120	1,000
Enterprise	Custom	Unlimited

Responses include X-RateLimit-Remaining headers. Exceeding a limit returns 429.