Skip to content

Atfinity API reference

Work with cases, instances, values, proofs and documents from your own systems.

Generated from the code. Do not edit these pages by hand: change the @public_api annotation on the endpoint and regenerate.

Authentication

Every request needs an API key in the Authorization header:

curl -H "Authorization: Api-Key $ATFINITY_API_KEY" https://your-tenant.atfinity.app/api/1/version

See Generate API Keys.

Run the requests

Download the Postman collection and set the base_url and api_key collection variables. Every endpoint below is in it.

For any other client, take the OpenAPI spec these pages are built from.

List parameters

Every endpoint that returns a list accepts these query parameters, so they are not repeated per endpoint:

  • page (integer) - which page to return, starting at 1
  • page_size (integer) - results per page, 10 by default. The cap depends on the endpoint, see below
  • ordering (string) - field to sort by, prefix with - to reverse
  • search (string) - free text search over the searchable fields

A page past the last one returns the last page instead of an error.

Endpoints that answer with results accept a page_size up to 1000, and -1 for the maximum; anything outside that is rejected. Endpoints that answer with data accept up to 200 and quietly reduce anything larger to it.

List responses carry the page itself next to the pagination:

{"meta": {"pagination": {"page": 1, "pages": 3, "count": 24}}, "results": []}

The key holding the page is results on most endpoints and data on the case list, the case history and the instance list. The schema of each operation below says which one it is.

Sections

  • Cases - 13 operations. Create cases, read their data, move them through their workflow and delete them.
  • Values - 2 operations. Information values are the answers stored in a case. Each value belongs to an instance and to an information field identified by its key.
  • Instances - 14 operations. Instances are the people, companies and objects a case is about. They live outside the case and can be shared between cases.
  • Proofs - 7 operations. Proofs are the files a case collects, for example an ID scan or a utility bill.
  • Documents and booklets - 10 operations. Documents are generated from the case data. A booklet bundles several documents into one PDF.
  • Meta - 1 operation.