Vehicle Ownership

LIVE

https://www.imagin8.co.za/api/json/individual/VehicleOwnership

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/individual/VehicleOwnership


Return the list of vehicles registered to an individual's ID number.

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
IDNo string Query Param required The ID Number of the indvidual being enquired

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/individual/VehicleOwnership?IDNo=6611095010086'

Response

{
    "IDNumber": "6611095010086",
    "Vehicles": [
        {
            "Make": "AUDI",
            "Model": "AU 21X-A1",
            "RegNo": "BL54BWGP",
            "VIN": "WAUZZZ8X7BB090318",
            "EngineNo": "CBZ396939",
            "DeptRegisterNo": "DRW522K"
        },
        {
            "Make": "AUDI",
            "Model": "AU 48X - A5 CABRIO",
            "RegNo": "FD82VLGP",
            "VIN": "WAUZZZ8F4DN012653",
            "EngineNo": "CDN328068",
            "DeptRegisterNo": "FMR136K"
        },
        {
            "Make": "LAND ROVER",
            "Model": "RANGE ROVER EVOQUE",
            "RegNo": "XANGELXGP",
            "VIN": "SALVA2AD8CH638401",
            "EngineNo": "DZ784050192224DT",
            "DeptRegisterNo": "PYH885W"
        },
        {
            "Make": "ALFA",
            "Model": "MITO",
            "RegNo": "ZGX651GP",
            "VIN": "ZAR95500001074564",
            "EngineNo": "199A00001460458",
            "DeptRegisterNo": "MMG946W"
        }
    ],
    "TransactionID": 85435,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

VIN Reg Check

LIVE

https://www.imagin8.co.za/api/json/vehicle/VinRegCheck

SANDBOX

https://www.imagin8.co.za/api/json/vehicle/VinRegCheck


Lookup a vehicle using the VIN or Registration number.

NOTE: The VIN feature is currently not enabled and vehicles can only be retrieved using the registration number.

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Lookup string Query Param required Accepted Params : reg (Registration Number), vin (Vin Number)
VINReg string Query Param required The VIN/Registration number of the vehicle being enquired
Year string Query Param required The year model of the vehicle being enquired.
Options string Query Param optional A json string containing any of the following to further filter the list returned if any (make, derivative, engine, transmission, body)

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/vehicle/VinRegCheck?Lookup=reg&VINReg=CA332419&Year=2010&Options={"make":"RENAULT","derivative":"CLIO IV"}'

Response

{
    "TransactionSuccessful": true,
    "Data": {
        "Make": "VOLKSWAGEN",
        "Registration": "CA714325",
        "VIN": "",
        "Year": 2011,
        "RegistrationYear": 0,
        "Region": "Unknown",
        "VehiclesFound": 8,
        "PossibleModels": [
            {
                "Model": "POLO VIVO 1.4 (32010 - 82014)",
                "VehicleCode": "64020500",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 3Dr (32010 - 32014)",
                "VehicleCode": "64020050",
                "IntroYear": 32010,
                "DisconYear": 32014
            },
            {
                "Model": "POLO VIVO 1.4 5Dr (32010 - 82014)",
                "VehicleCode": "64020100",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 BLUELINE 5Dr (42011 - 82014)",
                "VehicleCode": "64020105",
                "IntroYear": 42011,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE (32010 - 82014)",
                "VehicleCode": "64020510",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE 5Dr (32010 - 82014)",
                "VehicleCode": "64020110",
                "IntroYear": 32010,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE TIP (42011 - 82014)",
                "VehicleCode": "64020520",
                "IntroYear": 42011,
                "DisconYear": 82014
            },
            {
                "Model": "POLO VIVO 1.4 TRENDLINE TIP 5DR (42011 - 82014)",
                "VehicleCode": "64020120",
                "IntroYear": 42011,
                "DisconYear": 82014
            }
        ]
    }
}

Get Vehicle Data

LIVE

https://www.imagin8.co.za/api/json/vehicle/GetVehicleData

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/vehicle/GetVehicleData


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Lookup string Query Param required Accepted: VIN, Reg - Specifies the lookup type.
VINReg string Query Param required The VIN or Registration number of the vehicle.
Year int Query Param optional The year model of the vehicle. Passing this will allow the system to populate a list of possible models.

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/vehicle/GetVehicleData?Lookup=reg&VINReg=CA332419&Year=2010'

Response

{
    "TransactionSuccessful": true,
    "VehicleData": {
        "RegistrationNumber": "CA332419",
        "RegisterNumber": "VJT240W",
        "LicenseExpiry": "2018-10-31",
        "VINNumber": "AFAPXXMJ2PER28331",
        "EngineNumber": "SA2KPER28331",
        "Make": "FORD",
        "Model": "RANGER",
        "Year": "2010",
        "PossibleModels": [
            {
                "Model": "RANGER 2.2i LWB P/U S/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032121"
            },
            {
                "Model": "RANGER 2.5 TD 4X4 + P/U S/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032211"
            },
            {
                "Model": "RANGER 2.5 TD 4X4 P/U S/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032201"
            },
            {
                "Model": "RANGER 2.5 TD Hi - TRAIL P/U D/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032251"
            },
            {
                "Model": "RANGER 2.5 TD Hi -TRAIL P/U SUP/CAB",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032231"
            },
            {
                "Model": "RANGER 2.5 TD XLT 4X4 P/U D/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032291"
            },
            {
                "Model": "RANGER 2.5D LWB P/U S/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032161"
            },
            {
                "Model": "RANGER 2.5TD 4X4 + P/U D/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032271"
            },
            {
                "Model": "RANGER 2.5TD Hi -TRAIL XL P/U S/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032181"
            },
            {
                "Model": "RANGER 3.0TDCi  WILDTRAK P/U D/C",
                "IntroYear": "52010",
                "DisconYear": "62012",
                "MMCode": "22032372"
            },
            {
                "Model": "RANGER 3.0TDCi  XLT Hi-TRAIL SUP/CAB A/T",
                "IntroYear": "82010",
                "DisconYear": "62012",
                "MMCode": "22032333"
            },
            {
                "Model": "RANGER 3.0TDCi Hi -TRAIL XLE A/T P/U D/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032381"
            },
            {
                "Model": "RANGER 3.0TDCi Hi -TRAIL XLE P/U D/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032371"
            },
            {
                "Model": "RANGER 3.0TDCi WILDTRAK 4X4 P/U D/C",
                "IntroYear": "52010",
                "DisconYear": "62012",
                "MMCode": "22032392"
            },
            {
                "Model": "RANGER 3.0TDCi XLE 4X4 A/T P/U D/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032401"
            },
            {
                "Model": "RANGER 3.0TDCi XLE 4X4 P/U D/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032391"
            },
            {
                "Model": "RANGER 3.0TDCi XLT 4X4 P/U SUP/CAB",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032351"
            },
            {
                "Model": "RANGER 3.0TDCi XLT Hi -TRAIL P/U S/C",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032311"
            },
            {
                "Model": "RANGER 3.0TDCi XLT Hi -TRAIL P/U SUP/CAB",
                "IntroYear": "82009",
                "DisconYear": "62012",
                "MMCode": "22032331"
            }
        ]
    },
    "TransactionID": 1868577,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Check Balance

LIVE

https://www.imagin8.co.za/api/json/sms/CheckBalance

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/CheckBalance


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/CheckBalance'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 1280,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Check Message Status

LIVE

https://www.imagin8.co.za/api/json/sms/CheckMessageStatus

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/CheckMessageStatus


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
msg_id int Query Param required The Message ID passed back after sending a message

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/CheckMessageStatus?msg_id=69682389'

Response

{
    "TransactionSuccessful": true,
    "MessageID": 69682389,
    "Status": "DELIVRD",
    "Code": 101,
    "DateTime": "2019-07-17 12:04:27",
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Send Single

LIVE

https://www.imagin8.co.za/api/json/sms/Send

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/Send


No Description...

Request   POST

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Content-Type string Header Required Body should be posted as JSON

Request


$ curl -X POST -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -H "Content-Type: application/json" -d 
'{ "payload": { "number":"0831234567", "msg":"Testing API V2", "return_to":"support@imagin8.co.za", "schedule":"2018-12-12T13:30:00", "ref": "My Reference" } } 'https://www.imagin8.co.za/api/json/sandbox/sms/Send'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 360,
    "MessageID": 6901885,
    "MessagesSent": 1,
    "ReturnTo": "support@imagin8.co.za",
    "Reference": "My Reference",
    "SendShedule": "2018-12-12 13:30:00",
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Send Batch

LIVE

https://www.imagin8.co.za/api/json/sms/SendBatch

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/SendBatch


No Description...

Request   POST

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
Content-Type string Header Required Body should be posted as JSON

Request


$ curl -X POST -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -H "Content-Type: application/json" -d 
'{ "payload": [ { "number": "0831234567", "msg": "Simple API Test Message", "return_to": "support@imagin8.co.za", "ref": "My Reference 1" }, { "number": "0837654321", "msg": "API Test Message for Recipient 2", "return_to": "support@imagin8.co.za", "ref": "My Reference 2" } ] } 'https://www.imagin8.co.za/api/json/sandbox/sms/SendBatch'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 230,
    "Attempts": 2,
    "FailedPreCondition": 0,
    "Batch": [
        {
            "MessageID": 4742835,
            "MessagesSent": 1,
            "ReturnTo": "support@imagin8.co.za",
            "Reference": "My Reference 1",
            "SendShedule": "2019-07-18 09:31:13"
        },
        {
            "MessageID": 7484898,
            "MessagesSent": 1,
            "ReturnTo": "support@imagin8.co.za",
            "Reference": "My Reference 2",
            "SendShedule": "2019-07-18 09:31:13"
        }
    ],
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Check Balance

LIVE

https://www.imagin8.co.za/api/json/sms/R2CheckBalance

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckBalance


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckBalance'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 0,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Check Message Status

LIVE

https://www.imagin8.co.za/api/json/sms/R2CheckMessageStatus

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckMessageStatus


No Description...

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
msg_id string Query Param required The Message ID passed back after sending a message

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/sms/R2CheckMessageStatus?msg_id=738299063438413824'

Response

{
    "TransactionSuccessful": true,
    "MessageID": 738283883245604864,
    "Status": "DELIVRD",
    "Code": 101,
    "DateTime": "2019-07-31 06:36:34",
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Send

LIVE

https://www.imagin8.co.za/api/json/sms/R2Send

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2Send


No Description...

Request   POST

Parameter Type Position # Description
Content-Type string Header Required application/json
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X POST -H "Content-Type: application/json" -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -d 
'{ "payload": { "number":"0794738299", "msg":"Testing API V2" } } 'https://www.imagin8.co.za/api/json/sandbox/sms/R2Send'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 962,
    "MessageID": 7993697,
    "MessagesSent": 1,
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

R2 Send Batch

LIVE

https://www.imagin8.co.za/api/json/sms/R2SendBatch

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/sms/R2SendBatch


No Description...

Request   POST

Parameter Type Position # Description
Content-Type string Header Required application/json
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8 Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=

Request


$ curl -X POST -H "Content-Type: application/json" -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=" -d 
'{ "payload": [ { "number": "0845039405", "msg": "Simple API Test Message for Recipient 1" }, { "number": "0794738299", "msg": "API Test Message for Recipient 2" } ] } 'https://www.imagin8.co.za/api/json/sandbox/sms/R2SendBatch'

Response

{
    "TransactionSuccessful": true,
    "RemainingCredits": 400,
    "Attempts": 2,
    "FailedPreCondition": 0,
    "Batch": [
        {
            "MessageID": 5167503,
            "MessagesSent": 1,
            "CellNumber": "27845039405"
        },
        {
            "MessageID": 2014432,
            "MessagesSent": 1,
            "CellNumber": "27794738299"
        }
    ],
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}

Search Fines

LIVE

https://www.imagin8.co.za/api/json/fines/SearchFines

SANDBOX

https://www.imagin8.co.za/api/json/sandbox/fines/SearchFines


Retrieves fines based on search input

Request   GET

Parameter Type Position # Description
Authorization string Header Required Base64 Encoded GUID:CustomerID. GUID and Customer ID is supplied by Imagin8

Example: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI=
search_arg string Query Param required The search string that is used to find the fine
type int Query Param required The type of lookup:
1 - Full Search (Response is slower)
2 - ID Number Search
3 - Infringement Number Search
4 - License Number Search

Request


$ curl -X GET -H "Authorization: Basic QkQ1MERGNUUhNDJCQS00NjoGLUFC4jItN0EzQjg3ODkwMzk0OjI0NDI="
'https://www.imagin8.co.za/api/json/sandbox/fines/SearchFines?search_arg=8209147250087&type=2'

Response

{
    "TransactionSuccessful": true,
    "TotalFound": 1,
    "Fines": {
        "infringement_details": {
            "infringement_no": "27466583993773",
            "street_name": "RILEY ROAD",
            "suburb": "BEDFORTVIEW",
            "city_town": "JOHANNESBURG",
            "charge_code": "4528",
            "act_description": "Sect. 59(4)(b)",
            "description": "Operated a vehicle at a speed of 131-135 km/h which is in excess of the speed limit of 120 km/h as was indicated in the prescribed manner on a road traffic sign",
            "index_group": "Speed limits",
            "infringement_status": "Enforcement Order",
            "issuing_authority": "JMPD",
            "infringement_date": "2019-03-29",
            "infringement_time": "18:29:01",
            "capture_date": "2019-04-12",
            "infringement_status_updated": "2019-10-02",
            "infringement_total": 1830
        },
        "infringer_details": {
            "id_type": "RSA ID document",
            "infringer_type": "Male",
            "infringer_id": "8209147250087",
            "infringer_name": "DOE, J",
            "street_address_1": "80 STRAND STREET",
            "street_address_2": "CAPE TOWN",
            "street_address_3": "CAPE TOWN",
            "street_address_4": "",
            "street_address_5": "CAPE TOWN",
            "street_postal_code": "8001",
            "postal_address_1": "",
            "postal_address_2": "",
            "postal_address_3": "",
            "postal_address_4": "",
            "postal_address_5": "",
            "postal_code": "",
            "home_telephone": "0113342621",
            "work_telephone": "0113342621",
            "fax_number": "",
            "cell_number": "0835581655",
            "email_address": ""
        },
        "vehicle_details": {
            "register_no": "XFR728R",
            "license_no": "AB12CDGP",
            "make": "VOLVO",
            "model": "1880",
            "series": "V40",
            "color": "BLACK"
        },
        "status_history": [
            {
                "infringement_status": "Infringement notice",
                "date_changed": "2019-05-29",
                "total": 375
            },
            {
                "infringement_status": "Courtesy letter",
                "date_changed": "2019-08-29",
                "total": 675
            },
            {
                "infringement_status": "Enforcement order",
                "date_changed": "2019-10-02",
                "total": 1830
            }
        ]
    },
    "NOTE": "You are in Sandbox Mode. Transaction may be simulated."
}