Faults & errors

Owned by Deborah Cross (Unlicensed)
Last updated: Jun 21, 2016

iFrame Deprecated

iFrame integration was deprecated in January 2015.

New customers should integrate using either greenID Web or greenID API. Existing customers are encouraged to upgrade the integration method - contact support to find out more.

This documentation remains to support existing customers with an iFrame integration.

greenID will throw two basic kinds of faults:
  1. FaultDetails – the application has experienced an error.  This may happen when a validation rule or business rule is violated, or when an unexpected error occurs.
  2. SOAPFaultException – these may be thrown by the JBoss container and other libraries outside of the greenID application.  This generally indicates a problem at the container level, which would generally be considered catastrophic.

The FaultDetails object is described below.

FaultDetails

The FaultDetails object is thrown when Edentiti experiences an error. It is designed to contain enough information to allow the client application to understand the error, and continue processing.  

There are three circumstances that will cause a FaultDetails fault to be raised: 

  1. A validation rule is violated.  
  2. A business logic rule is violated.  
  3. An error that is unexpected, and does not fall into the above two categories.  

The FaultDetails exception is wrapped in a normal SOAPFault, and Web Services client libraries will usually unwrap this object for client consumption automatically. That is, the FaultDetails object (generated on the client side from Edentiti’s WSDL), should be returned to the client code directly.

The FaultDetails object has the following structure:  

 

MemberMeaning
Code

This member contains a short code for the problem. The list of possible fault codes is:

  • FieldValidationFault – a field, or fields, have not passed the validation rules.
  • UserIdInUseFault – a userId that is already in use has been used again. A different userId needs to be used.
  • InvalidCustomerIdFault – the customerId is not recognised.
  • InvalidRuleIdFault – the ruleId is not recognised.
  • SystemFault – an unexpected problem has occurred.
  • InvalidCertifcateFault – a client certificate is invalid.
  • UserIdNotFoundFault – the userId supplied could not be found in the database.

 

Details

This field contains a human readable message which details the exact nature of the fault.

In the case where the code is a FieldValidationError, this field contains a list of fields that were invalid, including the name and a validation message, separated by “\n” characters. For example, if theisoCountry parameter and the postcode parameter were invalid, then this field would contain the following:

isoCountry:Invalid Country Code\n

postcode:Please enter a valid postcode

In the case of the other faults, this field contains a short, human readable description of the fault. For example, if a userId that is already in use (say, 123) is used again, then this field will contain:

UserId in use: 123

Errors During Verification Processing

From time to time, an error will occur during processing a particular verification request. For example, network problems may prevent connections, or service providers may be unavailable.

Such errors do not raise faults, though. Instead the fact that an error was experience is stored in the state member of the object, and is returned if the outcome is queried by the client.