Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

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 AustraliaSee the API Endpoint documentation for the relevant environment base URL

These are for the Arken API test environment. Once your integration and testing is are complete we will give you a base URL for the live environment as well as a new personal client ID and client secret.

...

Note

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 See the different API endpoint per environmentEndpoints section