Skip to main content
This information relates to the Type query parameter, which can be used when making a Capture Find or Capture Retrieve API call.
The Type query parameter is only applicable if you have the OS AddressBase Premium dataset enabled on your account and set on a specific license key.

​
Use in Find

  • When Type is set to ‘address’, typeahead will work as usual.
  • When Type is set to ‘uprn’, the text query parameter is used to search records where the UPRN information matches from the OS AddressBase Premium dataset.
  • When Type is set to ‘parent_uprn’, the text query parameter is used to search records where the Parent UPRN information matches from the OS AddressBase Premium dataset.
  • When Type is set to ‘toid’, the text query parameter is used to search records where the cross reference information matches values from the OS AddressBase Premium dataset.

​
Use in Retrieve

  • When Type is set to ‘retrieveId’, it will interpret the id field like normal. You can also send in multiple retrieve IDs, comma separated. This is so you can do a batch retrieve on multiple records at once. This feature is only enabled with the OS AddressBase Premium dataset being enabled on the account.
  • When Type is set to ‘uprn’, the id query parameter is used to retrieve the full record(s) where the UPRN information matches from the OS AddressBase Premium dataset.
  • When Type is set to ‘parent_uprn’, the id query parameter is used to retrieve the full record(s) where the Parent UPRN information matches from the OS AddressBase Premium dataset.
  • When Type is set to ‘toid’, the id query parameter is used to retrieve the full record(s) where the cross reference information matches values from the OS AddressBase Premium dataset.
⌘I