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

Credit Information

Retrieve a full credit report including account and payment history fields.

Request

POST/api/v1/credit-info
{{baseUrl}}/api/v1/credit-info
HeaderTypeDescription
AuthorizationstringBearer YOUR_ACCESS_TOKEN from the OAuth client-credentials flow
Content-Typestringapplication/json

Body Parameters

ParameterTypeDescriptionRequired
identity_numberstringIdentity number for the reportrequired
identity_typestringIdentity type code (default "001")optional
loan_amountnumberOptional loan amount contextoptional
report_reasonstringReason / purpose of the enquiryoptional

Response

200 OKSample dataExample response
{
  "success": true,
  "response_code": 200,
  "message": "Credit information fetched successfully",
  "data": {
    "identity_number": "1028845317",
    "accounts": [],
    "summary": { "open_accounts": 2, "closed_accounts": 1 }
  },
  "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

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.