IDIQ Integration API (1.0.0)
Download OpenAPI specification:Download
OpenAPI definition for IDIQ API endpoints used by The Credit Pros.
Generate Partner Token
Generates a partner token used to authenticate subsequent API requests. Returns 200 on success or 422 if validation fails.
Authorizations:
Request Body schema: application/jsonrequired
| partnerId required | string |
| partnerSecret required | string |
Responses
Response Schema: application/json
| accessToken | string |
| expiresIn | integer |
Response Schema: application/json
| error | string |
| code | string |
Request samples
- Payload
{- "partnerId": "1234",
- "partnerSecret": "1ncDv2uKNDn3EKIM+ruRZZZ+3jI="
}Response samples
- 200
- 422
{- "accessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjQzMTg3OEEzMTRCRjlENzk2...",
- "expiresIn": 3600
}Get Member Token
Returns MEMBER TOKEN that is used for working with API.
- Requires PARTNER TOKEN in Authorization header.
- Returns status code
200(OK) with token if model is valid. - Returns status code
422(Unprocessable Entity) with description if error occurred after validation.
Authorizations:
Request Body schema: application/jsonrequired
| memberEmail required | string <email> Email of the enrolled member (required) |
Responses
Response Schema: application/json
| accessToken | string JWT token for authenticated API access |
| expiresIn | integer Token lifetime in seconds |
Response Schema: application/json
| message | string Description of the validation error |
Request samples
- Payload
{- "memberEmail": "calvin.miller@gmail.com"
}Response samples
- 200
- 422
{- "accessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjQzMTg3OEEzMTRCRjlENzk2OUY4QTBFOEZCM0E1QTNEOEJGNDM5RDR...",
- "expiresIn": 3600
}Enroll a new user
Enrolls a new user in the IDIQ system using the provided personal and plan information. Requires a valid PARTNER TOKEN in the Authorization header.
- 200 OK: User was successfully enrolled.
- 422 Unprocessable Entity: Validation failed, response includes error description.
Authorizations:
Request Body schema: application/jsonrequired
| birthDate required | string <date> User birth date in MM/DD/YYYY format |
| email required | string <email> Email of the user |
| firstName required | string [ 1 .. 15 ] characters ^[A-Za-z'-]+$ First name (only letters, ‘- allowed) |
| lastName required | string [ 1 .. 15 ] characters ^[A-Za-z'-]+$ Last name (only letters, ‘- allowed) |
| ssn required | string^[0-9]{9}$ Social Security Number, 9 digits |
| offerCode required | string Offer code for enrollment |
| planCode required | string Plan code for enrollment |
| street required | string [ 1 .. 50 ] characters Street address |
| city required | string [ 1 .. 30 ] characters City |
| state required | string = 2 characters Two-letter state code |
| zip required | string^[0-9]{5}$ ZIP code, 5 digits |
| middleNameInitial | string [ 0 .. 1 ] characters ^[A-Za-z]?$ Middle name initial (optional, single letter) |
Responses
Response Schema: application/json
| message | string Description of the validation error |
Request samples
- Payload
{- "birthDate": "07/09/1975",
- "email": "calvin.miller@gmail.com",
- "firstName": "Calvin",
- "lastName": "Miller",
- "middleNameInitial": "",
- "ssn": "123456789",
- "offerCode": "4315004O",
- "planCode": "PLAN6X",
- "street": "939 Orange Ave",
- "city": "Coronado",
- "state": "CA",
- "zip": "92118"
}Response samples
- 422
{- "message": "Invalid SSN format"
}Get verification questions for user authentication
Retrieves a list of verification questions for the user to answer. Requires MEMBER TOKEN.
- 200 OK: Successfully fetched the verification questions.
- 422 Unprocessable Entity: Invalid request or missing MEMBER TOKEN.
Authorizations:
Responses
Response Schema: application/json
Array of objects | |
| isSuccess | boolean |
| message | string or null |
Response Schema: application/json
| message | string Description of the validation error |
Response samples
- 200
- 422
{- "questions": [
- {
- "text": "1. Which of these street names are you associated with?",
- "answers": [
- {
- "text": "Bowen",
- "id": "68949244-3177371808"
}, - {
- "text": "Brandywine",
- "id": "68949244-3177371810"
}, - {
- "text": "None of the Above",
- "id": "68949244-3177371816"
}
]
}, - {
- "text": "2. What state was your social security number issued?",
- "answers": [
- {
- "text": "Arizona",
- "id": "68949246-3177371818"
}, - {
- "text": "Arkansas",
- "id": "68949246-3177371820"
}, - {
- "text": "None of the Above",
- "id": "68949246-3177371826"
}
]
}, - {
- "text": "3. Which of the following is a current or previous employer?",
- "answers": [
- {
- "text": "Carmax",
- "id": "68949248-3177371828"
}, - {
- "text": "Lockheed",
- "id": "68949248-3177371830"
}, - {
- "text": "None of the Above",
- "id": "68949248-3177371836"
}
]
}
], - "isSuccess": true,
- "message": null
}Submit answers to the verification questions
Submits the answers to the IDIQ system to verify the user's identity. Requires MEMBER TOKEN.
- 200 OK: Answers successfully validated.
- 422 Unprocessable Entity: Validation failed or incorrect answers.
Authorizations:
Request Body schema: application/jsonrequired
| answers | Array of strings List of question IDs corresponding to the user's selected answers |
Responses
Response Schema: application/json
| status | string Enum: "Correct" "Incorrect" |
| message | string |
| question | string or null |
Response Schema: application/json
| message | string Description of the validation error |
Request samples
- Payload
{- "answers": [
- "68949244-3177371816",
- "68949246-3177371826",
- "68949248-3177371836",
- "68950942-3177379886"
]
}Response samples
- 200
- 422
{- "status": "Incorrect",
- "message": "ID verification failed",
- "question": null
}Submit a dispute for the credit report
Pulls a recent credit report to submit a dispute. The report should be pulled within 24 hours of dispute submission to ensure the member is disputing the most recent information.
- 200 OK: Successfully submitted the dispute.
- 422 Unprocessable Entity: Error occurred during dispute submission.
Authorizations:
Responses
Response Schema: application/json
| status | string Status of the dispute submission |
| message | string or null Additional message in case of an error or success |
Response Schema: application/json
| message | string Description of the validation error |
Response samples
- 200
- 422
{- "status": "Dispute successfully submitted",
- "message": null
}Get the most recent credit report for dispute
Pulls a recent credit report for dispute submission. The report should be pulled within 24 hours of dispute submission.
- 200 OK: Successfully fetched the credit report.
- 422 Unprocessable Entity: Error occurred while fetching the report.
Authorizations:
Responses
Response Schema: application/json
object | |||||||||||||
| |||||||||||||
Response Schema: application/json
| message | string Description of the validation error |
Response samples
- 200
- 422
{- "BundleComponents": {
- "BundleComponent": {
- "CreditScoreType": {
- "@riskScore": "599",
- "@scoreName": "VantageScore3",
- "@populationRank": "32"
}, - "CreditScoreFactor": [
- {
- "@bureauCode": "83",
- "Factor": {
- "@abbreviation": "",
- "@description": "",
- "@symbol": "83",
- "@rank": "100000"
}, - "FactorText": [
- {
- "$": "explain: An installment account is one with a fixed monthly payment for the life of the loan."
}, - {
- "$": "factor: Lack of sufficient relevant installment account information"
}, - {
- "$": "cando: Maintaining open and active credit accounts in good standing can help improve your credit score."
}
]
}
], - "InquiryDate": {
- "$": "1999-07-28"
}, - "Reference": {
- "$": "43124191012779111"
}
}
}
}Retrieve Dispute History
This request allows you to retrieve a user's dispute history. The MEMBER TOKEN must be passed in the header for authorization.
- 200 OK: Successfully retrieved the dispute history.
- 422 Unprocessable Entity: An error occurred while fetching the dispute history.
Authorizations:
Responses
Response Schema: application/json
| status | integer Request status |
object or null Contains error details if any |
Response Schema: application/json
| code | string Error code |
| message | string Error message |
| name | string Error name |
Response samples
- 200
- 422
{- "status": 0,
- "errorResponse": null,
- "disputes": {
- "disputeHistory": [
- {
- "disputeId": "17154",
- "status": "cancelledDispute"
}
]
}
}Retrieve Dispute Status by Dispute ID
This request allows you to retrieve the status of a specific dispute using its dispute ID. The MEMBER TOKEN must be passed in the header for authentication.
- 200 OK: Successfully retrieved the dispute status.
- 422 Unprocessable Entity: An error occurred while fetching the dispute status.
Authorizations:
path Parameters
| id required | string The unique identifier of the dispute to retrieve the status. |
Responses
Response Schema: application/json
| status | string Status of the request (e.g., "Success") |
| disputeStatusDetail | Array of arrays |
object or null Contains error details if any |
Response Schema: application/json
| code | string Error code |
| description | string Error description |
Response Schema: application/json
| code | string Error code |
| description | string Error description |
Response samples
- 200
- 404
- 422
{- "status": "Success",
- "disputeStatusDetail": [
- {
- "disputeId": "17154",
- "status": "cancelledDispute",
- "closedDispute": {
- "estimatedCompletionDate": "8/14/2024",
- "lastUpdatedDate": "8/14/2024",
- "openDate": "8/14/2024",
- "requestedDate": "8/14/2024",
- "totalClosedDisputedItems": 0,
- "totalDisputedItems": 2,
- "totalOpenDisputedItems": 0,
- "totalPVDisputedItemCount": 2
}, - "errorStatus": null,
- "letterStatus": {
- "disputeLetterCode": "PVC_FIN 000960048410 - Dispute Status ABIMBOLA A ADESUYI",
- "disputeLetterContent": "We appreciate you taking the time to contact us at TransUnion. Our goal is to maintain complete and accurate credit information..."
}, - "openDispute": null,
- "pvDisputedItems": "<?xml version=\"1.0\" encoding=\"utf-8\"?><PVDisputedItems xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" />"
}
]
}Operations related to retrieving the full dispute result summary and updated report for a specific dispute.
Retrieve Dispute Results by Dispute ID
This request allows you to retrieve the member's full dispute result summary and the updated report for a specific dispute identified by its ID. The MEMBER TOKEN must be passed in the header for authentication.
- 200 OK: Successfully retrieved the dispute result summary and updated report.
- 422 Unprocessable Entity: An error occurred while fetching the dispute results.
Authorizations:
path Parameters
| id required | string The unique identifier of the dispute for which results need to be fetched. |
Responses
Response Schema: application/json
| status | string Status of the request (e.g., "Success") |
| resultSummary | string The result summary of the dispute, including whether it was successful or failed. |
| updatedReport | string The updated dispute report in a detailed format. |
Response Schema: application/json
| code | string Error code |
| description | string Error description |
Response Schema: application/json
| code | string Error code |
| description | string Error description |
Response samples
- 200
- 404
- 422
{- "status": "Success",
- "resultSummary": "Dispute resolved successfully, no issues found.",
- "updatedReport": "Full dispute report content with detailed results."
}Operations related to cancelling a member's dispute monitoring and unenrolling them from the dispute service.
Cancel Dispute Monitoring and Unenroll Member
This request allows a member to unenroll from the dispute monitoring service. The member will be removed from the dispute service.
- 200 OK: The member has been successfully unenrolled from the dispute service.
- 422 Unprocessable Entity: An error occurred while processing the request to cancel the dispute service.
Authorizations:
Responses
Response Schema: application/json
| status | string Status of the request (e.g., "Success") |
| message | string Additional message or confirmation details |
Response Schema: application/json
| code | string Error code |
| description | string Error description |
Response Schema: application/json
| code | string Error code |
| description | string Error description |
Response samples
- 200
- 400
- 422
{- "status": "Success",
- "message": "The member has been successfully unenrolled from the dispute monitoring service."
}