Experian Integration API (1.0.0)
Download OpenAPI specification:Download
OpenAPI definition for Experian API endpoints used by The Credit Pros.
This endpoint creates the consumer session which is used to retrieve reports and submit disputes associated with the provided PII consumer information.
Create Consumer Session
Create a consumer session to retrieve reports and submit disputes.
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
Request Body schema: required
| visitType required | string |
| purpose required | string |
| stampDate required | string <date> |
required | object |
Responses
Response Schema: application/json
| sessionId | string |
| status | string |
| consumerId | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Request samples
- Payload
Content type
{- "visitType": "web",
- "purpose": "dispute",
- "stampDate": "2024-10-27",
- "pii": {
- "firstName": "GORDON",
- "lastName": "WILLIAMS",
- "generation": "",
- "dob": "1986-10-10",
- "ssn": 666777888,
- "address": "19624 RALEIGH CIR 50",
- "city": "SOUTHFIELD",
- "state": "MI",
- "zip": 48076
}
}Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
{- "sessionId": "abc123",
- "status": "ACTIVE",
- "consumerId": 2148047638
}Get OAuth2 Token
Get an OAuth2 token using client credentials and user credentials.
header Parameters
| Client_id required | string Example: your-client-id |
| Client_secret required | string Example: your-client-secret |
| x-api-key required | string Example: <your_api_key> |
Request Body schema: application/jsonrequired
| username required | string |
| password required | string |
Responses
Response Schema: application/json
| access_token | string |
| token_type | string |
| expires_in | integer |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Request samples
- Payload
Content type
application/json
{- "username": "cro_creditpros_stg",
- "password": "passwd"
}Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
{- "access_token": "eyJraWQiOiJ...",
- "token_type": "Bearer",
- "expires_in": 3600
}Retrieve and manage final consumer disclosure data for consumer profiles, including results from the dispute process.
Get Initial Consumer Disclosure
Retrieve the initial consumer disclosure for a specific consumer.
path Parameters
| consumerId required | string Example: 2148047638 |
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
Responses
Response Schema: application/json
| disclosureId | string |
| status | string |
| consumerId | string |
object |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "disclosureId": "abc123",
- "status": "RETRIEVED",
- "consumerId": "2148047638",
- "reportData": { }
}Retrieve Final Consumer Disclosure for a specific consumer profile
Retrieve the final consumer disclosure information, including dispute cycle and session details.
path Parameters
| consumerProfileId required | string Example: 3761853712 |
query Parameters
| consumer_session_id required | string Example: consumer_session_id=2147717450 |
| abbreviate | boolean Example: abbreviate=false |
| dispute_cycle | string Example: dispute_cycle=001 |
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
Responses
Response Schema: application/json
| consumerProfileId | string |
| consumerSessionId | string |
| abbreviate | boolean |
| disputeCycle | string |
object |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "consumerProfileId": "3761853712",
- "consumerSessionId": "2147717450",
- "abbreviate": false,
- "disputeCycle": "001",
- "finalDisclosureDetails": {
- "disclosureText": "Final disclosure text.",
- "disputeDetails": "Dispute cycle details."
}
}Endpoints related to submitting disputes for consumers, including selecting items for dispute and submitting reasons.
Submit a Dispute for Consumer
Submit a dispute request for a specific consumer using their consumer ID.
path Parameters
| consumerId required | string Example: 2148047638 |
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
Request Body schema: application/jsonrequired
| objectId required | string |
| disputeReasonCode required | string |
| disputeReasonText required | string |
Responses
Response Schema: application/json
| status | string |
| disputeId | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Request samples
- Payload
Content type
application/json
{- "objectId": "003-Rt-260-uaSkSEYIyndihw-VAEEbo4y7uG+WvhGIzxpA_",
- "disputeReasonCode": "34",
- "disputeReasonText": "Test Dispute"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "status": "DISPUTE_SUBMITTED",
- "disputeId": "dsp-94820347234"
}Retrieve available dispute reasons for specific credit report items, which can be selected for disputes.
Get Dispute Descriptors
Retrieve dispute descriptor options for a specific object related to the given consumer ID.
path Parameters
| consumerId required | string Example: 2148047638 |
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
| objectType required | string Example: 003 |
| objectId required | string Example: 003-Rt-260-uaSkSEYIyndihw-VAEEbo4y7uG+WvhGIzxpA_ |
Responses
Response Schema: application/json
Array of objects | |||||
Array
| |||||
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "disputeReasons": [
- {
- "code": "34",
- "description": "Not my account"
}
]
}Retrieve a list of CDFS (Consumer Disclosure Financial Services) report numbers for consumer profiles.
Retrieve CDFS (Consumer Disclosure Financial Services) Data
Retrieve CDFS information for the specified office number and consumer profile.
query Parameters
| officeNum required | string Example: officeNum=307?officeNum=1 |
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
Responses
Response Schema: application/json
| officeNum | string |
Array of objects |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "officeNum": "307?officeNum=1",
- "cdfsData": [
- {
- "field1": "Sample Field Data 1",
- "field2": "Sample Field Data 2"
}
]
}Retrieve and manage general statement options that consumers can add to their reports.
Retrieve specific statement options for a consumer profile
Retrieve available statement options for a consumer profile based on the provided statement option ID.
path Parameters
| consumerProfileId required | string Example: 2147603211 |
| statementOptionId required | string Example: 009 |
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
Responses
Response Schema: application/json
| consumerProfileId | string |
| statementOptionId | string |
object |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "consumerProfileId": "2147603211",
- "statementOptionId": "009",
- "statementOptionDetails": {
- "optionName": "Standard Statement",
- "optionDescription": "The standard statement option for the consumer.",
- "additionalInfo": "No additional information."
}
}Create and manage disputes for consumer profiles, including selecting dispute items and submitting disputes for processing.
Create a new dispute for a consumer profile
Create a new dispute entry for the consumer profile based on the provided dispute details.
path Parameters
| consumerProfileId required | string Example: 2148047638 |
header Parameters
| X-Tracker required | string Example: CreditPros_Tracker |
| Authorization required | string Example: Bearer <access_token> |
| x-api-key required | string Example: <your_api_key> |
Request Body schema: application/jsonrequired
| objectType | string |
| disputeReasonCode | string |
object |
Responses
Response Schema: application/json
| disputeId | string |
| status | string |
| createdAt | string <date-time> |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Response Schema: application/json
| error | string |
| code | string |
Request samples
- Payload
Content type
application/json
{- "objectType": "009",
- "disputeReasonCode": "PR",
- "additionalInformation": {
- "statementType": "03"
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "disputeId": "dispute_12345",
- "status": "Pending",
- "createdAt": "2024-10-27T12:00:00Z"
}