Versions Compared

Key

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

What are Exceptions or Faults?

Exceptions or faults may occur before greenID is successfully able to create a registration or retrieve it. For example, when an invalid field is submitted as an input and therefore a registration cannot be created.

Examples of Exceptions or Faults

SOAP

JSON

What are Errors?

Errors may occur after the registration has been created or retrieved. For example, if our provider fails to send the SMS message submitted.

Samples of Error

JSON

View file
nameJSON Error Response Sample.rtf

SOAP

View file
nameSOAP Error Response Sample.xml

Exceptions List and Details

Exception Type

Details

InvalidCustomerIdException (or InvalidAccountIdException)

The accountId input parameter was missing or not recognised.

InvalidCertificateException

If certificates are used to connect, then this exception may be thrown if an invalid certificate is used. 

InvalidPasswordException

The password or apiCodeinput 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.

InvalidSourceIPAddressException

If web service IP restriction is enabled, then this exception will be thrown if the caller's IP address is not white-listed.

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.

What are Errors?

Errors may occur after the registration has been created or retrieved. For example, if our provider fails to send the SMS message submitted.

Samples of Error

View file
nameSOAP Error Response Sample.xml

View file
nameJSON Error Response Sample.rtf

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