...
Name | Type | Required? | Description |
|---|---|---|---|
customerId
| String 255 Chars | Yes
| This parameter is GreenID's identifier for the client application. The value is supplied by GreenID, and must be included with each registration request.
|
userId
| String 255 Chars | Yes
| This parameter is an identifier that the client uses for the individual being verified. GreenID does not use it as an identifier, but in order to easily locate individual's for a particular client application, the userIdis used. This must match a registered userId
|
Return Value
The return value is the complex type RichVerificationResult. This complex type is described below.
...
Member
...
Type
...
Description
...
Contract
...
userId
...
String
255 Chars
...
The unique ID for the user.
...
Not null.
...
outcome
...
String
255 Chars
...
This member indicates the outcome of the whole AML verification process. For a detailed description of what values are possible in this field, please see the Reference Table of Overall Outcome States.
...
Not null.
...
transactionId
...
String
20 Chars
...
This value should be ignored as it is only maintained for backwards compatibility reasons.
...
Not null.
...
ruleId
...
String
255 Chars
...
The identifier rule that was used to determine the outcome.
...
Not null.
...
mode
...
String
255 Chars
...
The verification mode used. This shows HOW the verification was made. Possible modes are POSTOFFICE, ASSISTED and EXTERNAL.
When a person is verified by filling out a Post Office form and visiting a post office with documentary evidence the mode is set to POSTOFFICE. When a person is verified and someone using the admin panel has visited a source on their behalf then the mode is ASSISTED. Finally EXTERNAL is only used for mode if a batch process run by a greenID admin is performed (on request from a customer organisation) results in a person becoming verified.
In all other cases the mode is null.
...
...
dateVerified
...
Date
...
The date that the user became verified.
...
...
individualResults
...
List<RichCheckResult>
...
This member gives the customer a list of the outcomes of each individual check that was attempted. Note that methods that were not attempted are not included.
...
Not null.
RichCheckResult
The complex type RichCheckResult has the structure described below:
...
Member
...
Type
...
Description
...
Contract
...
name
...
String
255 Chars
...
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.
...
Not null.
...
state
...
String
255 Chars
...
The state of the individual check. For a list of possible states, please see the Reference Table of individual source states.
...
Not null.
...
method
...
String
255 Chars
...
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.
...
...
resultData
...
String
No Char limit
...
This 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.
...
...
mode
...
String
255 Chars
...
The verification mode used for this specific check. This shows HOW the check was made. Please see the Reference Table of possible modes. This can be null which indicates that no mode was used.
...
...
dateVerified
...
Date
...
The date that this particular check became verified.
...
...
fieldResults
...
List<RichFieldResult>
...
Only the fields that were successful checked, or were changed, are returned. Any field that was not checked is not returned.
...
Not null. May be empty, though.
...
postOfficeData
...
...
If 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
The complex type RichFieldResult has the structure described below:
...