generateHostedInviteURLForExistingRegistration

Owned by Sharmeen Hussain
Last updated: Mar 19, 2023
3 min read

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 return the link in the API response.

SOAP

Input Parameters

Field Name

Type

Required

Restrictions

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. 

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

Field Name

Type

Description

verificationId

String

 

overallVerificationStatus

String

The overall status of the verification.

hostedInviteUrl

 String

The short url to be used to invite a user to complete their verification via the customer's Hosted website.

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.

Sample SOAP Request and Response

JSON

Input Parameters

Field Name

Type

Required

Restrictions

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. 

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

Field Name

Type

Description

verificationId

String

 

overallVerificationStatus

String

The overall status of the verification.

hostedInviteUrl

 String

The short url to be used to invite a user to complete their verification via the customer's Hosted website.

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.

smsStatus

 

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

smsId

 

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