API Reference

The Fincore API provides programmatic access to the full functionality of the platform. Use it to integrate Fincore with your existing systems or build custom applications.

Authentication

All API requests must be authenticated using API keys. You can generate API keys in the Fincore administration panel.

API Keys

API keys should be included in the Authorization header of all requests using the Bearer token format.

Example Request

1
2
3
curl -X GET "https://api.fincore.com/v1/clients" \
  -H "Authorization: Bearer YOUR_API_KEY"

bash

Security Warning

Keep your API keys secure and never expose them in client-side code. Rotate your keys regularly and use different keys for development and production environments.

Base URL

All API requests should be made to the following base URL:

https://api.fincore.com/v1/

Available Endpoints

The Fincore API provides endpoints for all major objects in the system. Click through to explore detailed documentation for each endpoint.

Client API

Create, update, and retrieve client data including KYC information.

View Documentation

Loan API

Manage loan applications, approvals, disbursements, and repayments.

View Documentation

Payment API

Process payments, create payment links, and manage disbursements.

View Documentation

Webhooks

Configure webhook endpoints to receive real-time notifications about events in your Fincore account.

View Documentation

Rate Limits

To ensure the stability of the API, rate limits are applied to all requests. The current limits are:

100 requests per minute for most endpoints
10 requests per minute for report generation endpoints

If you exceed the rate limits, you will receive a 429 Too Many Requests response. The response will include X-RateLimit-Limit and X-RateLimit-Remaining headers.

Error Handling

The API uses standard HTTP response codes to indicate the success or failure of a request. In general:

2xx: Success
4xx: Error caused by the client (e.g., invalid parameters)
5xx: Error on the server side

Error Response Format

Error responses include a JSON object with error details:

Error Response Example

1
2
3
4
5
6
7
8
9
10
11
12
{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid",
    "details": [
      {
        "field": "amount",
        "message": "Amount must be greater than zero"
      }
    ]
  }
}

json

Pagination

For endpoints that return lists of objects, the API supports pagination using the limit and offset query parameters.

Pagination Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Request
GET /v1/clients?limit=10&offset=20

// Response
{
  "data": [
    // 10 client objects
  ],
  "meta": {
    "total": 135,
    "limit": 10,
    "offset": 20
  }
}

javascript

API Versioning

The API version is specified in the URL path. The current version is v1. Breaking changes will only be introduced in new API versions, ensuring backward compatibility.

Client Libraries

We provide official client libraries for several programming languages: