Skip to main content
GET
/
v1
/
loans
/
{applicationId}
Get Loan
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId} \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "data": {
    "application_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "HAS_OFFER",
    "customer_id": "1732ca47-42b2-4990-a65d-c369e934eed3",
    "amount": 2000000,
    "repayment_period": 3,
    "loan_purpose": "INVENTORY_MGT",
    "offer_status": "PENDING",
    "loan_status": null,
    "decline_reasons": null
  }
}

​
Overview

Returns a single loan application. On every call the status is synced from the lending engine, so the status field always reflects the current state. Poll this endpoint after starting decisioning until status is HAS_OFFER.

​
Request

Method: GET
URL: /v1/loans/:applicationId

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
applicationIdPathstringYesApplication ID.

​
Response

​
200 OK

{
  "status": "success",
  "message": "Application fetched",
  "data": {
    "application_id": "aaaabbbb-cccc-dddd-eeee-ffffffffffff",
    "customer_id": "1732ca47-42b2-4990-a65d-c369e934eed3",
    "account_identifier": "PC_abc123xyz456def78901",
    "amount": 2000000,
    "repayment_period": 3,
    "loan_purpose": "INVENTORY_MGT",
    "status": "HAS_OFFER",
    "offer_status": "PENDING",
    "loan_status": null,
    "loan_id": null,
    "disbursement_account": null,
    "reference": "MERCH_REF_20250115_001",
    "created_at": "2025-01-15T10:10:00.000Z",
    "updated_at": "2025-01-15T10:30:00.000Z"
  }
}
FieldDescription
application_idYour reference for all subsequent loan operations
statusCurrent application status (see table in List Loans)
offer_statusOffer-level status from the lending engine
loan_statusActive loan status — populated after disbursement
loan_idLoan ID — populated after disbursement. Used for repayment routes.
disbursement_accountJSONB — set after POST /disbursement-account

​
Error Responses

StatusMessageCause
400Application not foundInvalid applicationId

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
applicationId
string
required

Response

200 - application/json

Successful response

The response is of type object.