Onboardly
Get started

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

Get an API key

Retrieve document content

Download the bytes of a document’s latest submission.

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

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, cross-tenant, or nothing has been submitted for this slot yet.
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 upstream storage or Twilio media 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.

Append ?download=1 to force Content-Disposition: attachment instead of inline rendering.

For a document the candidate sent as several pages this serves the page the document’s submission was recorded against — not necessarily page 1. Every page, in page order, is listed in documents[].pages on Retrieve a candidate and served by Retrieve a document page.

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

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

The stored file — the SAME bytes the candidate uploaded.

PreviousApproved templatesNextRetrieve a document page