Onboardly
Get started

Partner API Create candidates, collect documents and references, retrieve the compliance pack.

Get an API key

Retrieve a document page

Download the bytes of one page of a document the candidate sent as several pages.

GET/api/v1/candidates/{id}/documents/{docId}/pages/{pageId}/content#

Download the bytes of one page of a multi-page document.

Headers

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

Status codes

2002xx
Bytes streamed inline (or as an attachment with ?download=1).
4014xx
Missing, malformed, unknown, revoked or expired key. Every authentication failure looks the same — see Authentication.
4044xx
Unknown candidate, document or page, or a cross-tenant request; or a page that is not one of the document’s current pages — another document’s page, a page of an older version of this document, or a page that is not stored or has been deleted.
Not found
4294xx
Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5005xx
The service is not configured to read candidate records.
This resource is temporarily unavailable. Try again shortly.
5025xx
The storage fetch failed (retry), OR the stored file is over the 16 MB read-side size ceiling (error object too large): that file cannot be served and a retry will not succeed; contact support with the candidate id.
5035xx
The record of the document’s pages could not be read right now. Never a confident 404 for this case — retry shortly.
Some of this candidate’s records could not be read right now. Try again shortly.

Use the content_url of an entry in documents[].pages on Retrieve a candidate — the page id is already in it, so you do not build the URL by hand. Append ?download=1 to force Content-Disposition: attachment instead of inline rendering.

Only pages of the document’s CURRENT version are served: if the candidate replaces the document with a newer set of pages, the old pages’ URLs answer 404 and the new ones appear in pages. The page the document’s own content_url serves (the one its submission was recorded against, not necessarily page 1) is one of them.

cURL
curl \
  "https://rca-onboardly.com/api/v1/candidates/<candidate id>/documents/<document id>/pages/<page id>/content" \
  -H "X-Api-Key: $ONB_KEY" \
  -o dbs-page-2.jpg
200 · Page bytes

Inherited from the original upload (an allowlisted set of image/PDF types).

The stored file for that page — the SAME bytes the candidate sent.

PreviousRetrieve document contentNextRetrieve the CV