Peleza β€” Trust built on data
πŸ‡°πŸ‡ͺ Credit Risk
On this page

Credit Risk β€” Status

Poll assessment progress with the unique_id from POST /api/v1/credit-risk/assess. Not billed. When completed=true, call GET /api/v1/credit-risk/results/{unique_id}.

Request

GET/api/v1/credit-risk/status/{unique_id}
{{baseUrl}}/api/v1/credit-risk/status/{unique_id}
HeaderTypeDescription
AuthorizationstringBearer YOUR_ACCESS_TOKEN from the OAuth client-credentials flow
Content-Typestringapplication/json

In progress

Expected response for In progress:

200 OKSample dataExpected response
{
  "success": true,
  "response_code": 200,
  "message": "Analysis in progress",
  "data": {
    "unique_id": "cra-doc-abc123",
    "document_type": "BANK",
    "state_name": "UPLOADED",
    "completed": false,
    "failed": false
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Complete

Expected response for Complete:

200 OKSample dataExpected response
{
  "success": true,
  "response_code": 200,
  "message": "Analysis complete",
  "data": {
    "unique_id": "cra-doc-abc123",
    "document_type": "BANK",
    "state_name": "COMPLETED",
    "completed": true,
    "failed": false
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Failed

Expected response for Failed:

200 OKSample dataExpected response
{
  "success": true,
  "response_code": 200,
  "message": "Assessment failed",
  "data": {
    "unique_id": "cra-doc-abc123",
    "document_type": "BANK",
    "state_name": "REJECTED",
    "completed": false,
    "failed": true
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

FieldTypeDescription
successbooleanWhether the request succeeded
response_codenumberApplication response code (typically mirrors HTTP)
messagestringHuman-readable status message
dataobjectPayload for the verified resource
request_idstringUUID for support and audit trails
data.unique_idstringDocument unique id from assess
data.document_typestringMPESA or BANK
data.state_namestringCurrent processing state
data.completedbooleantrue when analysis is ready
data.failedbooleantrue on terminal failure

Error codes

Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.

CodeWhenBilled?
200Status returned (in progress, complete, or failed)No
400Invalid unique idNo
401Missing or invalid Bearer tokenNo
404Assessment not found for this tenantNo

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.