Arken provides a HTTP based REST API which allows clients to retrieve or manipulate information in the Arken system. To get started using the Arken API all you need is:
- Create an Arken account
- Request authentication from Arken
- Start coding and call the API endpoints
Information
To begin using the Arken API all you need is:
- Base URL
- Authentication
- Endpoints definition (HTTP Method, URL Path, response format)
Base URL
- https://api.uk.pre.arken.legal for the UK
- https://api.nz.pre.arken.legal/pre for New Zealand and Australia
Authentication
The Arken API uses a JSON Web Token (JWT) to securely transmit information between parties.
To generate the JWT you will need to request access. Arken will supply you with a personal client ID, client secret, audience and the request URL needed to generate a JWT token.
The token must be sent as a HTTP request header using the Bearer schema, with each API call:
| Authorization: Bearer <token> |
|---|
The token is valid for a 24 hour period.
API Endpoints
Listed below are the available endpoints definition (HTTP Method, URL Path, response format)