Onboard users with Layer

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.

1. Create a user_id using the /user/create endpoint. At this stage, the identity field is optional.

1. Onboard the user by following Layer's Integration Overview steps.
   When creating the Link token via /session/token/create, pass in the user_id 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 identity field with the relevant information. At minimum, the following fields must be provided and non-empty: name, date_of_birth, emails, phone_numbers, and addresses (with at least one email address, phone number, and address designated as primary). Providing at least a partial SSN via the id_numbers field is highly recommended, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests.

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 USER_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.