Credentials
Truework Credentials lets verifiers customize the consumer experience and verify income and employment for almost any US employer, all while increasing trust, accelerating transactions and improving the verification experience with access to source-of-truth payroll data.
Using Credentials in your workflow provides a variety of benefits, including faster turnaround times, increased conversions and the ability to verify more consumers – 85% of the US workforce, including gig-economy and other non-W2 workers. Verifications are submitted by sending the appropriate employee / employer information and authorization through an embedded Truework.js widget via Truework Direct or through an email-based workflow created via the verification API. After confirming authorization, consumers can directly log into their payroll provider(s). Once there is a successful connection, employment and income data is shared directly from the payroll provider to Truework, where it is automatically checked for quality and accuracy. The data is then transformed and standardized into a Truework verification report, compliant with the Fannie Mae’s 1005 form.
Truework Credentials extends verification coverage beyond the Instant network providing verifications within minutes without the added cost or turn-around time associated with Smart Outreach (manual) verifications for use cases, such as:
- Mortgage
- Auto loans
- Tenant screening
- Background checks
- Consumer lending
Getting started on your implementation is quick, easy, and, best of all, self-serve! All you need to do is create a Truework Account, and generate an API key to use the Truework Sandbox. When you are ready to move to Production simply reach out to implementations@truework.com. Now, let’s get started!
As a best practice, create an API service account (e.g. truework@yourcompany.com
) for your organization to manage your integration from one central dashboard.
Choosing a Credentials integration method
Depending on your needs you may choose to integrate Credentials directly into your frontend application using Truework.js, or use the target employer order API to trigger the Credentials workflow via an email to the consumer. Both options allow you to leverage Truework’s powerful consumer-driven verification capabilities. Below is some guidance to ensure you pick the right method to maximize conversion based on your workflow.
Truework.js
Truework.js allows you to embed a consumer-driven verification workflow directly into your consumer-facing frontend application. If you have the ability to do so, using this approach is recommended as it causes less friction for the consumer, and results in higher conversion.
Verification API
The verification API allows you to integrate Credentials into a workflow that doesn’t have any consumer-facing component, by automating the process of emailing verification requests to the consumer, and making the results available via our API. Consumers receive an initial email to complete their verification upon creation, as well as reminders at a periodic cadence. We’ll send an email reminder every 3 days, as well as the day before the request expires.
You can also can leverage Credentials via the Truework Web App with no development work required.
How to implement Credentials with Truework Direct with the Truework.js widget
A detailed guide on how to integrate Truework.js into your frontend application can be found here
Truework.js co-branding (enterprise only)
The Truework.js widget supports co-branding with custom logos and theme colors for each Publishable Key. To customize, navigate to your developer settings page, scroll down to the Truework.js section, and modify the co-branding settings on the publishable key you created in the linked guide.
How to implement Credentials with Truework’s verification API
Integrating with the verification API allows you to easily integrate the Truework Credentials into your existing workflow by automating the process of emailing verification requests to the consumer.
There are three steps to sending a request to the verification API:
Step 1: Create a target employer order
To create a target employer order with the API, you will need to make a POST request to the /orders/target-employer
endpoint with credentials
included in allowed_verification_methods
under the request_config
attribute. Make note of the id
field that is returned from this endpoint, you’ll need it to retrieve the results of the order.
Step 2: Consumer completes verification via Credentials email
Next, the consumer will receive an email requesting that they complete their verification via Credentials. They will need to click the link contained within, and provide their payroll details.
Step 3: Retrieve your results
Once the consumer has completed the Credentials flow, you can retrieve the order using the ID from step 1 by making a GET request to /orders/{id}
. The order returned will have a verification request that contains a report of the information we gathered from the consumer’s payroll system.
You can also configure a webhook to be notified when the order is complete, and results are available.
Email co-branding (enterprise only)
You can customize the email sent to consumers to show your company’s logo, name in the “From” field and support text. To customize, login to Truework and navigate to Team > Team Settings > Company Co-branding and Email Customization to set up the feature.
Conclusion
That’s it! You’re ready to implement Truework Credentials in your verification workflows.
Need some help? Not a problem, our team is here to help: Get help.