sendHostedSMSInviteForExistingRegistration
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 |
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 |
mobilePhone | String | No (can be null if valid formatted mobile number is present on the existing Registration) | |
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 |
responseErrorMessage | String | A message providing information regarding the error that occurred. |
errorReasonCode | String | Indicates the type of error that occurred. |
Sample SOAP Request and Response
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 |
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 |
mobilePhone | String | No (can be null if valid formatted mobile number is present on the existing Registration) |
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 |
responseErrorMessage | String | A message providing information regarding the error that occurred. |
errorReasonCode | String | Indicates the type of error that occurred. |
hostedInviteURL | Â | This field should not be used in your implementation, it will be removed from the response soon. |
Sample JSON Request and Response
Exceptions and Errors
Detailed Exception and Error information for SOAP and JSON for this method is available on Exceptions and Errors.
Useful Links:
Â
On This Page
- 1.1 SOAP
- 1.1.1 Input Parameters
- 1.1.2 Return Values
- 1.1.3 Sample SOAP Request and Response
- 1.2 JSON
- 1.2.1 Input Parameters
- 1.2.2 Return Values
- 1.2.3 Sample JSON Request and Response
- 1.3 Exceptions and Errors
- 1.1 SOAP
- 2 Useful Links: