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 the API.

smsVerificationId

String

No (may be null)

smsVerificationId is supplied by the customer and will become the verificationId when the user registers. If smsVerificationId is not supplied by the customer, greenID will generate a verificationId for the registration. (confirm if required or optional)

ruleId

String

No (may be null)

Callers have a specific rule configured for their greenID Hosted account.  This string must identify a rule. Contact greenID for the name of the rule configured for your Hosted account.  If only one rule is configured, then the string “default” will automatically select that rule.

name

String

Yes

mobilePhone

String

Yes

See Mobile Phone Validation

extraData

List <NameValuePair>

No

This parameter allows the customer to send extra data that will need to be agreed upon before implementation. It will be a simple key /value format. If there is no previous agreement for certain keys to be sent in this field then it will be ignored.

smsInvitationId

String

An identifier specifically related to the SMS invitation generated. This identified can be used to query the status of the SMS SMS and registration via a web service call.

smsVerificationId

String

Returns the smsVerificationId defined by the customer in the input. If smsVerificationId is not provided, this will be empty / null.

smsInvitationStatus

String

Values = waiting, expired or complete.

waiting = user has not yet registered

complete = user is now registered in greenID

expired = link has expired and user is not registered

smsId

String

A unique identifier of the SMS message sent.

smsStatus

String

Indicates whether the SMS has been successfully submitted to the SMS provider, or if an error occurred meaning the SMS will not be sent.

Values can be:  'submitted' or 'error'

responseErrorFlag

Boolean

True = an error occurred
False = no error occurred

responseErrorMessage

String

A message providing information regarding the error that occurred.

errorReasonCode

String

Indicates the type of error that occurred.

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.

apiCode

String

Yes

Each customer is issued a password that must be supplied with every call to any web method in the API.

smsVerificationId

String

No (may be null)

smsVerificationId is supplied by the customer and will become the verificationId when the user registers. If smsVerificationId is not supplied by the customer, greenID will generate a verificationId for the registration. (confirm if required or optional)

ruleId

String

No (may be null)

Callers have a specific rule configured for their greenID Hosted account.  This string must identify a rule. Contact greenID for the name of the rule configured for your Hosted account.  If only one rule is configured, then the string “default” will automatically select that rule.

name

String

Yes

mobilePhone

String

Yes

See Mobile Phone Validation

smsInvitationId

String

An identifier specifically related to the SMS invitation generated. This identified can be used to query the status of the SMS SMS and registration via a web service call.

smsVerificationId

String

Returns the smsVerificationId defined by the customer in the input. If smsVerificationId is not provided, this will be empty / null.

smsInvitationStatus

String

Values = waiting, expired or complete.

waiting = user has not yet registered

complete = user is now registered in greenID

expired = link has expired and user is not registered

smsId

String

A unique identifier of the SMS message sent.

smsStatus

String

Indicates whether the SMS has been successfully submitted to the SMS provider, or if an error occurred meaning the SMS will not be sent.

Values can be:  'submitted' or 'error'

responseErrorFlag

Boolean

True = an error occurred
False = no error occurred

responseErrorMessage

String

A message providing information regarding the error that occurred.

errorReasonCode

String

Indicates the type of error that occurred.

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 the API.

smsInvitationId

String

Yes

Returns the smsVerificationId defined by the customer in the input. If smsVerificationId is not provided, this will be empty / null.

extraData

List <NameValuePair>

No

This parameter allows the customer to send extra data that will need to be agreed upon before implementation. It will be a simple key /value format. If there is no previous agreement for certain keys to be sent in this field then it will be ignored.

smsInvitationId

String

An identifier specifically related to the SMS invitation generated. This identified can be used to query the status of the SMS and registration via a web service call.

smsInvitationStatus

String

Values = waiting, expired or complete.

verificationId

String

The verificationId will be returned if the smsInvitationStatus is 'complete'. If it is waiting or expired, this field will be empty.

overallVerificationStatus

String

The overall status of the verification.

For this method, this will only be populated with a value once a user has registered and the SMS Invitation Status is 'Complete'. Please use geVerificationResult for subsequent verification updated.

smsId

String

A unique identifier of the SMS message sent.

smsStatus

String

Indicates whether the SMS has been successfully submitted to the SMS provider, or if an error occurred meaning the SMS will not be sent.

Values could be: Submitted, Delivered, Undelivered, Sent and Failed

responseErrorFlag

Boolean

True = an error occurred
False = no error occurred

responseErrorMessage

String

A message providing information regarding the error that occurred.

errorReasonCode

String

Indicates the type of error that occurred.

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.

apiCode

String

Yes

Each customer is issued a password that must be supplied with every call to any web method in the API.

smsInvitationId

String

Yes

Returns the smsVerificationId defined by the customer in the input. If smsVerificationId is not provided, this will be empty / null.

smsInvitationId

String

An identifier specifically related to the SMS invitation generated. This identified can be used to query the status of the SMS and registration via a web service call.

smsInvitationStatus

String

Values = waiting, expired or complete.

verificationId

String

The verificationId will be returned if the smsInvitationStatus is 'complete'. If it is waiting or expired, this field will be empty.

overallVerificationStatus

String

The overall status of the verification.

For this method, this will only be populated with a value once a user has registered and the SMS Invitation Status is 'Complete'. Please use geVerificationResult for subsequent verification updated.

smsId

String

A unique identifier of the SMS message sent.

smsStatus

String

Indicates whether the SMS has been successfully submitted to the SMS provider, or if an error occurred meaning the SMS will not be sent.

Values could be: Submitted, Delivered, Undelivered, Sent and Failed

responseErrorFlag

Boolean

True = an error occurred
False = no error occurred

responseErrorMessage

String

A message providing information regarding the error that occurred.

errorReasonCode

String

Indicates the type of error that occurred.