Advanced Features

ReshScore offers the ability to generate custom reports tailored to your specific needs. These reports provide in-depth insights into credit behavior, risk analysis, and financial health indicators for individuals or businesses.

Steps to request a custom report:

1. Identify the data points: Choose the specific data points you want in the report (e.g., credit score trends, payment history, risk factors).
2. Submit your request: Use the custom report endpoint to submit a request with the relevant parameters:

POST /reports/custom
{
  "clientId": "123456",
  "reportType": "credit-risk",
  "parameters": {
    "startDate": "2024-01-01",
    "endDate": "2024-12-31"
  }
}

3. Receive the report: The API will generate and return the report in a downloadable format, such as PDF or CSV, depending on your request.

ReshScore's bulk scoring feature allows you to submit multiple requests at once, reducing the time it takes to process large datasets.

How to make a batch request:

1. Prepare a list of client IDs: Create a list of the clients or businesses you want to score.
2. Submit the batch request: Use the following API endpoint:

POST /credit-score/batch
{
  "clientIds": ["123456", "654321", "789012"]
}

3. Receive results: The API will return the credit scores for all the submitted clients in a single response, helping you efficiently manage bulk requests.

Best Practices:

• Limit the number of client IDs per batch to avoid timeouts.
• Use this feature when processing large volumes of data, such as during financial audits or portfolio analysis.

Webhooks enable your system to receive real-time updates from ReshScore when specific events occur, such as credit score changes or fraud alerts.

How to set up webhooks:

1. Register your webhook URL: Provide the URL where you want ReshScore to send updates.
2. Subscribe to events: Specify which events you want to subscribe to (e.g., credit-score-update, fraud-detection-alert).

Example of a webhook registration request:

POST /webhooks/register
{
  "url": "https://yourdomain.com/webhooks",
  "events": ["credit-score-update", "fraud-detection-alert"]
}

3. Handle incoming webhook notifications: Ensure your system is ready to handle the webhook payload, which will be delivered in real-time.

Example of a webhook payload:

{
  "event": "credit-score-update",
  "data": {
    "clientId": "123456",
    "newCreditScore": 780
  }
}

Best Practices:

• Secure your webhook endpoint with token-based authentication or IP whitelisting.
• Log webhook events for auditing purposes.
• Respond with a 200 OK status to confirm successful receipt of the webhook.

Errors may occur during API requests, and ReshScore provides meaningful error codes to help you troubleshoot issues.

Common error codes:

• 400 Bad Request: The request was invalid or malformed.
  • Solution: Check the request syntax and ensure that all required parameters are included.
• 401 Unauthorized: Authentication failed, either due to missing or invalid credentials.
  • Solution: Verify the API key or OAuth token in the request headers.
• 403 Forbidden: The request is authenticated, but the user does not have permission to access the resource.
  • Solution: Ensure the account has the necessary permissions for the requested resource.
• 404 Not Found: The requested resource does not exist.
  • Solution: Double-check the endpoint URL and resource identifiers.
• 429 Too Many Requests: You’ve exceeded the rate limits for API requests.
  • Solution: Implement retries with exponential backoff and review your usage limits.
• 500 Internal Server Error: An error occurred on ReshScore’s server.
  • Solution: Contact support if the issue persists.

Best Practices:

• Log all error responses for debugging purposes.
• Implement retries with backoff for transient errors like 429 or 500 errors.
• Ensure proper API versioning to avoid breaking changes.