Step 2: Enroll End Users

Before you can screen a consumer, you must first enroll the end user (agent or property manager) who will be requesting the screening. Enrollment walks the end user through identity verification, terms agreement, and consent — and generates a pair of publishable keys specific to that end user's account.

Use the end user's key for consumer screenings, not the TSP key

After a successful enrollment, the SDK returns liveKey and testKey in the onVerificationSuccess callback. These end-user-specific keys are what you must pass as publishableKey when screening consumers — not the TSP key you used in Step 1. The TSP key does not have permission to initiate consumer screenings.

Initialize with the END_USER Type

Your platform must authenticate the end user before initializing the SDK. Pass the end user's stable, unique identifier via userContext:

const sdk = Intellirent.init({
  publishableKey: "pk_live_xxxxxxxxxxxxxxxx", // Your TSP publishable key
  userContext: {
    userId: "enduser_abc123", // Stable identifier from your auth system
    userType: "END_USER",
  },
});

Mount the Enrollment Flow

Mount the screening view to start the end user enrollment:

await sdk.mount("#screening-container", {
  view: "screening",
  onVerificationSuccess: async (result) => {
    // Store these keys — you'll use them when screening consumers
    await saveEndUserKeys({
      userId: "enduser_abc123",
      liveKey: result.liveKey,
      testKey: result.testKey,
    });
  },
});

The enrollment flow walks the end user through identity verification, terms agreement, and consent. On completion, the onVerificationSuccess callback fires with the newly generated publishable keys.

Already know the end user's category?

By default, enrollment opens with a screen asking whether the operator is an independent owner, a real estate agent, or a property management company. If your platform already knows this, pass screening.endUserType to skip straight to the first data-entry step — see endUserType in SDK Methods.

TSP Key vs. End User Key

Key Type	Used For
TSP publishable key	Dashboard access, initiating end user enrollment
End user live key	Consumer screenings in production
End user test key	Consumer screenings in test mode

End user keys are account-scoped — screenings submitted under an end user's key are visible to that end user when they authenticate and view reports. This scoping is explained in Step 4: View Reports.

Testing Enrollments

Test mode requires test consumers

When using a pk_test_* key, real consumer PII will not work. You must use test consumers for all test-mode screenings.

Use your TSP test key (pk_test_*) and a test identity to run enrollments in test mode. The returned testKey can then be used for test-mode consumer screenings in Step 3.

Next Step

Once you have stored the end user's publishable keys, continue to Step 3: Screen a Consumer.