Carousel

Adds a building (and its units) to a workspace. Safe to repeat: an address already in the workspace comes back as that building, with any new units added — never a duplicate. A unit written in the address ("44 King St W #1203") is moved to the units. In an employment workspace (coming soon) it adds a position instead: a `name` (the position title) and `in_quebec`; a position has no address, units or rent, and a position with the same title comes back as that position.

add_building

Test keys only (cp_test_…): the simulated applicant does everything still to come at once, so a test screening reaches completed (or expired) now. A test screening emails nobody, spends no tokens and has sample results; the applicant email’s +tag picks what happens: +record, +stopped, +expire, +bounce.

advance_test_screening

The Carousel account and API key this connection acts for, and which workspaces it reaches (`key.reach`: `all`, `account` or `listed`). The quickest test that the connection works.

whoami

A screening’s status (invited, in_progress, completed, expired, cancelled), each check’s progress (waiting, in_progress, done, stopped), and its links.

get_screening

Each check’s results — identity, credit, court, police, bank, what the applicant declared — and the stored documents’ ids. Only for a key made with “Read applicant results”. Statuses are what the provider returned; Carousel never approves or rejects. The answer is the applicant’s personal information; free-text fields are the applicant’s own words, as they typed them. ID document numbers are withheld here (null); the report in Carousel shows them.

get_results

A workspace’s buildings, with their units — or, in an employment workspace (coming soon), its positions (`kind` "position": a title and `inQuebec`). A screening filed under a building or position shows there in Carousel.

list_buildings

What can be sent in a region: every check with its token price, every combination of checks a screening can run (with its token cost, the applicant price, and whether each payer can send it right now), and the account’s custom workflows. A combination’s `checks` is what send_screening takes. Canada: court_qc + penal_qc are Québec’s court checks, court_roc the rest of Canada’s; a building in Québec takes Québec’s. With `workspace` or `building`: what can be sent there, for that workspace’s type of screening (the answer’s `kind`) — an employment workspace or position (coming soon) lists its options as combinations: `id` (required) plus any of credit, criminal and penal_qc (penal_qc for a position marked as in Québec only), each sendable once Carousel has set it up.

list_checks

Everything that happened to the screenings this key reaches in the account’s stream — those filed in the account, and those its keys sent into shared workspaces — oldest first: sent, delivered, started, each check done, completed, viewed, cancelled, expired — and building, unit and balance events. Start with after=0, then pass back `cursor`. The same events the webhook pushes.

list_events

Every screening filed where this key reaches — the account’s, and workspaces shared with its owner when the key reaches them — sent through the API or from Carousel, by anyone, newest first, a page at a time: pass back `cursor` as `after` while `hasMore`. With `external_id`, the screenings this account sent with that id instead.

list_screenings

The workspaces this key reaches — the groups buildings sit in — each with the `kind` it screens for (`tenant` today; `employment` is coming soon): the account’s own, and, for a key that reaches every workspace, the ones other accounts shared with its owner, each with its `account`, the owner’s `role` there and `canSend` (View only reads but can’t send). A workspace id files a screening there, and lists its buildings.

list_workspaces