...
This method is used to get a list of data sources, which, if completed, will help a person become fully verified. The method will also return the person’s verification status to date.
Input Parameters
Name | Type | Required | Restrictions |
|---|---|---|---|
|
| Yes | GreenID issues each customer with an |
|
| Yes | Each customer is issued a password that must be supplied with every call to any web method in this API. |
|
| Yes | This parameter must be a valid |
|
| No | This parameter is reserved for the SimpleUI. All customers should ignore this parameter, and set it to null. |
|
| No | This parameter is used to send additional request information to greenID. The various parameters are mentioned as required in this documentation. |
Return Value
This method returns CurrentStatusV3 object. The following members will be populated:
verificationResult– this field contains the results of checks that have been performed to date, and the person’s current verification status.sourceList– this field will contain a list of data sources, which will help the person become fully verified.registrationDetails- this field will contain all the details that were supplied for registration.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException– theaccountIdinput parameter was missing or not recognised.InvalidCertificateException– if certificates are used to connect, then this exception may be thrown if an invalid certificate is used.InvalidPasswordException– thepasswordinput parameter was missing or incorrect.InvalidFieldException– one of the required fields was missing, or the format of a field was not valid. For example, this may be thrown if an email address is not valid.VerificationIdNotFoundException- theverificationIdsupplied could not be found in greenID.InvalidSourceIPAddressException - if web service IP restriction is enabled, then this exception will be thrown if the caller's IP address is not white-listed.SystemException- an unexpected error occurred.
GetFields
This method is used to get a list of source fields required for a particular data source. The method will also return the person’s verification status to date
Input Parameters
Name | Type | Required | Restrictions |
|---|---|---|---|
accountId | String | Yes | GreenID issues each customer with an |
password | String | Yes | Each customer is issued a password that must be supplied with every call to any web method in this API. |
verficationId | String | Yes | This parameter must be a valid |
verificationToken | String | No | This parameter is reserved for the SimpleUI. All customers should ignore this parameter, and set it to null. |
sourceId | String | Yes | This parameter is the name of the data source for which the fields are being requested. It must be a non-blank string that is a valid data source name. For a complete list of available data sources, please refer to <insert reference here>. If the data source cannot be found, then the list of fields will be empty. |
extraData |
| No | This parameter is used to send additional request information to greenID. The various parameters are mentioned as required in this documentation. |
Return Value
This method returns CurrentStatusV3 object. The following members will be populated:
verificationResult– this field contains the results of checks that have been performed to date, and the person’s current verification status.sourceFields– this field will contain a list of fields that are required for the named data source. If the data source could not be identified correctly, then this list will be empty.sourceList– this field will contain an updated list of data sources, which will help the person become fully verified. This field is provided for convenience, so that the caller does not need to callgetSourcesimmediately after this call.registrationDetails- this field will contain all the details that were supplied for registration.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException– theaccountIdinput parameter was missing or not recognised.InvalidCertificateException– if certificates are used to connect, then this exception may be thrown if an invalid certificate is used.InvalidPasswordException– thepasswordinput parameter was missing or incorrect.InvalidFieldException– one of the required fields was missing, or the format of a field was not valid. For example, this may be thrown if an email address is not valid.VerificationIdNotFoundException- theverificationIdsupplied could not be found in greenID.InvalidSourceIPAddressException- if web service IP restriction is enabled, then this exception will be thrown if the caller's IP address is not white-listed.SystemException- an unexpected error occurred.
SetFields
This method is used to provide data fields to greenID for the purpose of performing a check against a data source. If all the fields are present and valid, then greenID will perform the check against the data source, and the result will be returned to the caller.
Input Parameters
Name | Type | Required | Restrictions |
|---|---|---|---|
accountId | String | Yes | GreenID issues each customer with an |
password | String | Yes | Each customer is issued a password that must be supplied with every call to any web method in this API. |
verificationId | String | Yes | This parameter must be a valid verificationId that has been previously registered, via the |
verificationToken | String | No | This parameter is reserved for the SimpleUI. All customers should ignore this parameter, and set it to null. |
sourceId | String | Yes | This parameter is the name of the data source for which the fields are being requested. It must be a non-blank string that is a valid data source name. For a complete list of available data sources, please refer to the Data Source Reference. If the data source cannot be found, then an exception will be thrown. |
inputFields |
| Yes | This parameter contains a list of |
| List<NameValuePair> | No | This parameter is used to send additional request information to greenID. The various parameters are mentioned as required in this documentation. |
Return Value
This method returns CurrentStatusV3 object. The following members will be populated:
verificationResult– this field contains the results of checks that have been performed to date, and the person’s current verification status.sourceList– this field will contain an updated list of data sources, which will help the person become fully verified. This field is provided for convenience, so that the caller does not need to callgetSourcesimmediately after this call.registrationDetails- this field will contain all the details that were supplied for registration.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException– theaccountIdinput parameter was missing or not recognised.InvalidCertificateException– if certificates are used to connect, then this exception may be thrown if an invalid certificate is used.InvalidPasswordException– thepasswordinput parameter was missing or incorrect.A runtime exception will be thrown if the person has already completed the check, or if the user has been locked out of the data source, for example, by too many previous attempts.
IllegalStateException– if the check identified by the sourceId input parameter cannot be found.InvalidFieldException– one of the required fields was missing, or the format of a field was not valid. For example, this may be thrown if an email address is not valid.VerificationIdNotFoundException- the verificationId supplied could not be found in greenID.InvalidSourceIPAddressException- if web service IP restriction is enabled, then this exception will be thrown if the caller's IP address is not white-listed.SystemException- an unexpected error occurred.
GetVerificationResult
This method is used to get the current state of the verification process. This call is effectively the same as a call to getSources, and indeed the same results will be returned.
Input Parameters
Name | Type | Required | Restrictions |
|---|---|---|---|
accountId | String | Yes | GreenID issues each customer with an |
password | String | Yes | Each customer is issued a password that must be supplied with every call to any web method in this API. |
verificationId | String | Yes | This parameter must be a valid verificationId that has been previously registered, via the |
verificationToken | String | No | This parameter is reserved for the SimpleUI. All customers should ignore this parameter, and set it to null. |
extraData |
| No | This parameter is used to send additional request information to greenID. The various parameters are mentioned as required in this documentation. |
Return Value
This method returns CurrentStatusV3 object. The following members will be populated:
verificationResult– this field contains the results of checks that have been performed to date, and the person’s current verification status.sourceList– this field will contain a list of data sources, which will help the person become fully verified.registrationDetails- this field will contain all the details that were supplied for registration.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException– theaccountIdinput parameter was missing or not recognised.InvalidCertificateException– if certificates are used to connect, then this exception may be thrown if an invalid certificate is used.InvalidPasswordException– thepasswordinput parameter was missing or incorrect.InvalidFieldException– one of the required fields was missing, or the format of a field was not valid. For example, this may be thrown if an email address is not valid.VerificationIdNotFoundException- the verificationId supplied could not be found in greenID.InvalidSourceIPAddressException- if web service IP restriction is enabled, then this exception will be thrown if the caller's IP address is not white-listed.SystemException- an unexpected error occurred.
GetVerificationToken
This method is used to get a token that can be used for a verification session within the API. This also extends to use via the SimpleUI. Please consult greenID Web for full details. If you need to implement the "returning person" scenario using the SimpleUI, then you will need a token issued by this method.
Input Parameters
Name | Type | Required | Restrictions |
|---|---|---|---|
accountId | String | Yes | GreenID issues each customer with an |
password | String | Yes | Each customer is issued a password that must be supplied with every call to any web method in this API. |
verificationId | String | Yes | This parameter must be a valid |
extraData | List<NameValuePair> | No | This parameter is used to send additional request information to greenID. The various parameters are mentioned as required in this documentation. |
Return Value
This method returns a String object that is the token.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException– theaccountIdinput parameter was missing or not recognised.InvalidCertificateException– if certificates are used to connect, then this exception may be thrown if an invalid certificate is used.InvalidPasswordException– thepasswordinput parameter was missing or incorrect.InvalidFieldException– one of the required fields was missing, or the format of a field was not valid. For example, this may be thrown if an email address is not valid.VerificationIdNotFoundException- the verificationId supplied could not be found in greenID.InvalidSourceIPAddressException- if web service IP restriction is enabled, then this exception will be thrown if the caller's IP address is not white-listed.SystemException- an unexpected error occurred.