TransUnion

REST API for TransUnion Data

[Step 1]: TransUnion Credit Report Request

post/transunion/credit-report/basic/{config}
  • This endpoint returns a JSON credit report based on the provided config value for the identity submitted in the request body.
  • The "config" string to be used in the URL is demonstrated in your Postman Collection.
  • Save the response header value, "RequestID". This value can be used to order the PDF version of the report when using the following endpoint in Step 2.
This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers
SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
firstName
required
string (First Name) [ 0 .. 20 ] characters
middleName
string (Middle Name) [ 0 .. 20 ] characters
lastName
required
string (Last Name) [ 0 .. 32 ] characters
nameSuffix
string (Generation Suffix) [ 0 .. 3 ] characters
Enum: "Sr" "Jr" "III" "IV" "V" "VI" "VII" "VIII" "IX" "X"
dob
string <date> (Date of Birth)
ssn
string (Social Security Number) [ 4 .. 11 ] characters
phone
string (Mobile Phone Number) = 10 characters
street1
required
string (Street Address) [ 0 .. 48 ] characters
city
required
string (City) [ 0 .. 28 ] characters
state
required
string (State) = 2 characters
zip
required
string (Zip Code) [ 5 .. 10 ] characters
Responses
200

Successful Credit Report (basic) Response

Request samples
application/json

Example Request

{
}
Response samples
application/json
{
}

[Step 2]: TransUnion PDF Credit Report Retrieve

post/transunion/custom-credit-report/pdf/{requestId}/{config}

This endpoint orders a PDF credit report based on the config value and RequestID value provided in the URL.

This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers

SecurityAuthorization Token
Request
path Parameters
requestId
required
string
config
required
string
Responses
200

TransUnion basic credit report PDF response.

Request samples 
ID Search
post/transunion/id-search
TransUnion's ID Search is a specialized search based on input name and Social Security number. Input address information is optional. ID Search delivers name and address for up to eight subjects. Additionally, ID Search selects the subject that best matches the input data. ID Search also returns ID Mismatch Alert, TruValidate Fraud Alerts, and Phone Append (if the subscriber is authorized for these services). ID Search can return an FFR or a print image
This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers


SecurityAuthorization Token 
Request 
Request Body schema: application/json
category
string
 
address
string
 
comments
string
 
image
string
 
sex
string
 
hairColor
string
 
skinTone
string
 
source
string
 
weight
string
 
eyeColor
string
 
militaryService
string
 
driversLicense
string
 
age
string
 
ageAtDeath
string
 
deathVerificationCode
string
 
scarsMarks
string
 
jurisdiction
string
 
status
string
 
alias
string
 
dob
string
 
state
string
 
fullName
string
 
race
string
 
caseNumber
string
 
height
string
 
Responses 
200
Successful ID Search Response


Request samples 
application/json
Example Request


{
}
Response samples 
application/json
{
}
TruValidate Identity Manager Verification Standalone Report
post/transunion/identity-manager-verification/basic/{config}
TransUnion's TruValidate Identity Verification is a compliance and fraud detection solution that assess the risk associated with end user personal information. It checks input consumer data against multiple databases, analyzes the results, and alerts the subscriber to any data discrepancies as well as suspicious or known fraudulent data. This information may be provided as part of an application process and identity verification confirms the integrity and validity of that information. TruValidate provides support for a variety of services. These services include:
  • Identity Verification
  • Digital Verification
  • Knowledge-Based Verification
  • One time passcode Authentication
This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers


SecurityAuthorization Token 
Request 
path Parameters
config
required
string
 
Request Body schema: application/json
firstName
required
string (First Name)   [ 0 .. 20 ] characters 
 
middleName
string (Middle Name)   [ 0 .. 20 ] characters 
 
lastName
required
string (Last Name)   [ 0 .. 32 ] characters 
 
nameSuffix
string (Generation Suffix)   [ 0 .. 3 ] characters 
 Enum: "Sr" "Jr" "III" "IV" "V" "VI" "VII" "VIII" "IX" "X"  
dob
string <date>  (Date of Birth) 
 
ssn
string (Social Security Number)   [ 4 .. 11 ] characters 
 
phone
string (Mobile Phone Number)   = 10 characters 
 
street1
required
string (Street Address)   [ 0 .. 48 ] characters 
 
city
required
string (City)   [ 0 .. 28 ] characters 
 
state
required
string (State)   = 2 characters 
 
zip
required
string (Zip Code)   [ 5 .. 10 ] characters 
 
Responses 
200
Successful Identity Response


Request samples 
application/json
Example Request


{
}
Response samples 
{
}
TruValidate Identity Manager Verification with mobile OTP
post/transunion/identity-manager-verification/auth/otp/{caseId}
Part of TransUnion's TruValidate services suite, one-time passcodes work by ensuring a unique code sent to an end user’s phone can be provided by the end user. By validating the code was received by the end user, you can use the phone as a possession factor for authentication. Using One-time passcodes requires two main steps:
  1. Requesting a code get sent to the end user’s phone
  2. Validating the end user’s entered code to the value sent
Based on the results of each of these two steps you can either allow or deny access to an end user.
This endpoint is the first step in the One-Time Passcode workflow.
This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers


SecurityAuthorization Token 
Request 
path Parameters
caseId
required
string
 
Responses 
200
Successful Identity Response


Request samples 
Response samples 
{
}
TruValidate Identity Manager Verification with mobile OTP
post/transunion/identity-manager-verification/auth/otp/{caseId}/{passcode}
Part of TransUnion's TruValidate services suite, one-time passcodes work by ensuring a unique code sent to an end user’s phone can be provided by the end user. By validating the code was received by the end user, you can use the phone as a possession factor for authentication. Using One-time passcodes requires two main steps:
  1. Requesting a code get sent to the end user’s phone
  2. Validating the end user’s entered code to the value sent
Based on the results of each of these two steps you can either allow or deny access to an end user.
This endpoint is the second step in the One-Time Passcode workflow.
This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers


SecurityAuthorization Token 
Request 
path Parameters
caseId
required
string
 
passcode
required
integer <int32> 
 
Responses 
200
Successful Identity Response


Request samples 
Response samples 
{
}
TruValidate Identity Manager Verification with mobile OTP and KBA
post/transunion/identity-manager-verification/auth/kba/{caseId}
Using the Knowledge-Based Verification service in TransUnion's TruValidate solution consists first of an exam generation request, followed by an answer verification step. Depending on the information provided in the original request, an end user may or may not be eligible for an exam. If the end user is eligible, they will need to fill in the exam and have it verified to assess their identity.
Using Knowledge-Based Verification requires two main steps:
  1. Requesting an exam
  2. Validating the end user’s responses to the exam
Based on the results of each of these two steps you can either allow or deny access to an end user.
This is a dynamic REST API endpoint. The HTTP response body returned is subject to change based on the customer's unique order configuration or due to API changes made by our data providers
SecurityAuthorization Token 
Request 
path Parameters
caseId
required
string
 
Request Body schema: application/json
AnswerUrl
string
 
Array of objects (Question) 
 
MultiPassStatus
integer <int32> 
 
Array of objects (Question) 
 
Timestamp
string <date-time> 
 
Status
string
 Enum: "-1" "0" "1" "2" "3" "4" "5" "6"  
Responses 
200
Successful Identity Response


Request samples 
application/json
Example Request


{
}
Response samples 
{
}
creditReportStandardWithConfig
post/transunion/credit-report/standard/{config}
SecurityAuthorization Token 
Request 
path Parameters
config
required
string
 
Request Body schema: application/json
firstName
required
string (First Name)   [ 0 .. 20 ] characters 
 
middleName
string (Middle Name)   [ 0 .. 20 ] characters 
 
lastName
required
string (Last Name)   [ 0 .. 32 ] characters 
 
nameSuffix
string (Generation Suffix)   [ 0 .. 3 ] characters 
 Enum: "Sr" "Jr" "III" "IV" "V" "VI" "VII" "VIII" "IX" "X"  
dob
string <date>  (Date of Birth) 
 
ssn
string (Social Security Number)   [ 4 .. 11 ] characters 
 
phone
string (Mobile Phone Number)   = 10 characters 
 
street1
required
string (Street Address)   [ 0 .. 48 ] characters 
 
city
required
string (City)   [ 0 .. 28 ] characters 
 
state
required
string (State)   = 2 characters 
 
zip
required
string (Zip Code)   [ 5 .. 10 ] characters 
 
Responses 
200
OK


Request samples 
application/json
{
}