Retrieve the compliance pack

Download the finished compliance pack once every required document is accepted.

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

Download the candidate’s compliance pack once every required document is accepted.

Headers

X-Api-Keyonb_live_<key_id>_<secret>required: Your issued Partner API key — see Authentication.
Acceptapplication/zip | application/pdf (default)optional: application/zip for the full evidence bundle. Anything else, including an omitted header, returns the standalone PDF summary.

Status codes

2002xx: Pack bytes streamed as an attachment.
4014xx: Missing, malformed, unknown or revoked key. Every authentication failure looks the same — see Authentication.
4044xx: Unknown, cross-tenant, or (a candidate id) sandbox-hidden. One outcome, never a 403.
Not found
4094xx: At least one required document is not yet accepted. meta.blockers names which — poll GET /candidates/{id} until compliance_pack.ready instead.
pack_blocked_by_non_accepted_documents
4294xx: Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5005xx: The pack could not be built. Retry; if it persists, contact support with the candidate id.
5035xx: A record the readiness check depends on could not be read. Never a confident 409 — retry shortly.
Some of this candidate’s records could not be read right now. Try again shortly.

Readiness is DOCUMENTS-ONLY — an outstanding reference never blocks the pack.
There is no ?force= bypass here, unlike the dashboard download: a partner integration has no human to read a warning banner and override it.
The 409’s meta.blockers are { id, name, status } objects — richer than GET /candidates/{id}’s own bare-name compliance_pack.blockers array.

cURL

curl \
  "https://rca-onboardly.com/api/v1/candidates/<candidate id>/pack" \
  -H "X-Api-Key: $ONB_KEY" \
  -H "Accept: application/zip" \
  -o compliance-pack.zip

200 · PDF summary (default)

application/pdf

The standalone summary document.

200 · ZIP evidence bundle (Accept: application/zip)

application/zip

Every accepted document plus the summary.

409 · Not every document is accepted yet

{
  "data": null,
  "error": "pack_blocked_by_non_accepted_documents",
  "meta": {
    "blockers": [
      {
        "id": "8a21c4d6-0f3e-4b9a-8d1c-7e2f5a9b3c41",
        "name": "Right to Work",
        "status": "pending"
      }
    ]
  }
}

PreviousHow reference emails are sent NextAssistant name

GET /api/v1/candidates/{id}/pack