Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

Name

Type

Description

stillWorking

boolean

This member indicates whether the check is still in progress.  This feature is still under development; currently the value is always false.

state

String

This member gives the current state of the check.  Refer to the Reference Table for Individual Source States for valid values.

SourceList

SourceListV2

 

Name

Type

Description

sources

List<Source>List<SourceV2>

Simply a list of Source objects.

Source

...

Name

Type

Description

fieldList

FieldList

This member contains a list of fields that are required for a particular data source.  The members of list represent HTML fields for collecting input from the person.

rawDataStringThis member contains an HTML fragment that, if displayed, will present HTML fields for collecting data from a person in order to perform a check against a data source.  Some customer may prefer this approach rather than generating their own HTML from the data contained in the fieldList member.

...

FieldListV2

Name

Type

Description

sourceField

List<Field>List<FieldV2>

This member simply contains a list of Field objects.

...

FieldV2

 

Name

Type

Description

type

String

The type of HTML input that is required (at least strongly suggested) for collecting the data for this field from the person.  For example, a value of “text” would indicate a simple HTML text input is appropriate.

name

String

The name of the HTML input that would collect data for this field from the person.  The name also indicates what the data field is, for example, the value “aec_givenname” indicates the field holds the given name for the AEC data source.

value

String

This member contains any pre-existing value for the HTML field.  For example, the Field with the name “aec_givenname” will be pre-populated with the person’s given name (derived from the person’s master record established during the call to the RegisterUser web method) the first time the GetFields method is called with the sourceId “aec”.

labelStringThis member contains label.  Please refer to the section on Labels.
selectItemList<NameValuePair> This member contains a list of item names and values for a select item Field.
attributeList<NameValuePair> This member contains a list of the names and values of any HTML attributes that this Field has.  For example, the attribute class=”required” would be represented by a NameValuePair with name=”class” and value=”required”.
orderInteger 

InputFields

Name

Type

Description

input

List<NameValuePair> 

This member contains a list of names and values that correspond to input parameters to the SetFields web method.  The names are expected to be those that have previously been returned from the GetFields method for a particular data source.  For example, a Visa number will be represented by a NameValuePairwith name=”visa_number” and value=”11111111”.

...

 

Name

Type

Description

day

int

The day component of a date of birth.

month

int

The month component of a date of birth.

year

int

The full year component of a date of birth, for example 1975, i.e. not 75.

RegistrationDetailsV2

Need a summary

NameTypeDescription
currentResidentialAddressAddress 
dateCreatedDateTime 
dobstring 
emailstring 
extraDataList<NameValuePair>  
homePhonestring 
mobilePhonestring 
nameName 
previousResidentialAddressAddress 
workPhonestring 

Address

NameTypeDescription
alleystring 
amalgamatedMunicipalitystring 
areaString 
avenueString 
blockString 
cantonString 
chomeString 
cityString 
countryString 
countyString 
deliveryNumberString 
departmentString 
directionString 
dispatchingInformationString 
districtString 
divisionFiveString 
divisionFourString 
divisionOneString 
divisionThreeString 
divisionTwoString 
flatNumberString 
levelString 
localityString 
locationString 
mailCentreString 
municipalityString 
neighbourhoodString 
organisationString 
parishString 
personNameString 
poBoxString 
postcodeString 
prefectureString 
propertyNameString 
provinceString 
quarterString 
regionString 
ruralAreaString 
ruralLocalityString 
sectorString 
sectorNumberString 
stateString 
streetNameString 
streetNumberString 
streetTypeString 
subdistrictString 
subregionString 
suburbString 
townString 
townCityString 
townshipString 
urbanLocalityString 
villageString 

Name

NameTypeDescription
givenNameString 
honorificString 
middleNamesString 
surnameString 

 

RichVerificationResult

The RichVerificationResult type describes the person’s verification results to date.  This is always returned so that the caller always has the latest results for that person.

...