Search loading...


Explore and Make use of Nationally Defined Messaging APIs



Authentication to use the DoS API using HTTP basic auth

Authentication to the REST API uses HTTP basic auth. Authentication is used to track API usage and to control which information is returned to the consumer.

HTTP basic auth is built in to all HTTP clients and requires the Authorization request header with the username and password colon delimited and base64 encoded.

For example using username:password of dos:l3tm31n would produce:

$ curl --basic -v --user dos:l3tm31n

> GET /app/controllers/api/v1.0/services/byOdsCode/FA123 HTTP/1.1
> Host:
> Authorization: Basic ZG9zOmwzdG0zMW4=

NHS Digital is responsible for issuing and managing credentials.

Attempting to access resources without authentication will result in a 401 error.

  "error": {
    "code": 401,
    "message": "Unauthorized: You are not authorized to access this resource."

All content is available under the Open Government Licence v3.0, except where otherwise stated