Skip to content
Connect API Catalog/
/
/
US Consumer Report

US Consumer Report

Request

Search for US consumer based on provided criteria. Returns a consumer report with credit information, trade lines, negative information, and employment details.

Template Options:

  • basic - Standard consumer report without credit score. No footprint left on consumer's credit file.
  • hardcheck - Includes credit score in response and leaves a footprint (inquiry) on the consumer's credit file. Used for actual credit decisions.
Security
bearerToken
Query
countriesstring, = 2 characters^[A-Z]{2}$required

A single country code in ISO-2 format. Must be US for US consumer reports.

Example:countries=US
firstNamestringrequired

First name of US consumer

lastNamestringrequired

Last name of US consumer

templatestring

Consumer report template. basic (default) returns report without credit score and leaves no footprint. hardcheck includes credit score and leaves an inquiry on the consumer's credit file.

Default:"basic"
Enum:"basic""hardcheck"
personNumberstring^[a-zA-Z0-9]+$

Social security number (SSN) of US Consumer

dateOfBirthstring, (date)

Date of birth of US Consumer (format YYYY-MM-DD)

streetstring

Street name and house number of US consumer

citystring

City of US consumer

postalCodestring

Postal / zip code of US consumer

provincestring, = 2 characters^[A-Z]{2}$

US state of US consumer (2-letter state code, e.g., AL, CA, NY)

telephonestring

Telephone number of US consumer

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/consumers/tryReport?countries=US&firstName=string&lastName=string&template=basic&personNumber=string&dateOfBirth=2019-08-24&street=string&city=string&postalCode=string&province=st&telephone=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Consumer TryReport response

Bodyapplication/json
correlationIdstring
reportobject(CreditsafeGlobalDataReportsConsumerCsusConsumerReport)

Consumer Report response

dateOfOrderstring, (date-time)
languagestring
userIdstring
Response
{
  "correlationId": "string",
  "report": {
    "language": "string",
    "consumerInformation": { … },
    "creditScoreExtra": { … },
    "contactInformation": { … },
    "negativeInformation": { … },
    "additionalInformation": { … }
  },
  "dateOfOrder": "2019-08-24T14:15:22Z",
  "language": "string",
  "userId": "string"
}