Onboard users with Layer

A guide to integrating Layer with Plaid Check

Overview

This guide will walk you through how to onboard users to Plaid Check with Layer. This process involves creating a user, onboarding the user with Layer, and retrieving the user's Plaid Check data.

Integration steps

Create a user
  1. Create a user token using the /user/create endpoint. At this stage, the consumer_report_user_identity field is optional.
Onboard the user with Layer

  1. Onboard the user by following Layer's Integration Overview steps.
    When creating the Link token via /session/token/create, pass in the user token you created in the user.user_id field and be sure the template used has CRA products enabled.

  2. Call /user_account/session/get to retrieve user-permissioned identity information.

  3. After processing the identity information, update the Plaid user record by calling the /user/update endpoint. Populate the consumer_report_user_identity field with the relevant information.

Retrieve the user's Plaid Check data

  1. Now that the identity information has been added to the user record, you can generate a Consumer Report by calling /cra/check_report/create.

  2. Once the Consumer Report has been generated (indicated by a CHECK_REPORT_READY webhook), retrieve the report by calling /cra/check_report/base_report/get, /cra/check_report/income_insights/get, /cra/check_report/partner_insights/get, or /cra/check_report/pdf/get.