sendHostedSMSInviteForOnboarding & getHostedSMSInvitationStatus
sendHostedSMSInviteForOnboarding
This method checks that the input account is enabled for Hosted, performs 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.
If you are using this method, please also refer to getHostedSMSInvitationStatus as this method can facilitate with tracking invitation progress.
SOAP
Inputs 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. |
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 | |
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. |
Return Values
The API call returns a GreenIDHostedServiceResult containing the following data:
Field Name | Type | Notes |
---|---|---|
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 |
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
Inputs 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 |
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 |
Return Values
The API call returns a GreenIDHostedServiceResult containing the following data:
Field Name | Type | Notes |
---|---|---|
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 |
responseErrorMessage | String | A message providing information regarding the error that occurred. |
errorReasonCode | String | Indicates the type of error that occurred. |
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.
getHostedSMSInvitationStatus
This method checks that the input account is enabled for Hosted, performs validation using the input details and then will provide a status of the SMS invitation associated with the SMS Invitation ID.
This method should only be used if you are using sendHostedSMSInviteForOnboarding - it is not compatible with other Hosted web services.
SOAP
Inputs Parameters
Field Name | Type | Required | Description |
---|---|---|---|
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. |
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. |
Return Values
The API call returns a GreenIDHostedServiceResult containing the following data:
Field Name | Type | Description |
---|---|---|
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 |
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
Inputs Parameters
Field Name | Type | Required | Description |
---|---|---|---|
accountId | String | Yes | greenID issues each customer with an accountId, which is a unique identifier by which greenID knows the caller. This |
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. |
Return Values
The API call returns a GreenIDHostedServiceResult containing the following data:
Field Name | Type | Description |
---|---|---|
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 |
responseErrorMessage | String | A message providing information regarding the error that occurred. |
errorReasonCode | String | Indicates the type of error that occurred. |
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 sendHostedSMSInviteForOnboarding
- 1.1 SOAP
- 1.1.1 Inputs Parameters
- 1.1.2 Return Values
- 1.1.3 Sample SOAP Request and Response
- 1.2 JSON
- 1.2.1 Inputs Parameters
- 1.2.2 Return Values
- 1.2.3 Sample JSON Request and Response
- 1.3 Exceptions and Errors
- 1.1 SOAP
- 2 getHostedSMSInvitationStatus
- 2.1 SOAP
- 2.1.1 Inputs Parameters
- 2.1.2 Return Values
- 2.1.3 Sample SOAP Request and Response
- 2.2 JSON
- 2.2.1 Inputs Parameters
- 2.2.2 Return Values
- 2.2.3 Sample JSON Request and Response
- 2.3 Exceptions and Errors
- 2.1 SOAP
- 3 Useful Links: