Carousel docs
Tenant screening

Screening products

Tenant screeningThese docsCredit, criminal, eviction, income and ID for rental applicants.
Commercial screeningComing soonCredit, court records, ID and bank-verified income for commercial tenants and their guarantors.
Employment screeningComing soonID, police checks and Québec penal searches for candidates, and credit where the role calls for it.
Regular screeningComing soonBackground and identity checks for staff, members or contractors.
Developer guides

Developers

Send screenings from your own systems with the Carousel API, follow each one as it moves, and show it in your CRM by its link.

New here? Start with Concepts

What Carousel does, how a screening goes from your system to a report, what it costs, and how to test it: Concepts.

What it does

  • Send a screening from your CRM. Choose the checks, file it under a building, and Carousel emails the applicant their link — or hands the link to you.
  • Get back the link to show. Every answer carries portalUrl, the screening’s page in Carousel, for your team. They sign in once and open it from your CRM.
  • Follow it. Sent, started, each check done, completed, viewed, and more — read them when you like, or have them pushed to your webhook.
  • Show the report inside your product. For users with no Carousel login: the report and its PDF, read-only, in a frame on your own page — see Integrate your CRM, with the full example.
  • Read the results, if you choose. A key made with Read applicant results gets each check’s results and documents through the API — identity, credit, court, police, bank. A key made with Show reports in my app can’t call the results API, but it opens any report the key reaches, with its documents and PDF, inside your app. Keep both as safe as each other. Other keys see each screening’s status and the applicant’s email, never their results.

Carousel never approves or rejects an applicant. Each check reports what its provider returned; the decision is yours.

Where to start

  1. Sign up at app.oncarousel.com with Google — it’s the only way to sign in. Each person signs in as themselves. To manage your company account’s keys, webhook and allowed sites, ask its owner to add you as a developer in Developers → Access; nothing is emailed, so open Developers, choose Accept, then pick the account under Account at the top. To read its reports, ask them to share the workspace with you: your own keys that reach Every workspace you can use then reach it too, at the role they gave you.
  2. Open the account menu (your initials, top right) and choose Developers. Its Quickstart has the base URL and requests you can paste; Keys creates a key; Webhook sets where events are sent.
  3. Read Concepts, then follow the API quickstart. Building it into your CRM? Follow Integrate your CRM.
Base URL

https://app.oncarousel.com/api/v1 — JSON in and out, a key on every request. The reference, with each endpoint and a request console: app.oncarousel.com/api/reference. The console’s requests are real, like any other.

Without the API, your site can still open the composer with a screening already filled in. Link to /screen/new on Carousel and add any of these to the query:

  • recipient — the applicant’s email address. Without it, nothing is filled in.
  • package — v (Verified), vp (Verified+), pro (Verified Pro) or max (Verified Max). Without it, Verified+.
  • payer — renter (the applicant pays) or self (you pay). Without it, the applicant pays.
  • region — CA (Canada) or US (the United States). Without it, the region the visitor last used.
  • mode — screen, the default, opens the composer; send opens it and asks a signed-out visitor to sign in straight away; signin and signup open the sign-in page.

These are the composer link’s own words, not the API’s: the API sends checks and "payer": "tokens" or "renter". The link carries no price and no authority. Nothing is sent until the sender signs in and reviews the screening.

The Carousel Classic API

Carousel Classic is the original platform: workflows built in its dashboard, and its own API at api.oncarousel.com. New integrations use the Carousel API at https://app.oncarousel.com/api/v1, which these pages describe. Classic’s guides and full reference are in the Carousel Classic developer docs.

Questions

Is there a test mode?

Yes: make a test key (cp_test_…) in Developers → Keys. Same address, same requests, same answers — but nobody is emailed, no tokens are spent and no real check runs; a simulated applicant completes each screening. Workspaces and buildings are your real ones, though: one you add with a test key is real. With a live key every send is real, including one from the API reference’s request console. See Concepts.

What does a test cost?

With a test key, nothing: no tokens, no email, no credit check. A live test on yourself — for ["id", "credit"] at shipped prices — CA$21.99 with "payer": "renter", which you pay at checkout as the applicant, or 264 tokens (about $22) with "payer": "tokens", charged only as each check completes. A live credit check is a hard inquiry: it’s recorded on your own credit file.

Who can open portalUrl?

The account’s owner, signed in to Carousel, and people the screening’s workspace or building is shared with. Share the workspace with your teammates in Carousel first — see Share with your team. Developers added in Developers → Access don’t get it, and a screening in Private opens for the owner only. Never send portalUrl to the applicant: their link is applicantLink. For users of your platform with no Carousel login, see Show reports in your platform.

Where do applicants complete their checks?

On Carousel’s own hosted flow, from the link we email them (or the one you hand them).

Do I need to build workflows?

No. You send one of the combinations of checks GET /checks lists, or a custom workflow Carousel sets up for you.

How is usage billed?

In tokens, per check, as each one completes — 12 tokens to the dollar — unless the applicant pays at checkout. See Concepts and Tokens and billing.

The infrastructureof yes.