| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
In the Web Method Details section, there is a complete discussion of the parameters that are passed to, and returned from, the Web Service methods in the API. This section provides additional conversation about the most important elements, what those elements mean, and their relevance to the verification process.
| Table of Contents |
|---|
Interpreting the sourceList
A call to any method in the greenID API will return, as part of the CurrentStatusV3CurrentStatusV5 object, a sourceList element. The sourceList contains a list of data sources that can contribute to the person's verification attempt. This list of sources is not fixed, it is computed based on the current state of the person's verification attempt, so it can be useful because it can indicate which data sources are not worth attempting, and also which data sources, if passed, will result in the person being verified immediately (we refer to this as "one source left").
Consider the snippet of XML below:
| Code Block | ||
|---|---|---|
| ||
<sourceList>
<source>
<available>true</available>
<name>aDataSource</name>
<notRequired>false</notRequired>
<oneSourceLeft>false</oneSourceLeft>
<order>1</order>
<passed>false</passed>
<state>EMPTY</state>
<version>1</version>
</source>
...
<sourceList> |
...
Interpreting gbgAlert
A call to any method in the greenID API will return, as part of the CurrentStatusV5 object, a gbgAlert element. The gbgAlert contain the results of the GBG Alert evaluations.
If the overall status is NOT_ATTEMPTED then the gbgAlert element will contain no other data. For example:
|
If the overall status is NO_ALERT_RAISED, the gbgAlert element may, or may not, contain 'raisedAlerts'. This is because NO_ALERT_RAISED can mean:
- No alerts have ever been raised OR
- There were alerts raised and locked, but an administrator has 'unlocked' them all - therefore there are no unactioned/of concern Alerts raised.
|
If the overall status is ALERTS_RAISED, then the top-level element will contain the overall Alert status, as well as a score (see note below) and a list of 'raisedAlerts' (i.e. configured rules which have been triggered.. The 'raisedAlerts' will contain a list of 'raisedAlert' elements, each containing information about an alert rule raised.
For example:
|