Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Onboarding webhooks

Get notified when an applicant opens their link, or opens it and doesn't finish.

As well as the result webhook, Personr can notify you while an applicant is still onboarding:

Event
Sent when

onboarding.opened

The applicant opens their verification link for the first time

onboarding.incomplete

The applicant opened their link but submitted nothing within 60 minutes

These use the same endpoint URL and authentication token as your result webhook.

Turning them on

Onboarding webhooks are off by default, so existing integrations aren't affected.

  1. Make sure your endpoint URL is saved.

  2. Under Advanced, switch on Also send onboarding events.

The change applies from the next link an applicant opens. Switch it off at any time to stop them.

Webhook payload

{
  "event": "onboarding.incomplete",
  "applicantId": "4242424242424x424242424242424242",
  "linkId": "4343434343434x434343434343434343",
  "onboardingStatus": "Incomplete",
  "openedAt": "2026-10-26T04:06:00.883Z",
  "sentAt": "2026-10-26T05:06:01.120Z"
}
Field
Description

event

onboarding.opened or onboarding.incomplete

applicantId

The applicant

linkId

The onboarding link that was opened

onboardingStatus

The link's status when the webhook was sent: Opened or Incomplete

openedAt

When the link was first opened (ISO 8601)

sentAt

When this webhook was sent (ISO 8601)

If an applicant finishes after an onboarding.incomplete, you'll receive the normal result webhook when their verification is processed. To check the current state at any time, use Checking onboarding link status.

Was this helpful?