Users API

Users are the end-users of CreditConnect. They can be either property owners or applicants. Applicants are sometimes referred to as Report Subjects since they are ordering their own reports. An applicant shares their reports with property owners who can in turn view the shared reports.

Since Users correspond to users in the Integrator’s platform, the Integrator will typically create a CreditConnect user shortly before they need to access a CreditConnect portal and store the returned CreditConnect User ID alongside the Integrator’s platform user.

Note that the field requirements for a User varies based on the type of User.

Most of the data you can provide below is optional and is pre-populated into the "User Data" form in the KBA Portal for user convenience. The CreditConnect API is very permissive and will allow name and address input that Experian does not. This is intended to reduce API Errors that an Integrator must handle since we can offload correcting the input to the User. If needed, the User will be asked to correct their name and address before submitting it to Experian in the KBA Portal.

reseller_id integer, required	Indicates which Reseller you which to create the user under
user_type string, required	Indicates if the user is an Applicant or Property Owner. Allowed values are `applicant` or `po_user`.
first_name string	Pre-populates the User Data form in the KBA Portal. While the CreditConnect accepts virtually any input, the user will be required to ensure their first name only contains 1 space and no special characters before submitting their "User Data" to Experian in the KBA Portal. Example: Mary Jane
last_name string	Pre-populates the User Data form in the KBA Portal. While the CreditConnect API accepts virtually any input, the User will be required to ensure their last name contains no spaces or special characters before submitting their "User Data" to Experian in the KBA Portal. Example: Doe
street string	Pre-populates the User Data form in the KBA Portal. While the CreditConnect accepts virtually any input, the user will be required to ensure their street address doesn't contain any special characters (including comma) before submitting their "User Data" to Experian in the KBA Portal. Example: 123 Main St
city string	Pre-populates the User Data form in the KBA Portal. Example: Oakland
state string	Pre-populates the User Data form in the KBA Portal. Example: CA
zip string	Pre-populates the User Data form in the KBA Portal. Example: 12345
email string, required, po only	Only applies to Property Owner users. The attribute is ignored if submitted for an Applicant.
po_user_id integer, required, applicant only	Indicates which Property Owner the Applicant is applying with. CreditConnect will automatically include the Property Owner in the list shares presented to the Applicant in the Applicant Portal. The Applicant can always share their reports with the indicated Property Owner irregardless of the value submitted to `max_shares`. Only applies to Property Owner users. Only applies to Applicant users. The attribute is ignored if submitted for a Property Owner.
max_shares integer, applicant only	Defaults to `0`. Indicates how many people the Applicant can share their report with beyond the Property Owner indicated by `po_user_id`. Only applies to Applicant users. The attribute is ignored if submitted for a Property Owner.
multi_share boolean, applicant only	Defaults to `false`. Indicates which credit report to order from Experian. A single share report or a special report that comes with 30 shares. Be aware that Experian charges more for the multi-share report. Only applies to Applicant users. The attribute is ignored if submitted for a Property Owner.
demo_mode boolean	Defaults to `false`. Will be overridden to `true` if the Reseller is in Demo Mode. See Testing for more information about Demo Mode.

While po_user_id is currently required for Applicant Users, it may be made optional in the future without warning.

POST

/api/v1/users

Creates a User with the specified attributes. Returns the newly created User. Note the requests and responses vary for Applicant and Property Manager Users.

Example Create Applicant Request

{
  "user": {
    "reseller_id": 1,
    "user_type": "applicant",
    "first_name": "John",
    "last_name": "Doe",
    "street": "123 Main St.",
    "city": "Oakland",
    "state": "CA",
    "zip": "12345",
    "po_user_id": 1,
    "max_shares": 0,
    "multi_share": false,
    "demo_mode": false
  }
}

Example Create Property Owner Request

{
  "user": {
    "reseller_id": 1,
    "user_type": "po",
    "first_name": "John",
    "last_name": "Doe",
    "street": "123 Main St.",
    "city": "Oakland",
    "state": "CA",
    "zip": "12345",
    "email": "test@example.com",
    "demo_mode": false
  }
}

Example Response

{
  "user": {
    "id": 5,
    "needs_kba": true,
    "city": "Draper",
    "demo_mode": true,
    "first_name": "Jim",
    "last_name": "Testington",
    "state": "UT",
    "street": "111 Test St",
    "zip": "84020"
  }
}

GET

/api/v1/users/:user_id

Example Response

{
  "user": {
    "id": 5,
    "needs_kba": true,
    "city": "Draper",
    "demo_mode": true,
    "first_name": "Jim",
    "last_name": "Testington",
    "state": "UT",
    "street": "111 Test St",
    "zip": "84020"
  }
}