Versions Compared

Old Version 5

changes.mady.by.user Sharmeen Hussain

Saved on

compared with

New Version 6

changes.mady.by.user Sharmeen Hussain

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This method checks that the input account is enabled for Hosted, retrieves a registration/validation using the input details and then will prepare a link to the hosted site for the account and send this link to the input mobile phone number via SMS.

SOAP

Input Parameters

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

verificationId

String

Yes

Each verification attempt for a person must have a verificationId, which is a unique identifier that greenID and the caller use to refer to a verification attempt for an individual person.  

mobilePhone

String

No (can be null if valid formatted mobile number is present on the existing Registration)

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.

For further information on the data structures used in this API please refer to Data Structures V3.

Return Values

The API call returns a GreenIDHostedServiceResult containing the following data:

Field Name

Type

Description

verificationID

String

overallVerificationStatus

String

The overall status of the verification.

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.

Exceptions

  • InvalidAccountIdException – the accountId input parameter was missing or not recognised.

  • InvalidPasswordException – the password input 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.

  • UserIdNotFoundException - the verificationId supplied could not be found in greenID.

  • HostedAccountException  - the Hosted account is not appropriately configured. For example, account is not enabled for Hosted or account is not enabled for SMS.

  • SystemException - an unexpected error occurred.

Sample SOAP Request and Response

View file
nameSOAP-sendHostedSMSInviteForExistingRegistrationResponse.xml
View file
nameSOAP-sendHostedSMSInviteForExistingRegistration-Request.xml

JSON

Input Parameters

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

verificationId

String

Yes

Each verification attempt for a person must have a verificationId, which is a unique identifier that greenID and the caller use to refer to a verification attempt for an individual person.  

mobilePhone

String

No (can be null if valid formatted mobile number is present on the existing Registration)

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.

For further information on the data structures used in this API please refer to Data Structures V3.

Return Values

The API call returns a GreenIDHostedServiceResult containing the following data:

Field Name

Type

Description

verificationID

String

overallVerificationStatus

String

The overall status of the verification.

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'

errorFlag

Boolean

True = an error occurred
False = no error occurred

errorMessage

String

A message providing information regarding the error that occurred.

errorReasonCode

String

Indicates the type of error that occurred.

Note: This field is currently not available on the JSON response but is being added. It is recommended that you consider it in your implementation but you will not receive a value until it is available.

hostedInviteURL

This field should not be used in your implementation, it will be removed from the response soon.

Sample JSON Request and Response

View file
namesendHostedSMSInviteForExistingRegistration_ResponseRequest.json
View file
namesendHostedSMSInviteForExistingRegistration_Request.json

Exceptions

  • If there are any exceptions or errors, faultData and fault and results will be populated with values.

Useful Links:

Include Page
greenID include
greenID include

On This Page

Table of Contents
minLevel1
maxLevel7
excludeOn This Page
Include Page
greenID Hosted Web A-Z
greenID Hosted Web A-Z