Reduced Support Availability: 22nd - 23rd April 2024

Just to let you know, our team is attending the OneFile all company meeting on 22nd and 23rd April 2024, so we won't be as responsive as usual!

You can still access our help guides - just search the Help Centre to find the answers you need. Otherwise, you can submit a ticket and we'll get back to you as soon as possible. If you have an urgent issue, set the priority accordingly.

Logging out update!

From Thursday 7th March 2024, we're making some small changes to how user accounts linked to a keychain log out. More information on logging out can be found here.

Help centre

Submit a ticket Log in
  1. Home
  2. Guides and Support
  3. Integrations
  4. OneFile API

Authenticate via the API

Adam Fogo
Modified on: Wed, 11 Nov, 2020 at 9:37 AM

  Base URLs

Beta Server: https://wsapibeta.onefile.co.uk/api/v2.1

Practice Server: https://wsapi2.onefile.co.uk/api/v2.1

Live Server: https://wsapi.onefile.co.uk/api/v2.1

Firstly, submit a ticket to request an API Token. Once you've got a token:

  1. Call the POST /api/v2.1/Authentication endpoint
    1. Pass the X-CustomerToken in the header
    2. The Session will be returned in the body of the response
  2.  Pass the Session as the X-TokenID in the header, to authenticate all other calls

X-TokenID Expiry

The X-TokenID will expire 24 hours after being generated.

You'll need to Call the POST /api/v2.1/Authentication endpoint to get a new X-TokenID.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Other Guides