Sample Code Introduction
Sample code
Due to the nature of integrations and the complexities of how they differ from customer to customer we generally talk in terms of XML request and responses via SOAP. This is a platform independent way of us giving you the support you might need.
Please see here for Sample code examples
XML
Do you have Sample XML Request and Responses?
We have developed various XML requests and responses as we are conscious that these not only speed up integration time, but can aid in troubleshooting the way that you send data to the ID3global webservice.
Structre of a SOAP request: _________________STRUCTURE __________________ </soapenv:Envelope> <soapenv:Header> This section is where the credentials are passed. </soapenv:Header><soapenv:Body> This is where the content is passed. </soapenv:Body></soapenv:Envelope> _________________STRUCTURE __________________
Please note: Credentials are to be passed via the SOAP header, however ASMX passes credentials as a parameter in the method call.
Main Methods
What Methods can be Invoked?
Although there are a large number of methods available through the ID3global API, there are a small number of main methods that are generally used for the majority of customers.
At the simplest level a ID3global integration can be done using just one method of the ID3global web service, which is known as Authenticate SP (single profile).
This section will provide an overview of the main methods and what these do and provide information on parameters and data returned. Below are descriptions of the main methods that can be implemented on ID3global. A full break down of the available web methods are documented in the Web Service Development Guide below or directly from the WSDL.
Main Methods
This section provides detail on our main methods.
Check Credentials (Login)
This is the main method that is invoked to check that you have valid credentials for the ID3global. It is advised that this is the first method that is invoked during integration as this will allow you to not only test your connection to ID3global, but also check the credentials that you use are correct moving forward. This method requires the following parameters.
Parameters:
Username: This is the username that is associated with your Pilot or Live account. These are separate platforms and as such require separate accounts, although they are often use the same username.
Password: This is the password that is associated with your particular Pilot or Live account.
Return: On submission of successful credentials the method returns an array of information including: Organisation ID, Organisation Name, Account ID, Name, Username, Domain Name, Email and details on account status
Address Lookup
This is the method used to perform an address lookup. The Address Lookup method is designed to make filling out the address elements on an application form quick and easy. This is a very simple method that not only improves the efficiency and accuracy of data input but consequently improves the customer journey.
Parameters:
Partial Information:This method performs an address lookup based on partial address information. This partial information required is country specific, the UK for example requires the fields Country and Postcode.
International Address Lookup requires the Building number or name, first 3 characters of the Street and Postcode or City/Town to perform an address lookup.
Return: Address lookup returns a list (array) of addresses that match the information provided. The address data is sourced directly from the Royal Mail (for the UK) and other data sources (for international) it is then cleaned and formatted.
Authenticate SP (Single Profile)
This is the main method that is invoked to send customer data to ID3global to be authenticated. The Authenticate SP method is designed to take customer data and perform the necessary database/document checks dictated by the ID3global profile that has been configured. All the information that is sent to be authenticated is included within this method call as well as the following parameters.
Parameters:
Profile ID Version: Every profile has an associated unique ID that allows the Authenticate SP method to identify the profile and run authentications against it.
Version: The number allows you to choose a particular version of a profile, by entering 0 (zero) the system will by default, use the latest available effective version.
Customer Reference: This is an optional field that allows a reference number to be attached to an authentication. This is not required to be unique, however many customers append a customer id or unique username so that individual transactions can be found at a later date in the audit trail.
Return: The Verification method returns an ID3global results array. But a simple integrated solution will only need to look at the returned decision band text e.g. “PASS”, “REFER” or “ALERT”