Query by ID Number

Request

Returns all recorded traffic fines for a given South African national ID number or Foreign ID number.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

idNumberstringrequired

South African national ID number or Foreign ID number.

Example:"9710226013089"

typestring

Optional parameter to determine whether the ID you are searching with is local or foreing. Please note that foreign ID is not the same as a passport number. If left empty it will default to local

Enum:"local""foreign"

Example:"foreign"

curl -i -X POST \
  https://docs.amabills.co.za/_mock/openapi/v1/TrafficFine/ViewByIDnumber \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "idNumber": "9710226013089",
    "type": "local"
  }'

Responses

Traffic fine query by ID response.

Bodyapplication/json

successboolean

true = success, false = error.

idNumberstring or null

The ID number used in the query. null if the type was foreign

foreignIdstring or null

The foreign ID number that was used in the query. null if the type was local or type was empty

resultobject or null(QueryByIdNumberResult)

Query result. null when success is false.

errorobject or null(ErrorMessage)

Error details. null when success is true.

Response

{
  "success": true,
  "idNumber": "9710226013089",
  "result": {
    "infringements": [ … ],
    "hasFinesToPay": true,
    "netFinesAmnt": 560,
    "vendorFeeAmnt": 14,
    "grossAmnt": 574,
    "idNumber": "9710226013089"
  }
}