Endpoints Overview

The Personal Credit Score endpoint returns the credit score of an individual based on their financial data.

Parameters:

• clientId (required): The unique ID of the individual whose credit score is being requested.

Example Request:

curl -X GET 'https://api.reshscore.com/v1/credit-score/12345' \
-H 'Authorization: Bearer YOUR_API_KEY'

Example Response:

{
  "clientId": "12345",
  "creditScore": 750,
  "creditStatus": "Good"
}

Error Codes:

• 404 Not Found: The clientId does not exist.
• 401 Unauthorized: Invalid or missing API key.

The Business Credit Score endpoint provides a credit score for a business entity.

Parameters:

• companyId (required): The unique ID of the business whose credit score is being requested.

Example Request:

curl -X GET 'https://api.reshscore.com/v1/business-score/67890' \
-H 'Authorization: Bearer YOUR_API_KEY'

Example Response:

{
  "companyId": "67890",
  "creditScore": 820,
  "creditStatus": "Excellent"
}

Error Codes:

• 404 Not Found: The companyId does not exist.
• 401 Unauthorized: Invalid or missing API key.

The Credit History endpoint returns detailed credit history information for a specific individual.

Parameters:

• clientId (required): The unique ID of the individual whose credit history is being requested.

Example Request:

curl -X GET 'https://api.reshscore.com/v1/credit-history/12345' \
-H 'Authorization: Bearer YOUR_API_KEY'

Example Response:

{
  "clientId": "12345",
  "creditHistory": [
    { "date": "2023-01-01", "event": "Loan Approved", "status": "Paid" },
    { "date": "2022-05-15", "event": "Loan Application", "status": "Approved" }
  ]
}

Error Codes:

• 404 Not Found: The clientId does not exist.
• 401 Unauthorized: Invalid or missing API key.

The Identity Theft Protection endpoint monitors user activity for potential identity theft incidents.

Parameters:

• clientId (required): The unique ID of the individual to monitor.
• email (optional): The email address of the individual.
• phoneNumber (optional): The phone number of the individual.

Example Request:

curl -X POST 'https://api.reshscore.com/v1/identity-protection/monitor' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-d '{
  "clientId": "12345",
  "email": "user@example.com",
  "phoneNumber": "+123456789"
}'

Example Response:

{
  "monitoringStatus": "active",
  "alerts": []
}

Error Codes:

• 400 Bad Request: Invalid or missing parameters.
• 401 Unauthorized: Invalid or missing API key.

The Fraud Detection endpoint allows businesses to report potential fraud cases for analysis.

Parameters:

• clientId (required): The unique ID of the individual involved in the fraud case.
• description (required): A description of the suspicious activity.

Example Request:

curl -X POST 'https://api.reshscore.com/v1/fraud-detection/report' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-d '{
  "clientId": "12345",
  "description": "Suspicious loan application"
}'

Example Response:

{
  "fraudCaseId": "789",
  "status": "under_review"
}

Error Codes:

• 400 Bad Request: Invalid or missing parameters.
• 401 Unauthorized: Invalid or missing API key.

The Loan Prequalification endpoint allows individuals to check their eligibility for a loan.

Parameters:

• clientId (required): The unique ID of the individual.
• loanAmount (required): The amount of loan the individual is applying for.

Example Request:

curl -X POST 'https://api.reshscore.com/v1/loan-prequalification' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-d '{
  "clientId": "12345",
  "loanAmount": 5000
}'

Example Response:

{
  "clientId": "12345",
  "prequalified": true,
  "prequalifiedAmount": 4500,
  "loanTerms": "12 months"
}

Error Codes:

• 400 Bad Request: Invalid or missing parameters.
• 401 Unauthorized: Invalid or missing API key.

The Analytics and Insights endpoint provides detailed analytics on an individual's financial behavior.

Parameters:

• clientId (required): The unique ID of the individual.

Example Request:

curl -X GET 'https://api.reshscore.com/v1/analytics/12345' \
-H 'Authorization: Bearer YOUR_API_KEY'

Example Response:

{
  "clientId": "12345",
  "spendingAnalysis": {
    "totalSpent": 12000,
    "averageMonthlySpend": 1000
  },
  "savingAnalysis": {
    "totalSaved": 5000,
    "averageMonthlySavings": 500
  }
}

Error Codes:

• 404 Not Found: The clientId does not exist.
• 401 Unauthorized: Invalid or missing API key.