Skip to main content

Create a Credentials Session

POST https://api.truework.com/credentials/session

Creates a new Credentials Session and returns a JSON object representing the newly created Credentials Session.

Request#

Request Body#

PROPERTYTYPEREQUIREDDESCRIPTION
typeTypeType of verification request
permissible_purposePermissiblePurposeReason for why this verification is being conducted
use_caseUseCaseUse case for this request. If omitted, the verifier type in account settings will be used as a default.
targetTargetInformation on the individual who is being verified
metadataJSONA single level key-value JSON object that can be used to store custom data on the verification request. Keys and values must be strings.

Target#

PROPERTYTYPEREQUIREDDESCRIPTION
first_namestringFirst name of the target
last_namestringLast name of the target
social_security_numberstringThe target's social security number in format XXX-XX-XXXX or XXXXXXXXX
contact_emailstringTarget's email address
date_of_birthstringTarget's date of birth in format YYYY-MM-DD
companyCompanyDetails about the target's company

Company#

PROPERTYTYPEREQUIREDDESCRIPTION
idstringThe id returned in a company search response
namestringThe name of the company
phone_numberstringContact phone number for this company
addressAddressAddress of the company

Address#

PROPERTYTYPEREQUIREDDESCRIPTION
line_onestringFirst address line (for example street address)
line_twostringSecond address line
citystringCity
statestringState
countrystringCountry
postal_codestringPostal Code

Response#

Response Body#

The response body from this endpoint is a CredentialsSession

Examples#

Request#

$ curl 'https://api.truework.com/credentials/session' \
-X POST \
-H 'Authorization: Bearer myTrueworkToken' \
-H 'Content-Type: application/json' \
-d '{
"type": "employment",
"permissible_purpose": "risk-assessment",
"use_case": "mortgage",
"target": {
"first_name": "Joe",
"last_name": "Smith",
"social_security_number": "000-00-0000",
"contact_email": "joesmith@example.org",
"date_of_birth": "1980-01-01",
"company": {
"id": 1234
}
},
"metadata": {
"internal_id": "12454"
}
}'

Response#

{
"token": "AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP"
}