Start Eligibility | Credit Platform | Documentation

curl -X POST https://credit.aarthiklabs.com/api/v1/hybrid/business-loan/borrowers/borrower-example-001/journey/eligibility \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "bureau": {
    "type": "EXPERIAN",
    "data": {},
    "consentReference": "CONSENT-001"
  }
}'

{
  "request_id": "30000000-0000-4000-8000-000000000001",
  "correlation_id": "40000000-0000-4000-8000-000000000001",
  "timestamp": "2026-10-28T09:00:00Z",
  "data": {
    "journeyID": "10000000-0000-4000-8000-000000000001",
    "stage": "ELIGIBILITY",
    "attemptID": "20000000-0000-4000-8000-000000000001",
    "status": "PENDING",
    "expiresAt": "2026-10-29T09:00:00Z",
    "lenders": [
      {
        "lenderID": "business_bank",
        "lenderName": "Business Bank",
        "decision": "PENDING",
        "reasonCode": null,
        "retryable": false,
        "evaluatedAt": null,
        "expiresAt": null,
        "annualPercentageRate": null,
        "interestRate": null,
        "amountPrincipal": null,
        "offerTerm": null
      },
      {
        "lenderID": "growth_finance",
        "lenderName": "Growth Finance",
        "decision": "PENDING",
        "reasonCode": null,
        "retryable": false,
        "evaluatedAt": null,
        "expiresAt": null,
        "annualPercentageRate": null,
        "interestRate": null,
        "amountPrincipal": null,
        "offerTerm": null
      }
    ],
    "summary": {
      "total": 2,
      "eligible": 0,
      "ineligible": 0,
      "reviewRequired": 0,
      "error": 0,
      "skipped": 0,
      "pending": 2
    },
    "replayed": false
  },
  "error": null
}

Get an early view of the borrower’s eligibility before exploring credit offers. Share the financial information you have—Bureau, Banking, GST, or a combination—and Aarthik Labs begins an assessment with participating lending partners.

Each category’s data object is flexible, so you can share information in your existing JSON structure. The examples illustrate possible contents rather than a fixed set of financial fields.

Eligibility is optional and can be your first step or follow Dedupe. Keep the returned journey ID and use Fetch Eligibility Results to view the assessment and any indicative credit terms.

Authentication

AuthorizationBearer

Send Authorization: Bearer <PLATFORM_API_KEY> from a trusted back-end.

Path parameters

borrowerProviderIDstringRequired1-128 characters

Stable borrower identity from the partner system. Keep a 1:1 mapping between the borrower and borrowerProviderID across sessions and application attempts to preserve resume, history, and post-disbursal continuity.

Query parameters

journeyIDstringOptionalformat: "uuid"

Omit to create a journey. Supply the journeyID returned by Dedupe or Eligibility to continue the same borrower journey. Keep borrowerProviderID unchanged. An invalid, expired, unknown or unauthorized ID must not create a replacement journey.

Request

This endpoint expects an object.

bureauobjectOptional

Borrower-authorized bureau information. Retain the consent reference for the supplied report.

bankinglist of objectsOptional

gstlist of objectsOptional

Response

Eligibility operation accepted. Store data.journeyID, then call Fetch Eligibility Results. Polling guidance is returned by the Fetch Results API, not this response.

request_idstring

correlation_idstring

timestampdatetime

dataobject

errorany

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

424

Failed Dependency Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error