Versions Compared

Old Version 36

changes.mady.by.user Deborah Cross

Saved on

compared with

New Version Current

changes.mady.by.user Deborah Cross

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 35

Table of Contents

RegistrationResultV2

 

Name

Type

Description 

registrationResult

String

The outcome of the registration process.  It will be one of:

  • SUCCESSFUL_REGISTRATION - personal details was successfully extracted from an identity card, and those details passed the verification step.
  • UNMATCHED_DOCUMENT - personal details was successfully extracted from an identity card, but those details did not pass the verification step.
  • UNREADABLE_DOCUMENT - personal details could not be extracted from an identity card.
userDataUserDataV2The personal details and identity card image information.currentStatusCurrentStatusV2The current status of the verification attempt.

 

UserDataV2

Name

Type

Description

name

Name

The person's name.

addressAddressThe person's address.dobDateOfBirthThe person's date of birth.documentNumberStringThe document number that was extracted from an identity card.documentTypeStringThe document type of the identity card.  Please refer to the list of supported Identity Card Types.imageCodeStringA reference to the image and OCR results in greenID.base64FaceStringThis member is currently unpopulated, and is reserved for future use.faceMimeTypeStringThis member is currently unpopulated, and is reserved for future use.extraUserDataList<NameValuePair>A list of extra data items.

CurrentStatusV2

This type is intended to provide information about what has just happened, as well as giving an overview of the current verification status, and the list of data sources that will help the verification attempt become fully verified.  Always presenting this information helps to reduce the chattiness between greenID and the customer application.

 

Name

Type

Description

sourceList

SourceListV2

This member contains a list of SourceV2 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 a source name chosen from this list as the sourceId input parameter.

verificationResult

VerificationResultV2

This member contains all of the verification information currently available for a verification attempt.  It is a complete record of all checks that have been performed, their results, and an indicator of the 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.  This member will only be populated when a method that fetches source fields is called, i.e. GetFields.

checkResultLastCheckResultV2This 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.verificationTokenStringThis field is for the SimpleUI, and can be ignored.

LastCheckResultV2

This type is intended to give a snapshot of the status of the most recent check that has been performed during a call to the SetFields web method.

 

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.  Valid values are:

  • “VERIFIED” – the check against the data source has succeeded.
  • “VERIFIED_ADMIN” – an administrative user has marked the check as successful, after manual inspection of the results.  This mostly applies to checks that were previously “Pending review” (see below).
  • “VERIFIED_WITH_CHANGES” – the check against the data source passed, but the person made some changes to their details in order to pass.  If the changes are acceptable according to the customer’s rules, then this state is applied; otherwise the status may remain as “PENDING”.
  • “PENDING” – the check against the data source passed, but the person made some changes to their details in order to pass, and manual intervention is required to assess the changes.
  • “ERROR” – an error was experienced during the check, for example, the data source was unavailable.
  • “LOCKED_OUT” – some data sources have a limited number of attempts associated with them, and if that threshold is exceeded, then the person is prevented from trying again.
  • “AUTOFAIL” – applies to background checks, and indicates that a check that was attempted automatically has failed, i.e. the check against the data source was not successful.
  • “IN_PROGRESS” – the check is currently in progress, i.e. the check has been started, but not enough data has been gathered to allow the check to be completed.
  • “NOT_FOUND_ON_LIST” – this status applies watchlist style checks.
  • “FOUND_ON_LIST” – this status also applies to watchlist style checks.
  • “PASSED” - this status applies to the device/fraud watchlist source, and indicates a non-suspicious result.
  • “FAILED” - this status applies to a source when the check has been unsuccessful - ether the data has not matched or (in the case of some interactive checks) the user has changed some data violating the the requirements of the rules.
  • “EMPTY” – indicates this check has not been used.

SourceListV2

 

Name

Type

Description

sources

List<SourceV2>

Simply a list of SourceV2 objects.

 

SourceV2

 

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 LastCheckResultV2 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.

availablebooleanThis member indicates whether this data source is currently available; sometimes a particular data source may not be available.notRequiredbooleanThis 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.oneSourceLeftbooleanThis 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.orderintThe 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.attributesList<NameValuePair>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”.versionintThe version of this data source.  For details, please refer to Data Source Versions.

 

SourceFieldsV2

 

Name

Type

Description

fieldList

FieldListV2

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

field

List<FieldV2>

This member simply contains a list of FieldV2 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 above.orderintAn integer that defines an ordering on the fields.selectItemList<NameValuePair>This member contains a list of item names and values for a select item FieldV2.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”.

 

CurrentStatus

The CurrentStatus object is the sole return type of all the web methods in the API.  It is intended to provide information about what has just happened, as well as giving an overview of the person’s current verification status, and the list of data sources that will help the person become fully verified.  Always presenting this information helps to reduce the chattiness between greenID and the customer application.

...