Resellers API
Resellers represent Experian Resellers which are typically CRAs or Consumer Reporting Agencies. In some cases, the CreditConnect Integrator may be both an Integrator and Reseller. In that case, the Integrator will likely have only one Reseller and work primarily with the Users and Portal APIs.
name
string, required |
Example: Lightning Screening | |
phone
string, required |
A phone number Users can call for support or to initiate a dispute. Example: 800223333 | |
email
string, required |
An email address Users can use for support or to initiate a dispute. Example: test@example.com | |
street
string, required |
Example: 123 Main St | |
city
string, required |
Example: Oakland | |
state
string, required |
Example: CA | |
zip
string, required |
Example: 12345 | |
exp_api_id
string, required |
The username used to authenticate with the Experian ConnectAPI. | |
exp_api_password
string, write only |
If provided, it will set the password used to authenticate with the Experian ConnectAPI. If not provided, it will not change the stored password. The value is write only meaning it will not be echoed out in the responses from the API. | |
privacy_policy_url
string, required |
A link to the Reseller's privacy policy. | |
report_subject_terms_and_conditions_url
string |
A link to the Reseller's terms and conditions for report subject or applicant. | |
end_user_terms_and_conditions_url
string |
A link to the Reseller's terms and conditions for end user or Property Owner. | |
demo_mode
boolean |
Defaults to false . If enabled, it and all Users created under the Reseller will be in Demo Mode. See Testing for more information about Demo Mode.
| |
style_sheets
array of strings |
Allows you to pass in an array of URLs that will be applied to portals to help brand the site. A tag to import the stylesheet will be created for each URL passed in. As such, the URLs should be absolute and use https. For example: ["https://my-domain.com/assets/custom-credit-connect-styles.css"]. |
POST
/api/v1/resellers
Creates a Reseller with the specified attributes. Returns the newly created Reseller.
Example Request
{
"reseller": {
"name": "Lightning Screening",
"website": "www.example.com",
"phone": "1234567890",
"email": "test@example.com",
"street": "123 Main St",
"city": "Oak",
"state": "CA",
"zip": "12345",
"exp_api_id": "api_username",
"exp_api_password": "api_password"
}
}
Example Response
{
"reseller": {
"id": 1,
"name": "Lightning Screening",
"website": "www.example.com",
"phone": "1234567890",
"email": "test@example.com",
"street": "123 Main St",
"city": "Oak",
"state": "CA",
"zip": "12345",
"exp_api_id": "api_username",
}
}
GET
/api/v1/resellers/:id
Returns the reseller specified by :id
.
Example Response
{
"reseller": {
"id": 1,
"name": "Lightning Screening",
"website": "www.example.com",
"phone": "1234567890",
"email": "test@example.com",
"street": "123 Main St",
"city": "Oak",
"state": "CA",
"zip": "12345",
"exp_api_id": "api_username",
}
}
PATCH
/api/v1/resellers/:id
Updates the Reseller specified by :id
. Returns the updated Reseller.
Example Request
{
"reseller": {
"id": 1,
"name": "Lightning Screening",
"website": "www.example.com",
"phone": "1234567890",
"email": "test@example.com",
"street": "123 Main St",
"city": "Oak",
"state": "CA",
"zip": "12345",
"exp_api_id": "api_username",
"exp_api_password": "api_password"
}
}
Example Response
{
"reseller": {
"id": 1,
"name": "Lightning Screening",
"website": "www.example.com",
"phone": "1234567890",
"email": "test@example.com",
"street": "123 Main St",
"city": "Oak",
"state": "CA",
"zip": "12345",
"exp_api_id": "api_username",
}
}