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 or revoked 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.

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

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.

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

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.