Credit Score Check

e-verify integrates with TransUnion to provide credit score checks, enabling businesses to assess the creditworthiness of individuals during onboarding or transaction processes. This helps in risk assessment and compliance with lending regulations.

Endpoint

POST /v1/credit/score

Request Body

Field	Type	Description	Required
id_number	string	The South African ID number of the individual.	Yes
consent	boolean	User consent for credit check. Must be true.	Yes

Example Request

POST /v1/credit/score HTTP/1.1
Host: api.e-verify.co.za
X-API-Key: ev_live_YOUR_API_KEY
Content-Type: application/json

{
  "id_number": "8001015009087",
  "consent": true
}

Response

{
  "request_id": "req_credit_1234567890",
  "status": "completed",
  "result": {
    "credit_score": 750,
    "score_band": "Excellent",
    "risk_factors": [
      "No recent credit activity"
    ],
    "overall_status": "success"
  },
  "message": "Credit score check completed successfully."
}

Error Codes

Code	Description
400	Invalid input data or missing consent
401	Unauthorized
403	Forbidden
404	ID number not found in credit bureau
500	Internal server error