Imagin8 API Specification
Integration for Real time Intelligence

Single AVS Enquiry

API Specification


Unless specified as Optional, all parameters are mandatory
API Suite: AVS-R
Purpose: Conduct a single Account Verification check on a specific customer
Web Service: avs_submitFile.php
Root URL: Live https://www.imagin8.co.za/webservices/valid8/AVS
Root URL: Sandbox https://www.imagin8.co.za/webservices/valid8/Sandbox/AVS
Parameters Parameter Name Parameter Description
uname The Imagin8 Username
password The Imagin8 Password
appName The application name, verified by Imagin8
clientRef The Customer ID provided by Imagin8
branch The branch code of account to be checked
account The account number to be checked
initials (Optional)The initials of the account holder, should be blank if business.
typeThe type of account
  • Current/Cheque = 1
  • Savings = 2
  • Transmission = 3
  • Bond = 4
  • Credit Card = 5
  • Subscription Share = 6
  • Not Known = 0
idNo The ID number of the account holder or the Business Registration number. (Remove / from Business Registration Numbers. Maximum of 13 characters allowed.)
lastname The last name of account holder or the business name. (Maximum of 60 characters allowed. Anything after 60 characters will be removed. Characters include whitespaces.)
phone (Optional)Validate the account holders phone number against his account.
Call Example https://www.imagin8.co.za/webservices/valid8/AVS/avs_submitFile.php?uname=yourusername&password=yourpassword&appName=yourapp&clientRef=yourRef&branch=250655&account=123456789&type=1&idNo=123456789123&initials=J&lastname=Doe&phone=0821234567
Return Values

Results are not necessarily returned immediately. The 3rd Party Application may be required to initiate a job using this function, and then poll the avs_checkJobId.php web service to check on the status of the job.

This function will return a result set as indicated below in JSON.

The Job ID will always be returned. This Job ID is the unique identifier for this enquiry, and can be used to check the status of the enquiry, or to return the retrieved result at no additional charge up to 14 days after the date of the transaction initiation.

If only the Job ID is returned, the enquiry is still pending from the banks.

If the full result set is returned, the query completed, and the results will be in for following format:

Return Values Example

If the job is complete:

{"result":1,"Response":{"Transaction":{"TransactionCompleted":true,"StatusCode":"D","BranchCode":"250655","AccountNumber":"*******6789","BankAccountType":"Current\/Cheque Account","ClientID":"123456*******","LastName":"Doe","AccountFound":"Y","AccountOpen":"Y","AccountLength":"Y","AccountTypeCorrect":"Y","IDNumberMatch":"Y","InitialsMatch":"Y","NameMatch":"Y","AccountDebitsAll":"Y","AccountCreditsAll":"Y","PhoneMatch":"Y","AllRecordsPassed":"Y","TransactionsID":"7199","JobID":"7199","FirstResponse":"00001"}}}

If the job is incomplete:

{"result":1,"Response":{"Transaction":{"TransactionCompleted":true,"StatusCode":"P","Message":"The server is still busy processing your request.","JobID":"7199"}}}