Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

GreenID Mobile customers will on occasion see extra information come back in their API calls depending on what settings have been applied to their account.

At the moment only two such parameter exists:

  • totalCompletedAttempts
  • geolocationResult

TotalCompletedAttempts

This parameter will be returned for each Combination Source in the sourceList returned by each call to the DynamicFormsService (More information can be found on sources and sourceList here). It is returned as an attribute of the Source component as demonstrated below:

Example Response 
<source>
   <attributes>
      <name>totalCompletedAttempts</name>
      <value>1</value>
   </attributes>
   <available>true</available>
   <name>DRIVERS_LICENCE.NZ+scan+face</name>
   <notRequired>false</notRequired>
   <oneSourceLeft>false</oneSourceLeft>
   <order>1</order>
   <passed>false</passed>
   <state>EMPTY</state>
   <version>1</version>
</source>

In this case the parameter shows that the user who is trying to verify has attempted the NZ Drivers Licence Source once. 

Please note that this parameter is by default configured not to count attempts which resulted in an ERROR state, if you would like to include error states in this count you will need to request a configuration change via support@vixverify.com.

GeolocationResult

This parameter turns on the geolocation result being returned in calls to the DynamicFormsService under the combination sources section of the xml where they have been received from the SDK. 

geolocationResult Example 
<individualResult>
   <dateCreated>2017-10-09T12:56:06.579+1000</dateCreated>
   <extraData>
      <name>isMostRecentOCRAttempt</name>
      <value>true</value>
   </extraData>
   <geolocationResult>
      <latitude>-100.0000001</latitude>
      <longitude>100.0000001</longitude>
      <source>Front</source>
   </geolocationResult>
   <geolocationResult>
      <latitude>-100.0000001</latitude>
      <longitude>100.0000001</longitude>
      <source>Back</source>
   </geolocationResult>
   <individualResult>
      <documentRegion>AU</documentRegion>
      <documentSubRegion>ACT</documentSubRegion>
      <documentType>DRIVERS_LICENCE</documentType>
      <method>interactive</method>
      <name>Document Authenticity</name>
      <state>PENDING</state>
   </individualResult>
   ...
</individualResult>


Currently 3 parameters are returned the latitude, longitude and the source of the geolocation data, in this case since the geolocation is attached to a combination source the source is listed as the image type (Front or Back) which that geolocation was captured with. 

Please note that this parameter is not turned on by default, if you would like to get the geolocationResult back in your webservice calls you will need to request a configuration change via support@vixverify.com.


  • No labels