...
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 |
|---|---|---|---|
accountId | String | Yes | GreenID issues each customer with an accountId, which is a unique identifier by which greenID knows the caller. This accountId must be supplied with every call to any method in this API. |
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 with greenID via one of the registration web service methods. If the verificationId cannot be found in the greenID database, then an InvalidTokenException will be thrown. |
userToken | String | No | This parameter is reserved for the SimpleUI. All customers should ignore this parameter, and set it to null. |
optionalData | 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 CurrentStatus 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.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException – the accountId input 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 – the password input parameter was missing or incorrect.
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 accountId, which is a unique identifier by which greenID knows the caller. This accountId must be supplied with every call to any method in this API. |
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 verificationId that has been previously registered with greenID via one of the registration web service methods. If the verificationId cannot be found in the greenID database, then an InvalidTokenException will be thrown. |
userToken | 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 Data Source Reference. If the data source cannot be found, then the list of fields will be empty. |
optionalData/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 CurrentStatus 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 call GetSources immediately after this call.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException – the accountId input 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 – the password input parameter was missing or incorrect.
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 accountId, which is a unique identifier by which greenID knows the caller. This accountId must be supplied with every call to any method in this API. |
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 | The verificationId parameter This parameter must be a valid verificationId that valid verificationId that has been previously registered , via the RegisterUser web method, with greenID via one of the registration web service methods. If the verificationId cannot the verificationId cannot be found in the greenID database, then an InvalidTokenException will then an InvalidTokenException will be thrown. |
userToken | String | No | The userToken parameter This parameter is reserved for the SimpleUI. All customers should ignore this parameter, and set it to nullto null. |
sourceId | String | Yes | The sourceId parameter 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> Data Source Reference. If the data source cannot be found, then an exception will be thrown. |
inputFields | InputFields | Yes | The inputFields parameter This parameter contains a list of NameValuePair objects, each of which describes a single input field. For example, a Medicare card number would be a single NameValuePair, with name = “Medicare card number” and value = “2xxxxxxxxx”. |
optionalData/extraData | No | The optionalData parameter 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 CurrentStatus 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 call GetSources immediately after this call.
Exceptions
The following exceptions may be thrown:
InvalidCustomerIdException – the accountId input 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 – the password input 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.
GetUserToken
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 |
|---|---|---|---|
account | String | Yes |
|
password | String | Yes |
|
verificationId | String | Yes | The verificationId parameter must be a valid verificationId (or userId) that has been previously registered, via the RegisterUser orRegisterVerification web method, with greenID. If the verificationId/userId cannot be found in the greenID database, then an InvalidTokenException will be thrown. |
| optionalData | No | The optionalData 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 contains the token.
Exceptions
The following exceptions may be thrown:
InvalidPasswordException – the account or password input parameters were missing or incorrect.
InvalidCertificateException – if certificates are used to connect, then this exception may be thrown if an invalid certificate is used.
VerificationIdNotFoundException – if the verificationId cannot be found.
InvalidFieldException - if one of the fields violates the validation constraints.
InvalidSourceIPAddressException - if IP address restriction is enabled and the IP address of the requesting client is not an allowed IP address, then this exception will be thrown.
VerificationFaultException - there was an error while attempting to contact the data source.
SystemException - there was an internal error in greenID while processing the request.