Sample CRM · Carousel docs

docsThe guide API reference Open Carousel

SampleNothing here is real

Jane, a leasing agent, is composing the screening on the application. Everything in the Tenant screening card goes to Carousel — step 1 shows the request as you change it. Then press Send screening.

crm.your-company.com/applications/APP-1042

Applications / APP-1042

Nora J Belliveau · unit 305

OverviewScreening report

Application

Applicant: nora@example.com
Property: 1450 Rue Exemple, Montréal
Rent: $1,850 / month
Move-in: Nov 1, 2026

Tenant screening by CarouselNot sent

Applicant

Rental1450 Rue Exemple, Montréal · unit 305from this application

ChecksVerifiedIdentity verification · Credit checkVerified+Identity verification · Credit check · Court & Eviction Search (QC) · Penal Search (QC)Verified ProIdentity verification · Credit check · Court & Eviction Search (QC) · Penal Search (QC) · Bank verificationVerified MaxIdentity verification · Credit check · Court & Eviction Search (QC) · Penal Search (QC) · Police Check (All of Canada) · Bank verification

Who pays Your Carousel balance The applicant, at checkout

The applicant’s link Carousel emails it Your CRM sends it

Sent with your record’s id, APP-1042

On this screen

Tenant screening: set up three things once in Carousel, then five steps — the first two here, each time your user screens someone applying to rent; step 3 is on Track it, steps 4 and 5 on Show the report.

Set up once, in Carousel

Make a key

Your initials (top right) → Developers → Keys. Switch on Show reports in my app — steps 4 and 5 need it — and, while you build, Test key: nobody is emailed and no tokens are spent, though buildings you add are real. Keep the key on your server.

Carousel’s account menu, open, with Developers outlined — Your initials, top right → Developers

Developers → Keys: a key named “Our CRM” with Show reports in my app switched on — Keys: name it, switch on Show reports in my app, Create key

curl · check it

curl https://app.oncarousel.com/api/v1/me \
  -H "Authorization: Bearer $CAROUSEL_API_KEY"

Set your webhook

Developers → Webhook: the address on your server where Carousel sends each event (step 3).

Developers → Webhook: the address set and on, for every event — Developers → Webhook: your address, on for every event

Allow your site

Developers → Allowed sites: your CRM’s address — and http://localhost:<port> while you build with a test key. Reports open on these sites only (step 5), and a live report only on an https one.

Developers → Allowed sites, with two sites and the box to add one — Developers → Allowed sites

Each time your user screens an applicant

Send a tenant screening

When your user presses Send screening, your server sends what the composer collected. Your application’s id goes in externalId, and the Idempotency-Key makes a retry safe. This one is filed under the rental (building and unit); with no property, send "region": "CA" instead. Carousel emails the applicant their link — or send "delivery": "none" and hand them applicantLink yourself.

curl · what the composer above sends

curl -X POST https://app.oncarousel.com/api/v1/screenings \
  -H "Authorization: Bearer $CAROUSEL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: APP-1042-send-1" \
  -d '{
    "checks": ["id", "credit", "court_qc", "penal_qc", "bank"],
    "applicant": { "email": "nora@example.com" },
    "building": "<building id>",
    "unit": "<unit id>",
    "externalId": "APP-1042"
  }'

Every field you can send, with its options and where its values come from: the fields of a send.

Save Carousel’s id with your application

Keep the answer’s id next to your application — step 4 uses it.

201

{
  "id": "6f0c2d1e-5b7a-4c8e-9f10-2a3b4c5d6e7f",
  "status": "invited",
  "externalId": "APP-1042",
  "applicantLink": "https://apply.oncarousel.com/start-application?…",
  "portalUrl": "https://app.oncarousel.com/report/6f0c2d1e-…",
  "delivery": "sent",
  "tokenCost": 660
}