Getting Started

Before using ReshScore's Credit Scoring API, make sure you have the following:

• API Key: You'll need an API key to access the endpoints. You can obtain this by creating an account on our platform.
• Basic Understanding of HTTP: Familiarity with making HTTP requests (GET, POST) and reading JSON responses is essential.
• Programming Knowledge: Experience with any programming language that can handle HTTP requests will be helpful (e.g., JavaScript, Python).
• API Documentation: Review our API documentation to understand the available endpoints and their functionalities.

To access the ReshScore API, follow these steps:

1. Sign Up: Visit our platform and sign up for an account.
2. Request API Access: After signing up, navigate to the 'API' section of your dashboard.
3. Generate an API Key: Click 'Generate API Key' to create your unique key for accessing the endpoints.
4. Select a Plan: Choose the API plan that suits your needs (free, premium, enterprise).

Your API key will be required for every request you make to the ReshScore API. Keep it secure and do not share it publicly.

ReshScore offers two ways to authenticate with the API:

1. API Key Authentication:

• When making a request, include your API key in the header:

Authorization: Bearer YOUR_API_KEY

2. OAuth2 Authentication:

• ReshScore also supports OAuth2 for more secure access. You'll need to follow these steps to authenticate using OAuth2:
  • Obtain a client ID and secret from your ReshScore dashboard.
  • Make a request to the token endpoint to receive an access token.
  • Use the token in your API calls in the same way as the API key:

Authorization: Bearer ACCESS_TOKEN

Once you've obtained your API key, you're ready to make your first API call.

Here’s a basic example of how to make a GET request to retrieve a credit score for a specific user:

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

The response will look like this:

{
  "userId": "123456",
  "creditScore": 750,
  "creditStatus": "Good"
}

You can use libraries like axios in JavaScript or requests in Python to handle these API calls within your code.

ReshScore provides a sandbox environment where you can test your integrations before going live.

• How to Access the Sandbox: In your dashboard, navigate to the 'Sandbox' tab and obtain your sandbox API key.
• Testing Your Calls: The sandbox mimics live environment responses but does not affect real user data.

Example request in the sandbox environment:

curl -X GET 'https://sandbox-api.reshscore.com/v1/credit-score/{userId}' \
-H 'Authorization: Bearer YOUR_SANDBOX_API_KEY'

We recommend testing all your API calls in the sandbox before using the live environment.