Consent
Attest consent you already hold, or let Verifisha collect it for you.
Reports are gated on the subject's consent by default (requireConsent
defaults to true). How that consent is obtained is your choice — set
consent.mode on each report.
| Mode | Who asks the subject | Use it when |
|---|---|---|
CUSTOMER_ATTESTED | You did, in your own flow | Consent is already part of your onboarding, terms or contract. |
VERIFISHA_HOSTED | Verifisha, through a consent link | You would rather not build or maintain a consent step. |
Verifisha-hosted consent is optional. If your customers have already agreed — at sign-up, in your terms, or on a form of your own — attest to it and the report runs immediately. Verifisha never contacts your customer, and they never see a Verifisha page.
If you already have consent
Attest to it, and the checks run straight away:
"consent": {
"mode": "CUSTOMER_ATTESTED",
"obtained": true,
"obtainedAt": "2026-09-09T10:30:00Z",
"method": "CUSTOMER_WEB_FORM",
"policyVersion": "employment-screening-v3",
"evidenceReference": "consent-1042"
}The report skips PENDING_CONSENT entirely — no link is sent, nothing waits on
the subject, and your own onboarding stays the only thing they see.
These fields are your record of that consent. method is how you collected it,
policyVersion names the wording the subject agreed to, and
evidenceReference identifies where you keep the underlying record so it can
be produced if the consent is ever questioned.
Attesting consent you have not obtained is not a shortcut. The attestation is retained against the report as the basis on which the checks ran.
If you would rather Verifisha asked
Create the report with hosted consent
"consent": {
"mode": "VERIFISHA_HOSTED",
"redirectUrl": "https://example.com/onboarding/complete"
}The report enters PENDING_CONSENT. The response's consentState carries
consentUrl — the link the subject approves on — and expiresAt.
The subject decides
The link opens a Verifisha consent page showing who is asking, the purpose
you gave, and every check that will run. The subject approves or declines, and
is returned to your redirectUrl.
The report proceeds, or stops
On approval the checks run. On refusal they do not.
After approving, the subject can see a summary of their own report — narrower than your view of it.
Write purpose for the subject, not for your own records. It is the sentence
they read before deciding.
Knowing where a report stands
GET /reports/{reportId}/consent/state
returns status — PENDING, APPROVED, DECLINED, EXPIRED or
NOT_REQUIRED — along with consentUrl and expiresAt.
An attested report has nothing to wait for. A hosted link stops working at
expiresAt, and the state becomes EXPIRED.
For progress without polling, subscribe to report.ready and report.failed
webhooks.