Getting started

Before accessing the service, you will need to register for the coding service (see Registration). You will also need to consider the following:

• What you need to set up to pass the API packet to your API endpoint (url).
• What data you are going to code.
• Whether you need single record coding, small batch coding (up to 300 records), or large batch coding.
• Whether you need to reformat your data (for example, batch data will need to fit specific formats, and you may want to add record identifiers to map back to your dataset).

See also Coding Service formats, and the following sections in Using the service: Important context for model use, Tips for getting the best predictions out of the Coding Service, and Review coding outputs.

The use of the Coding Service API is governed by the Coding Service Terms of Use (which includes Service Level Expectations). All API users will be required to accept these Terms of Use prior to gaining access to the service. 

Users requesting access to the service must be appropriately authorised to accept the Terms of Use on behalf of their organisation. 

To register for the service and request client credentials, please read and accept the Terms of Use and complete the Registration Form. 

 Once you have registered, your ABS contact will email you: 

• a client identifier, 'clientID', and
• a client secret, 'clientSecret'. These must be kept confidential as they are used when authenticating your requests. 

The ABS will monitor registrations for usage, and users will be notified via email if their access is under review.