...
Member | Type | Description | Contract |
|---|---|---|---|
name
| String 255 Chars | The name of the field. The possible name will depend on the source used. Again which sources used will depend on the individual customer setup, and new sources, with potentially new fields are constantly being added. For a list of possible field names for each source, please refer to the Data Source Reference tables. | Not null.
|
status
| String 255 Chars | This member describes the status of the field. For a complete list of possible status values, please refer to Appendix Fto Field Status.
| Not null.
|
dataDifference
| String No Char limit | This member will contain changed values. That is, if a value was changed in order to become verified, then this member will contain the value that was the data was changed to, and subsequently verified.
|
|
data
| String No Char limit | This contains the original data that was supplied at time of registration. In the case of a status of ADDITION (see Appendix Fsee Field Status) then this will hold the added data.
|
|
dataInfo
| String 255 Chars | This contains information about the data. At this time it contains either “previousAddress” or “currentAddress” to indicate which address this data was checked as. |
|
label
| String No Char limit | This field represents a human readable version of name, it will reflect what the user may see on the screen when they fill the details in. The data in this field is designed for reporting purposes and can change without notice. |
|
format
| String 255 Chars | Indicates the format of the data in the field. “plain” indicates a plain text field. This may differ depending on the customer’s individual setup. |
|
...
| State Name | Meaning | Human Readable Name |
|---|---|---|
| VERIFIED | The user has been verified against the given rule set. | Verified |
| VERIFIED_ADMIN | The user was manually verified by an administrator through the admin panel. | Verified (by admin) |
| VERIFIED_WITH_CHANGES | The user was verified against the given rule set, however some minor changes were made to the data in order to get the result. These changes are included in the rule set as acceptable changes. | Verified with changes |
| IN_PROGRESS | The user has not yet been verified, as GreenID allows further checks to be performed at any time this can be considered as not yet meeting the rule set requirements for verification. | In progress |
| PENDING | The user has been verified against the rule set, but to do so they changed data in a way that is not considered acceptable without further action. | Pending review |
| LOCKED_OUT | The user has been locked out completely. This will occur depending on the customer lock out rules. By default there are no lock out rules. | Locked out |
Possible Modes
Mode name | Meaning | Human readable name |
|---|---|---|
POSTOFFICE | The user was verified by filling out a Post Office form and visiting a post office with documentary evidence. | Post Office |
ASSISTED | The user was verified by an administrator loggin into the admin panel and entering the data on behalf of the user. This method still contacts the third party data sources to confirm the entered data. | Admin assisted |
EXTERNAL | This mode is used to indicate that verification was carried out outside of the GreenID system. | Externally Verified |
Individual Source States
State name | Meaning | Human readable name |
|---|---|---|
VERIFIED | The users data has been verified against this source | Verified |
VERIFIED_ADMIN | The details for this source were manually verified by an administrator through the admin panel. | Verified (by admin) |
VERIFIED_WITH_CHANGES | The user was verified against this source, however some minor changes were made to the data in order to get the result. These changes are included in the rule set as acceptable changes. | Verified with changes |
PASSED | This state is specific to the watchlist checks. If a problem was NOT found on a watchlist check then they are considered to have PASSED the watchlist. | Passed |
FAILED | This state is specific to the watchlist checks. If a problem was found on a watchlist check then they are considered to have FAILED the watchlist. | Failed |
AUTOFAIL | This state is specific to non-consent or “BG” checks it indicates that the automatic check did not become verified. | Autofail |
IN_PROGRESS | When a user centric “UC” check has not yet reached a verified state it is considered in progress. | In progress |
PENDING | The user has been verified this source, but to do so they changed data in a way that is not considered acceptable without further action. | Pending review |
LOCKED_OUT | This individual source has been locked out. Either by customer specific rules, or at the source end. Only some sources force a lockout after a number of attempts. | Locked out |
ERROR | The individual source could not be queried because of an error. The user may retry at a later date if necessary. | Error |
Method Names
| Method name | Meaning | Human readable name |
|---|---|---|
| DB | This check was a “Data Base” check that was automatically carried out with no user input. This is also referred to as a “Non Consent check” as no explicit consent is needed from the user. | Data Base OR Non Consent |
| UC | The check was a “User Centric” check that required either input or explicit consent from the user or both. | User Centric |
| PP | This check was carried out as a “Person Present” or face to face check. The main example of this type of check is a Post Office verification where the user physically presented themselves and their verification information at a Post Office. | Person Present |
| A category that does not fall into the above will have a blank or null method name. | None |
Field Status
| Status name | Meaning | Human readable name |
|---|---|---|
| CONFIRMED | This field was matched to this source exactly | Field confirmed. |
| CHANGED | This field was changed in order to get a valid match on this source | Field changed. |
| ADDITION | This was an additional field that was added by the user in order to get a valid verification. This is a specialised field that is only available to certain customers. By default a customer will never receive this. | Additional field. |
| NO_MATCH | This is a status returned by “DB” or non consent checks and indicates that a match was not able to found on the source. | No exact match found. |
| MISSING | This is a status returned by a “DB” or non consent source and indicates that this field was not available to be compared on the source, for example in the phone book check the givenName is most often MISSING, whereas the firstInitial is present. | Field missing on source. |