Bulk Person Verification of a CSV file

Description

---

A facility to bulk person verify a CSV file of people with fully qualified UK addresses

This method allows for the verification of a list of UK persons, in a CSV.

The data must be uploaded to T2A as a csv, containing at least these columns:

• surname and forename (or full name)
• Postcode
• Address Line 1

T2A will append to the CSV a single RESULT column. These are the possible values:-

Result Code	Explanation
FOUND	The person has been verified
FOUND_HIST	when a person has been validated against historic data (requires 'use_historic_data' setting to true when using the 'upload' command)
NOT_FOUND	The person was not found in our data
INVALID_POSTCODE	The supplied postcode was invalid
INVALID_ADDRESS	The supplied address was invalid
INSUFFICIENT_DATA	There was insufficient information to be able to validate the person

Historic Matches

If the 'use_historic_data' parameter is set to true during the upload command, an additional End Date column will be added to the result CSV on any historic matches.
The End Date contains the date that the record went historic, as YYYY-MM-DD.

Usage

---

This is an asynchronous method, requiring several stages in the operation.

1. Create a job (also known as a transaction). This is a unique item that will be used to upload, process and finally download your data. Create the job using the create command. Please note that this is a free method.
2. Upload your csv dataand specify the location of the above columns by using the upload command. This is free.
3. Start the process. It runs in the backgroumd.
4. Invoke the progress command to monitor the progress of T2A in processing your job. You may wish to display this as a progress bar or similar to your final users. The invocation of this method is normally from JavaScript.When the percentage figure has reached 100, the processing is complete,and you may proceed to the next stage.
5. When the process is completed, check the number of records found. This is free
6. If you wish to purchase the full result (i.e. the original csv, appended), invoke the finalise command which will prepare the data, deduct the necessary credits, and supply a download URL which can be used to obtain the purchased csv.

Commands

---

Introduction

The individual operations of this method are selected using the mandatory command parameter.

Command 'create'

Create a transaction (also known as a job) to be used for your upload, append and download. This is free.

Mandatory Parameters

Name	Description
api_key or javascript_key	Use your API key if invoking server-side. If invoking from the browser via JavaScript, generate a JavaScript key using the javascript_key method.
command	Must be set to create

Returned Values

The XML response is contained within a <person_verify_bulk_res> element.

Name	Description
status	Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code	Returns the error code when the status is error. See below for error codes.
transaction_id	The ID of the job created.
t2a_version_number	The current API version number.

Example XML Response

---

<?xml version="1.0"?>
<person_verify_bulk_res>
	<mode>normal</mode>
	<status>ok</status>
	<t2a_version_number>1.0.0</t2a_version_number>
	<transaction_id>wKVrW6dhYPMBEA0iQTuJ_u9YQx_L1fOvVqQ1AOboPS_U</transaction_id>
</person_verify_bulk_res> 

Command 'upload'

Upload your csv data to T2A.

Mandatory Parameters

Name	Description
api_key or javascript_key	Use your API key if invoking via server-side XML or SOAP. If using JSON, generate a JavaScript key using the javascript_key method.
command	Must be set to upload
transaction_id	The ID of the job, as created by create.
type	Must be set to res or bus to denote residential or business data. The data cannot be mixed.
csv_data	The csv data. If you are using the REST API, you will need to invoke this method as a POST.
is_first_line_headers	Set to Y if the first line of the CSV is the column headers.
use_historic_data	Set to true to match against previous addresses
surname_column	The column containing the surname, as a zero-based integer.
forename_column	The column containing the forename, as a zero-based integer.
address1_column	The column containing the first line of the address, as a zero-based integer.
address2_column	The column containing the second line of the address, as a zero-based integer.
address3_column	The column containing the third line of the address, as a zero-based integer.
postcode_column	The column containing the postcode, as a zero-based integer.

Returned Values

The XML response is contained within a <person_verify_bulk_res> element.

Name	Description
status	Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code	Returns the error code when the status is error. See below for error codes.
t2a_version_number	The current API version number.

Example XML Response

---

<?xml version="1.0"?>
<person_verify_bulk_res>
	<mode>normal</mode>
	<status>ok</status>
	<t2a_version_number>1.0.0</t2a_version_number>
	<transaction_id>wKVrW6dhYPMBEA0iQTuJ_u9YQx_L1fOvVqQ1AOboPS_U</transaction_id>
</person_verify_bulk_res> 

Command 'start'

Mandatory Parameters

Name	Description
api_key or javascript_key	Use your API key if invoking via server-side XML or SOAP. If using JSON, generate a JavaScript key using the javascript_key method.
command	Must be set to start
transaction_id	The ID of the job, as created by create

Returned Values

The XML response is contained within a <person_verify_bulk_res> element.

Name	Description
status	Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code	Returns the error code when the status is error. See below for error codes.
t2a_version_number	The current API version number.

Example XML Response

---

<?xml version="1.0"?>
<person_verify_bulk_res>
	<mode>normal</mode>
	<status>ok</status>
	<t2a_version_number>1.0.0</t2a_version_number>
	<transaction_id>wKVrW6dhYPMBEA0iQTuJ_u9YQx_L1fOvVqQ1AOboPS_U</transaction_id>
</person_verify_bulk_res> 

Command 'progress'

Read the progress of the background processing of the appending. This might often be invoked as a client-side (Javascript) returning JSON.

Mandatory Parameters

Name	Description
api_key or javascript_key	Use your API key if invoking via server-side XML or SOAP. If using JSON, generate a JavaScript key using the javascript_key method.
command	Must be set to progress
transaction_id	The ID of the job, as created by create.
output	Set to json if json is required.

Returned Values

The XML response is contained within a <person_verify_bulk_res> element.

Name	Description
status	Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code	Returns the error code when the status is error. See below for error codes.
t2a_version_number	The current API version number.
percentage	The progress. When "100" the job has finished processing and you may proceed to the next stage.

Example JSON Response

---

{
	"transaction_id":"5nTrnrVDj6Q83GKuq68IdqAQnFcKYKCnoKNsJSVLiRzY",
	"percentage":"45",
	"mode":"normal",
	"status":"ok",
	"t2a_version_number":"2.2.2.3"
}

Command 'results'

Read the progress of the background processing of the appending. This might often be invoked as a client-side (Javascript) returning JSON.

Mandatory Parameters

Name	Description
api_key or javascript_key	Use your API key if invoking via server-side XML or SOAP. If using JSON, generate a JavaScript key using the javascript_key method.
command	Must be set to results
transaction_id	The ID of the job, as created by create.

Returned Values

The XML response is contained within a <person_verify_bulk_res> element.

Name	Description
status	Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code	Returns the error code when the status is error. See below for error codes.
t2a_version_number	The current API version number.
total_found	The total number of rows that were able to be verified.

Example XML Response

---

<?xml version="1.0"?>
<?xmlversion="1.0"?>
	<person_verify_bulk_res>
	<mode>normal</mode>
	<status>ok</status>
	<t2a_version_number>3.1.0.6</t2a_version_number>
	<transaction_id>5nTrnrVDj6Q83GKuq68IdqAQnFcKYKCnoKNsJSVLiRzY</transaction_id>
	<total_found>183</total_found>
</person_verify_bulk_res> 

Command 'finalise'

Use this command to commit to purchase the processed results. Providing that you have sufficient T2A credits, the price is deducted from your balance, and you may then download the processed results.

This command can be safely re-invoked; it will only charge once.

The results include the URL by which the processed CSV may be downloaded.

Mandatory Parameters

Name	Description
api_key or javascript_key	Use your API key if invoking via server-side XML or SOAP. If using JSON, generate a JavaScript key using the javascript_key method.
command	Must be set to finalise
transaction_id	The ID of the job, as created by create.

Optional Parameters

Name	Description
output	Set to json for a JSON response; the default response is XML. Not applicable to the SOAP API.
callback	When using JSON, specify a JSONP wrapper in which the JSON response is to be wrapped.

Returned Values

The XML response is contained within a <person_verify_bulk_res> element.

Name	Description
status	Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code	Returns the error code when the status is error. See below for error codes.
t2a_version_number	The current API version number.
credit_used	The number of credits used in order to execute the request.
download_url	The full URL from which the processed CSV may now be downloaded.

Example XML Response

---

<?xml version="1.0"?>
<person_verify_bulk_res>
	<mode>normal</mode>
	<status>ok</status>
	<t2a_version_number>1.0.0</t2a_version_number>
	<transaction_id>wKVrW6dhYPMBEA0iQTuJ_u9YQx_L1fOvVqQ1AOboPS_U</transaction_id>
	<download_url>https://api.t2a.io/rest/rest.aspx?method=csv_download&amp;job_id=2Kp9vcVWLYoisqKdADJx__3bf1LmVKVKEs6s01qOvZzz</download_url>
</person_verify_bulk_res> 

Error Codes

---

See the common error codes. There are no errors which are specific to this method.