This method will be available in Test on 9th November 2023 and Production on 21st November 2023.

This method checks that the input account is enabled for Hosted, performs a registration/validation using the input details and then will prepare a link to the hosted site and send the URL back in the response.

SOAP

Inputs 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	No (may be null)	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. If the caller supplies the `verificationId` then greenID stores and uses that identifier; otherwise, greenID will generate a unique `verificationId`. The `verificationId` is returned to the caller.
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.
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	The reserved verificationID or the ID generated by greenID.
hostedInviteUrl	String	The unqiue URL linked to the verification ID.
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

Inputs 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	No (may be null)	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. If the caller supplies the `verificationId` then greenID stores and uses that identifier; otherwise, greenID will generate a unique `verificationId`. The `verificationId` is returned to the caller.
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.
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

Field Name	Type	Description
verificationId	String	The reserved verificationID or the ID generated by greenID.
hostedInviteUrl		The unqiue URL linked to the verification ID.
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.
hostedInviteUrl		The unqiue URL linked to the verification ID.