Invites, reminders & reorders
Automatic package-level reminders nudge applicants for you. Resend an invite and its expiration resets, cancel it outright, or reorder with a fresh voucher — all without leaving your system.
Invites, reminders, order details, webhooks, monitoring, and disputes — every step of an identity-verified background check, programmable end to end.
POST an invite, then GET the order when the webhook lands. The applicant and the engine do everything in between.
One POST sends a branded vID invite by email — or returns a link, QR code, and 6-character manual-entry code you can hand over in person. Bulk and quick-invite variants cover batch uploads and instant redirects, and re-inviting someone with a pending invite simply returns the existing one, so duplicates are impossible.
curl -X POST https://api.cerebrum.com/v1/vid/invites \
-H "apikey: $CEREBRUM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"packageId": "pkg_background_plus_id",
"deliveryMethod": "EMAIL",
"contactInformation": {
"email": "jane.doe@example.com",
"phoneNumber": "+15551234567",
"firstName": "Jane",
"lastName": "Doe"
},
"postbackWebhookUrl": "https://yourapp.com/webhooks/cerebrum",
"metadata": { "internalCandidateId": "cand_88412" }
}'The applicant opens the invite in the vID app or right in their browser, takes a liveness-checked selfie, scans the front and back of their government ID, and signs disclosures. No typing, no forms, no data entry errors flowing into your screening.
// no request
Selfie, ID scan, disclosures — on any device, in about the time it takes to make coffee.
Document authentication, biometric match, MRZ and barcode analysis against AAMVA standards, screen-capture and photocopy detection, tamper and date logic — twenty independent checks per document. Typical turnaround is 30 seconds to 2 minutes, and an order is created automatically the moment verification completes.
// no request
Twenty checks fire automatically. The order appears in your account when they finish.
Every meaningful change — status, score, dispute resolution, voucher redemption, monitoring reports — posts to your endpoint as a signed Svix webhook. Deliveries retry eight times over more than a day, signatures verify with standard HMAC-SHA256, and a simulate endpoint lets you rehearse every event type before you go live.
{
"id": "ord_01J8ZK4M3N",
"idType": "order",
"event": "ORDER_STATUS_CHANGE",
"eventDate": "2026-02-09T15:11:49Z",
"additionalMetadata": { "internalCandidateId": "cand_88412" }
}Pull the full order — applicant data, verification results, reportable results, signed disclosures, the vID report PDF, even the selfie — with a single expanded GET. Need more later? Attach county, national criminal, SSN, or AAMVA searches to the same order and track each one to completion.
curl "https://api.cerebrum.com/v1/orders/ord_01J8ZK4M3N?expand=id_verification_data,reportable_results,vid_report" \
-H "apikey: $CEREBRUM_API_KEY"Enrollment is one idempotent call per order. From then on, every reportable delta generates a monitoring report — delivered by webhook with a signed PDF URL. Clean cycles stay silent, and disenrollment is a single request when the relationship ends.
// no request
Enroll once. After that the only thing you'll hear back is a signed report when something actually changes.
If a coordinator can click it, your integration can call it. The API covers the full operating surface of the platform.
Automatic package-level reminders nudge applicants for you. Resend an invite and its expiration resets, cancel it outright, or reorder with a fresh voucher — all without leaving your system.
Statuses, scores, reportable results, disclosures, files, and the full audit trail — everything the dashboard shows is available over the wire, org-scoped and filterable.
Enroll any completed order in ongoing monitoring and get notified only when something changes — delta reports with signed PDFs, never noise from clean cycles.
Consumers can dispute straight from their results; you track every dispute from OPEN to RESOLVED by API and send adverse action notices with a single call.
Attach arbitrary JSON metadata to any invite. It's copied to the order automatically and echoed in every webhook payload, so reconciliation with your internal IDs is free.
Seven event types cover the entire order lifecycle. Every payload is HMAC-SHA256 signed with a per-endpoint secret, and deliveries retry on a backoff schedule — immediately, then 5 seconds, 5 minutes, 30 minutes, 2, 5, 10, and 10 hours — before an event is ever dropped.
ORDER_STATUS_CHANGELifecycle moved — pending to completeORDER_SCORE_CHANGEDisposition set or updatedORDER_CUSTOM_SCORE_CHANGEYour custom score changedORDER_DISPUTE_RESOLVEDA dispute reached resolutionVOUCHER_REDEEMEDApplicant accepted the inviteVOUCHER_EXPIREDInvite lapsed unclaimedMONITORING_REPORT_GENERATEDNew monitoring delta foundEvery order carries status, score, and alert as independent fields — so your integration never has to guess what “complete” means.
Status — where the order is
PENDING, IN_PROGRESS, IN_DISPUTE, INCOMPLETE, or COMPLETE. It's the lifecycle, nothing more — COMPLETE means reviewed, not passed.
Score — what you decided
The disposition: ID_VERIFIED, NO_ALERTS, REVIEW_REQUIRED, PRE_ADVERSE, ADVERSE_ACTION, and more — plus custom scores you define yourself.
Alert — what was found
A simple binary: NO_ALERTS_FOUND or ALERTS_FOUND. It's a finding, not a verdict — your team keeps the decision.
Generate a key in Cognition, send your first invite, and watch a signed webhook land in your endpoint — all before lunch.