Onboardly
Get started

Retrieve the CV

Download the bytes of a candidate’s uploaded CV.

GET/api/v1/candidates/{id}/cv#

Headers

X-Api-Keyonb_live_<key_id>_<secret>required
Your issued Partner API key — see Authentication.

Status codes

2002xx
Bytes streamed inline (a bare PDF request) or as an attachment (every other type, or ?download=1).
4014xx
Missing, malformed, unknown or revoked key. Every authentication failure looks the same — see Authentication.
4044xx
Unknown candidate, cross-tenant, or no CV on file.
Not found
4294xx
Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5025xx
The storage provider’s download itself failed (a missing/deleted object, or a backend error). Retry.
This document could not be downloaded right now. Try again shortly.
5035xx
The ledger recording this CV, or storage itself, could not be consulted. Never a confident 404 for this case — retry.
Some of this candidate’s records could not be read right now. Try again shortly.
5005xx
The stored file exceeds the read-side size ceiling — a write-side cap bypass, never something you did.
This resource is temporarily unavailable. Try again shortly.

A PDF renders inline by default; every other accepted type downloads as an attachment. Append ?download=1 to force an attachment regardless of type.

cURL
curl \
  "https://rca-onboardly.com/api/v1/candidates/<candidate id>/cv" \
  -H "X-Api-Key: $ONB_KEY" \
  -o cv.pdf
200 · CV bytes

Derived from the stored file’s extension (PDF or Word) — never the object’s own stored content type.

The stored file — the one attached at creation, or a newer one the candidate later sent over WhatsApp and the bot recognised as their CV.

PreviousRetrieve document contentNextDocument names