Onboardly
Get started

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

Get an API key

Retrieve attachment content

Download the bytes of one unmatched attachment.

GET/api/v1/candidates/{id}/attachments/{attachmentId}/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 or cross-tenant candidate, an attachment id that is not this candidate’s, or a file no longer held.
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.

Use the content_url from List unmatched attachments. Append ?download=1 to force Content-Disposition: attachment instead of inline rendering.

cURL
curl \
  "https://rca-onboardly.com/api/v1/candidates/<candidate id>/attachments/{attachmentId}/content" \
  -H "X-Api-Key: $ONB_KEY" \
  -o attachment.pdf
200 · Attachment bytes

The content type recorded when the file was stored.

The stored file, as kept from the candidate’s WhatsApp message.

PreviousList unmatched attachmentsNextDocument names