Help Center

How can we help?

Guides for getting the most out of Hiremium — accounts, the API, credits, billing, and troubleshooting. Pick a topic on the right, or read straight through.

Jump to a topic

Overview

Hiremium is a pair of AI APIs for hiring workflows: match scoring (rate how well an application fits a job, 0–100 with a reason) and resume parsing (turn a CV file into structured data). You call them over HTTPS with a single API key, and usage is billed from one credit pool.

New here? The fastest path: create an account, pick a plan, generate your API key, and make your first call using the API docs.

Create an account

Sign up with your email (or a social login) from the registration page. You will need to verify your email before you can generate an API key — this keeps accounts and credits secure.

Your dashboard

Your dashboard shows your current plan, remaining credits (with a usage bar), how long the subscription is valid, your API key controls, and a log of recent API calls. The My Orders page lists your billing history.

Generate an API key

From the dashboard, click Generate to mint your API key. It is shown once — copy it immediately and store it like a password. You can regenerate it (which revokes the old one) or revoke it entirely at any time.

  • Keep the key server-side; never put it in browser or mobile code.
  • Anyone with your key can spend your credits.

Authentication

Send your key as a Bearer token on every request:

Authorization: Bearer YOUR_API_KEY

Also send Accept: application/json. A missing or invalid key returns 401 unauthenticated.

Match scoring

POST a job and an application to /api/v1/matching-score and receive a 0–100 score plus a short written reason. You can send the application as text or attach a resume file. Full field details are in the docs.

Resume parsing

Upload a CV to /api/v1/parse-resume (PDF, DOC, DOCX, TXT, or an image) and get back a structured profile: contact details, experience, education, projects, skills, languages and more. Text-based files are parsed directly; scanned files use vision processing automatically.

Async jobs

For batches, use the /async endpoints. They return a job_id immediately; poll /api/v1/jobs/{id} until the status is completed (or failed). Polling is free.

Rate limits

The API allows 60 requests per minute per account. Exceeding it returns 429 rate_limited — back off a few seconds and retry, or use the async endpoints for large volumes.

How credits work

Every successful call deducts credits from your subscription balance. Both features draw from the same pool. Credits are charged up front and, if the AI step fails on our side, automatically refunded. Balances do not roll over — on renewal the balance resets to your plan's allowance.

What each call costs

  • 1 credit per application match score.
  • 1 credits per resume parse when text is extracted directly.
  • 1 credits per resume parse that needs vision processing (scanned PDFs and images).
  • Polling an async job is free.

The response's meta.extraction_path tells you which path (and cost) applied.

Plans & billing cycles

Plans are credit allowances billed monthly or yearly and renew automatically. Yearly plans include a discounted annual credit bundle granted up front. Compare options on the pricing page. Payments are securely handled by LemonSqueezy.

Upgrading your plan

On the pricing page, choose a higher-credit plan (or switch your current plan to yearly). Upgrading starts a new checkout; once it completes, your previous subscription is superseded so you are never billed twice, and your new credits become available. You cannot switch to the same or a lower plan while a subscription is active.

Cancelling

Cancel any time from your LemonSqueezy receipt/customer portal. Your access and remaining credits continue until the end of the current paid period; the subscription simply does not renew after that.

Refund policy

We do not offer refunds for subscription fees or unused credits, except where required by law. Cancelling stops future renewals but does not refund the current period. The one automatic exception is fairness-based: if an AI call fails on our side, the credits for that call are refunded to your balance — you are never charged for a failed result. See our Terms & Conditions for details.

Is there a free tier?

No — there is no free tier or free trial. An active subscription with credits is required to use the API. If you are evaluating for a larger rollout, get in touch and we will help.

Common errors

Errors return a JSON body with an error.code and message. The most common:

  • 401 unauthenticated — key missing, invalid, or revoked.
  • 402 no_active_subscription / insufficient_credits — no active plan, or not enough credits for the call.
  • 422 validation_failed — the request body is missing or invalid (details in errors).
  • 415 unsupported_file_type — the uploaded file type is not supported.
  • 429 rate_limited — too many requests; slow down.
  • 502 ai_provider_error — the AI step failed; the credit is refunded automatically.

Failed calls & refunds

If a call is charged but the AI step fails, we automatically refund the credit and log the call as refunded — visible in your dashboard usage log. You only pay for results you actually receive.

Data & security

Traffic is encrypted over HTTPS, API keys are stored hashed, and uploaded files sent through the async flow are deleted right after processing. We do not use your submitted content to train models. See the Privacy Policy for the full picture.

Still need help?

Can't find what you need? Our team is happy to help with integration, billing, or anything else. Contact us and we'll reply within one business day.