API Versions

This documentation relates to Version 5, the current version of the greenID API. Version 5 became available to customers as of 07 Feb 2024.

The sourceField and rawData elements of the responses contain labels and tooltips for the various data fields. There are two forms these labels/tooltips can take:

Handlebars templates of the form {{{label_name}}}. For an example, see the rawData example in the Interpreting Results section. Handlebars templates allows a customer to customise the content of the label by using the Handlebars Javascript templating engine. For more information on Handlebars, the reader is referred to the Handlebars website: http://www.handlebarsjs.com/
A translated label using greenID defaults. For an example, see the sourceFields example in the Interpreting Results section above.

An account configuration option is set to determine which of these will be returned. The default setting is to translate labels to the greenID defaults. Please contact your GBG to change which option is used.

Alternatively, label translation can be disabled on a per-request basis by passing an extraData parameter to the getFields web method. If the extraData element contains a name-value pair with the name "disable.label.translation" and the value "true", then label translation will be skipped for that request. The request below shows an example of a getFields call with label translation disabled:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dyn="http://dynamicform.services.registrations.edentiti.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <dyn:getFields>
         <accountId>YOUR_ACCOUNT_ID</accountId>
         <password>YOUR_WEB_SERVICE_PASSWORD</password>
         <verificationId>A_VERIFICATION_ID</verificationId>
         <sourceId>A_DATA_SOURCE</sourceId>
         <extraData>
            <name>disable.label.translation</name>
            <value>true</value>
         </extraData>         
      </dyn:getFields>
   </soapenv:Body>
</soapenv:Envelope>

Browser not supported