Postman collection

A ready-to-run Postman collection covering every endpoint.

Import the collection, then set two variables before running anything:

VariableValue
baseUrlhttps://rca-onboardly.com/api/v1
apiKeyYour issued key — see Authentication.

Every request in the collection is written with start: false — running the whole collection never sends a real WhatsApp message.

  • 01 — Create candidate (start:false, SAFE)
  • 02 — Replay: same Idempotency-Key, DIFFERENT body
  • 03 — Auth: no API key (expect 401)
  • 04 — Get candidate result
  • 05 — Patch candidate (identity, notes)
  • 06 — Patch outreach (per-candidate chase)
  • 07 — Add documents (any name accepted)
  • 08 — Add a reference
  • 09 — Get compliance pack (409 until complete)
  • 10 — Tenancy: another account’s candidate (expect 404)
  • 11 — Get document content
  • 12 — Update a reference (PATCH, send:false)