Versions Compared

Key

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


Info
titleAPI Versions

This documentation relates to Version 1, the current version of the greenID Business API. Version 1 became available to customers as of 

Authentication

HTTP basic authentication is used for accessing the endpoint. The username is a your customer account ID, and the password is a customer's GreenID web services password. 

This is extra text

Exceptions and Error Handling

...

Field NameDescriptionTypeExample
countryCodeThe address country code i.e. a two digit code.String"NZ"
countryNameThe human-readable version of the country name.String"New Zealand"
fullAddressThe full address in a single StringString"67 HAVEN ROAD, NELSON 7010, NEW ZEALAND"
postcodeThe address postcode (only available if address has been validated)String"7010"
streetNameThe address street name (only available if address has been validated)String"HAVEN"
streetNumberThe street number (only available if address has been validated)String"67"
streetTypeThe type of street (only available if address has been validated)String"ROAD"
townCityThe town or city of the address (only available if address has been validated)String"NELSON"

...