Versions Compared

Key

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

...

 

Name

Type

Description

name

String

The name of the check. For example, if a check against the Electoral Roll was attempted, then the name would be “AEC”. As each customer will accept a different set of checks, customers should refer to their individual rules document for the list of names that they can expect. Refer to Data Source Reference for a list of data source names.

state

String

The state of the individual check. For a list of possible states, please see the Reference Table of individual source states.

method

String

The method via which the check was carried out. This is an enumerated type, for a list of possible values, please see the Reference Table of Method Names.

resultDataStringThis field contains extra data that may be passed on from database checks, for example this field may contain XML for a specific check. This will be specific to an individual customer’s setup, by default it is not returned.
modeStringThe verification mode used for this specific check. This shows HOW the check was made. Please see the Reference Table of  of possible modes. This can be null which indicates that no mode was used.
dateVerifiedDateThe date that this particular check became verified (or null if the check is not verified).
fieldResultsRichFieldResult[]

List<RichFieldResult>

Only the fields that were successfully checked, or were changed, are returned. Any field that was not checked is not returned. Note that this may mean the array is empty.

postOfficeDataPostOfficeDataIf and only if the name of the RichCheckResult is “PostOffice” then this member will be present. Otherwise it will be null. This represents the raw data retrieved from Australia Post.

RichFieldResult

...