Imagin8 API Specification
Integration for Real time Intelligence

Single AVS Enquiry Status Check

API Specification

Unless specified as Optional, all parameters are mandatory
API Suite: AVS-R
Purpose: Receive updated information on a previously submitted single AVS enquiry, or retrieve the result of a previously completed enquiry up to 14 days after the date initiated
Web Service: avs_checkJobId.php
Root URL: Live
Root URL: Sandbox
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
jobId The unique Job ID returned from avs_submitFile.php
Call Example
Return Values This will return the result of the specific Job ID in the format listed below.
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","AccountLenght":"Y","AccountTypeCorrect":"Y","IDNumberMatch":"Y","InitialsMatch":"Y","NameMatch":"Y","AccountDebitsAll":"Y","AccountCreditsAll":"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"}}}