Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

The purpose of this document is to provide detailed information about the requirements and API specifications to automate and pull the credit report in your desired system.

API Requirements:

  • All requests must be made over a secure https connection. Any unsecured requests will be automatically rejected.

  • All requests must have the HTTP Header “Content-type” set to “Content-Type: text/xml; charset=utf-8”.

  • Do not send the user password in plain text, for PHP first md5() hash the password and then bin2hex() it for the proper format.  User ID and password can not be the same.

  • User ID must be between 8-20 characters in length.

  • User ID must be alphanumeric; at least one number and one letter.

  • All user passwords, including the Master User, will expire after 90 days. Change the password before 90 days or the user will become disabled.

Best Practices

The following items should be noted and be aware of when submitting a request through the API.

  • Consumer consent must be logged for all credit reports and be producible in the event of an audit.

  • Use the Master User ID and Master Password only to add, disable, or reset/re-enable other API users that belong to that customer. For any of the other requests, send the unique User ID and User Password that was created through the API. This is for compliance and tracking purposes on CBC’s side to provide accurate transactional history.

  • All names are case sensitive and should match the case specified in the documentation. Request tag names are all lowercase while response tags names are all uppercase.

  • The tag only supports one name without dashes or spaces.

  • The tag supports more than one name with dashes and/or spaces.

  • Currently, PreQual credit reports are available from Experian and TransUnion only. Both return the same information included in either an Experian or TransUnion hard pull.

  • For standard and PreQual credit reports, address data must be complete (i.e. Address, City, State, Zip). Inquiries with incomplete data (i.e. City and State without a Zipcode) will result in an error.

  • Do not include punctuation or special characters in address tags unless they are the following allowed special characters:

    • ‘/’ Forward Slash

    • ‘.’ Period

    • ‘-‘ Hyphen

    • ‘#’ Pound Sign

    • ‘ ‘ Space

  • The tag can only be used for single credit pulls. The pin will only unlock the credit report for the request sent. In other words, to pull a new credit report (not recall a credit report), you will have to send the pin in the request again.

  • Pin numbers vary in length from each bureau with a maximum length of 15 characters.

    • Experian pin length – Up to 15 characters

    • TransUnion pin length – 6 or 8 characters

    • Equifax pin length – 4 characters

API Specification:

Sample Request - We need NDA to provide the full specification along with connection parameters (endpoint, username, customerId and password).

<?xml version="1.0" encoding="utf-8"?><data_area><header_data>
<app_id>{701DF662-B16F-8B5C-B37E-D1AA66EA5A71}</app_id> 
<credit_guid>{5E28FC7B-5E19-1F8F-4E78-095B395D2890}</credit_guid>
<user_id>{UserId}</user_id>
<user_pwd>{UserPassword}</user_pwd>
<cus_id>{CustomerId}</cus_id>
<single_joint>0</single_joint>
<pre_qual>0</pre_qual>
<action>XPN</action>
</header_data><applicant_data>
<applicant type="primary">
<person_name>
<first_name>KENNETH</first_name>
<middle_name></middle_name>
<last_name>CARISON</last_name>
</person_name>
<address_data>
<address type="current">
<line_one>1950 BUFFALO ST</line_one>
<city>VIDOR</city>
<state_or_province>TX</state_or_province>
<postal_code>77662</postal_code>
<housing_status>0</housing_status>
</address>
</address_data>
<birthdate></birthdate>
<social>666559236</social>
</applicant>
</applicant_data>
</data_area>

Sample Response - The XML is hude big list.
  • No labels