Imagin8 API Specification
Integration for Real time Intelligence

Obtain Full Contact Information on a consumer

API Specification


Unless specified as Optional, all parameters are mandatory
API Suite: Consumer Data
Purpose: Returns the consumers contact history
Web Service: ConsumerContact
Root URL: Live https://www.imagin8.co.za/api/json/individual/
Root URL: Sandbox https://www.imagin8.co.za/api/json/sandbox/individual/
Parameters Parameter Name Parameter Description
unameThe Imagin8 Username
passwordThe Imagin8 Password
appNameThe application name verified by Imagin8
clientRefThe Customer ID provided by Imagin8
IDNoThe ID number of the person being enquired
Call Example https://www.imagin8.co.za/api/json/sandbox/individual/ConsumerContact&IDNo=8312020031085&uname={Username}&password={Password} &appName={AppName} &clientRef={ClientRef}
Return Values The return type will be a JSON string containing the response. Along with the return will be a Transaction ID which you can quote to Imagin8 should you enquire about an issue on any of your requests.
Return Values Example
{"TransactionSuccessful":true,"IDNumber":"8312020031085","FirstName":"","LastName":"","Deceased":"N","Addresses":[{"AdrsLine1":"UNKNOW","AdrsLine2":"","AdrsLine3":"","AdrsLine4":"","PostalCode":"0000","AdrsType":"Residential","LastUpdated":"2018-05-08","CreatedDate":"2014-12-23"},{"AdrsLine1":"111","AdrsLine2":"DALSIG","AdrsLine3":"STELLENBOSCH","AdrsLine4":"","PostalCode":"7600","AdrsType":"Residential","LastUpdated":"2018-05-08","CreatedDate":"2016-06-21"},{"AdrsLine1":"10 MARS STREET","AdrsLine2":"MARS","AdrsLine3":"","AdrsLine4":"","PostalCode":"8777","AdrsType":"Residential","LastUpdated":"2018-05-08","CreatedDate":"2005-03-12"},{"AdrsLine1":"3 NEUTRON AVENUE","AdrsLine2":"TECHNO PARK","AdrsLine3":"STELLENBOSCH","AdrsLine4":"","PostalCode":"7600","AdrsType":"Residential","LastUpdated":"2018-05-08","CreatedDate":"2014-09-30"},{"AdrsLine1":"12 COLEY STREET","AdrsLine2":"KUILS RIVER","AdrsLine3":"KUILSRIVIER","AdrsLine4":"","PostalCode":"7580","AdrsType":"Residential","LastUpdated":"2018-05-01","CreatedDate":"2018-01-23"}],"TelephoneNumbers":[{"Telephone":"0727272727","TelephoneType":"Work","LastUpdated":"2017-09-12","CreatedDate":"2016-01-26"},{"Telephone":"0833838559","TelephoneType":"Work","LastUpdated":"2017-09-05","CreatedDate":"2017-08-29"},{"Telephone":"26774574738","TelephoneType":"Cell","LastUpdated":"2017-09-05","CreatedDate":"2017-08-29"},{"Telephone":"0543374302","TelephoneType":"Residential","LastUpdated":"2017-09-05","CreatedDate":"2017-08-29"},{"Telephone":"0718924429","TelephoneType":"Residential","LastUpdated":"2017-08-29","CreatedDate":"2017-08-22"}],"Employers":[{"BranchCode":"CS25145","EmpName":"CHURCHYARD AND UMPLEBY CONSTRUCTION","Occupation":"","LastUpdated":"2016-09-
7
05","CreatedDate":"2016-09-05"},{"BranchCode":"CS26326","EmpName":"BUILDERS WAREHOUSE","Occupation":"","LastUpdated":"2013-01-29","CreatedDate":"2013-01-29"},{"BranchCode":"CS05555","EmpName":"LATEST EMPLOYER","Occupation":"","LastUpdated":"2011-09-29","CreatedDate":"2011-09-29"},{"BranchCode":"CS05555","EmpName":"NEW EMPLOYER TORTEL","Occupation":"","LastUpdated":"2011-09-27","CreatedDate":"2011-09-27"},{"BranchCode":"CS05555","EmpName":"EMPLOYER E","Occupation":"","LastUpdated":"2011-09-13","CreatedDate":"2011-09-13"}],"TransactionID":25100,"NOTE":"You are in Sandbox Mode. Transaction may be simulated."}