Consent Management

Manage data authorization directly from candidates via the People Index Consent Engine.

The Consent Flow

Before your ATS or HRMS can read a candidate's assessed employment data, you must secure their cryptographic consent. Our SDK provides a seamless way to request this consent via email, SMS, or an embedded UI flow.

request-consent.ts

// Requesting consent for employment history
const consentRequest = await idx.consent.request({
  candidateEmail: "jane.doe@example.com",
  requestedClaims: ["EmploymentHistory_v2"],
  purpose: "Professional Trust Scoring for Senior Engineer role",
  expiresIn: "7d"
});

console.log('Consent link sent:', consentRequest.url);

Webhooks for Consent

Because candidates must manually approve the data release from their People Index wallet, consent requests are asynchronous. You should subscribe to the consent.granted webhook to know when the data is ready to be fetched.

Embedded Flow

If you are building a custom applicant tracking system, you can use our <ConsentWidget /> React component to keep the user within your application context rather than redirecting them to their email.