Versions Compared

Key

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

Insert excerpt
Version 3 greenID API
Version 3 greenID API
nopaneltrue

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 CurrentStatusV3 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
languagexml
<sourceList>
     <source>
         <available>true</available>
         <name>nswregodvs</name>
         <notRequired>false</notRequired>
         <oneSourceLeft>false</oneSourceLeft>
         <order>1</order>
         <passed>false</passed>
         <state>EMPTY</state>
         <version>1</version>
     </source>
     ...
 <sourceList>    

 

...