...
Name | Type | Description |
|---|---|---|
sourceList | SourceListV2 | This member contains a list of Source objects, each of which corresponds to a data source that is available to the person for the purpose of becoming fully verified. The setFields web method expects one of these names as thesourceId input parameter. |
verificationResult | This member contains all of the verification information currently available for a person. It is a complete record of all checks that have been performed, their results, and an indicator of the person’s overall verification status. | |
sourceFields | SourceFieldsV2 | This member contains a list of fields that are required for a particular data source. This includes the field’s name, type and other pertinent information for displaying and collecting a value for the field. |
| checkResult | LastCheckResultV2 | This member indicates the outcome of a check against a data source that was performed during a call to the setFields web method. This member also indicates whether the check is still in progress. |
| userToken | String | This field is for future features in the API, and can be ignored for now. |
LastCheckResultV2
The CheckResult object The LastCheckResultV2 object is intended to give a snapshot of the status of a check that has been performed during a call to the setFields web method.
...
Name | Type | Description |
|---|---|---|
state | String | This member reflects the current state of the source. The valid values are the same as the state member of the CheckResult object. If a source has not been used, then this member will be “EMPTY”. |
passed | boolean | This member indicates whether this source has been passed, i.e. the check is in one of the verified states. |
name | String | This member is the name of the data source. This name is expected to be used to refer to this data source in calls to the setFields web method. |
| available | boolean | This member indicates whether this data source is currently available; sometimes a particular data source may not be available. |
| notRequired | boolean | This member indicates whether this data source can help a person become fully verified. If the value is true, then there is no point using this data source because it cannot help the person become fully verified. |
| oneSourceLeft | boolean | This member indicates whether completing this data source will make a person fully verified. This member is very valuable because it indicates which sources should be attempted first, thereby shortening the verification process. |
| order | int | The order in which the source would be displayed if it were being displayed by greenID. Sources that are more likely to result in the person becoming fully verified are at the top of the list, i.e. their “order” number is lower. |
| attributes | This member contains a list of HTML attributes that should be applied to any HTML input collecting input from a person. For example, the HTML attribute “class=’required’” would be represented by a NameValuePair withname=”class” and value=”required”. |
SourceFieldsV2
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. |
| rawData | String | This 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<FieldV2> | This member simply contains a list of Field objects. |
...
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”. |
| label | String | This member contains label. Please refer to the section on Labels. |
| selectItem | List<NameValuePair> | This member contains a list of item names and values for a select item Field. |
| attribute | List<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”. |
| order | Integer |
| The order in which this field should be displayed. This feature is not yet implemented, and the value is always zero. |
InputFields
Name | Type | Description |
|---|---|---|
input | 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 namea NameValuePair with name=”visa_number” and value=”11111111”. |
...