VIEW API 

 

The Retailer Identification Number API has been developed for browsing, verifying and obtaining detailed information on various Organisations that have provided notification of the sale of tobacco, non-tobacco smoking products and/or e-cigarettes.

Disclaimer

The Retailer Identification Number (RIN) Register is available for members of the public to use to access publicly available information supplied by businesses when they register for a RIN. The RIN Register can be used to find a RIN and details of a RIN. If you cannot locate a RIN and need assistance or suspect there may be an issue with a RIN, please call the Tobacco Information Line on 1800 357 412 during business hours.

The RIN Register search results show details of retailers that have notified the NSW Ministry of Health that they sell tobacco, non-tobacco smoking products and/or e-cigarettes. Under Section 39 of the Public Health (Tobacco) Act 2008, it is the retailer’s responsibility to keep their RIN details accurate and up to date, including cancelling their RIN if they stop selling tobacco, and non-tobacco smoking products and/or e-cigarettes. NSW Health is not responsible for any information displayed in the RIN Register.

Browse – Provides an option to enter in partial information that returns a list of results based on the search criteria. This service is targeted for non-specific search parameters like names. The results are limited to a maximum number of 200 returns to avoid unnecessary loads on the services. The result of the Browse search provides a limited set of base level data as defined below. 

(Learn More...)

Verify – Similar to the browse API, however Verify can be used with more specific parameters such as Licence Number, where only one record is expected to be returned. This also provides a limited set of licence specific information that can be used for licence validation.

(Learn More...)

Detail  – The Detail API is to be used with details provided from either of the browse or verify API’s and will only return one record at a time. The API provides the set of information about the individual licence selected, that corresponds to the level of information available on the detailed screen of the Public Register application.

(Learn More...)  

Request format

Browse requests contain search text and licence group data as URI parameters that return a collection of resources that match the specified criteria.

Verify requests contain licence group data and licence number as URI parameters which return limited details for a single licence number that is confirmed.

Details request contain licence ID and licence group data as URI parameters which return comprehensive details for a specific licence identifier.

Response format

Browse requests return a collection of responses for the specified criteria that matched while verify and details requests return single response for the licence provided.

HTTP 200 response is returned for success, 404 if search text misses, 500 for internal server error, 400 for bad request (e.g. licence group missing) and 401 for unauthorised access.

Data types

Data types the API returns and accepts are JSON values that are in string format.

The Retailer Identification Number API has specific endpoint request limitation to authorised users. API.NSW reserve the right to adjust rate limits for any given endpoint in order to improve quality of service provided to users. Every API consumer will be limited to a number of requests based on their agreement.

The table below shows date, version number and a detailed description of changes or modifications made to the Retailer Identification Number API. Expected or scheduled changes are indicated in a green colour while yellow is used to indicate completed upgrades or changes.

Recent API Changes
Date Version Description
21-Oct-2016 1.0 Retailer Identification Number API development portal launched

API NSW generates API keys for APIs, and enables authentication to your APIs using policies.

Credential pairs consisting of consumer key and secret are provisioned to clients and stored for future validation. These are issued as per the agreement with API NSW.

An OAuth call is required to provide the consumer with an authorisation token that would last approximately 12 hours from the time when request was made. User would need to send this authorisation token with every subsequent request in order to get appropriate results from the API.

For more information see OAuth 2.0

 

Detailed information on security of Retailer Identification Number API.

 

Check detailed technical specifications for the API

 

VIEW API