Create a Credentials Session
DeprecatedCreates a new Credentials Session and returns a JSON object representing the newly created Credentials Session.
Headers
Authorization
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Accept
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Request
This endpoint expects an object.
permissible_purpose
A valid purpose is required for Truework to process the verification request.
Throughout the API, this is signified by the `permissible_purpose` field.
| VALUE | DESCRIPTION |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| child-support | Determine child support payments (available to verifiers that represent a state or local child support enforcement agencies) |
| credit-application | The target's application for credit |
| employee-eligibility | Employee's eligibility for a benefit granted by a governmental agency required by law to consider the employee's financial responsibility or status |
| employee-request | The target has issued the verifier written instruction to obtain this information |
| employee-review-or-collection | Performing a review or collection of the target's account |
| employment | Employment purposes where the target has given prior written consent |
| insurance-underwriting-application | Underwriting insurance in response to the target's application |
| legitimate-reason-initiated | Legitimate business need for the information in connection with a business transaction initiated by the target |
| legitimate-reason-review | Legitimate business need to review the target's account to determine whether the employee continues to meet the terms of the account |
| risk-assessment | To assess the credit or prepayment risks associated with an existing credit obligation of the target |
| subpoena | For a court order or a federal grand jury subpoena
target
type
Allowed values:
use_case
The verification request use case describes the type of product the verification request is originating from.
If omitted, the verifier type in account settings will be used as a default
| VALUE | DESCRIPTION |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| mortgage | Verification for a mortgage |
| home-equity | Verification for home equity
| background | Verification for a background check |
| tenant | Verification for a rental property |
| government | Verification for government/social services |
| auto | Verification for auto lending |
| lending | Verification for personal loans or consumer lending |
| credit | Verification for credit cards |
| identity | Verification for identity or fraud |
| insurance | Verification for insurance |
| health | Verification for health services |
| offers | Verification for offers |
| account-management | Verification for account management |
| preapproval | Verification for preapprovals |
metadata
A single level key-value JSON object that can be used to store custom data on the verification request. Keys and values must be strings.
reseller_originating_party
Required for reseller requests, should not be provided for non-reseller requests.
Response
A Credentials Session was successfully created.
id
token