{
  "info": {
    "name": "Atfinity API",
    "description": "Work with cases, instances, values, proofs and documents from your own systems.\n\nSet the `base_url` and `api_key` collection variables, then every request below works.\n\nFull documentation, including what each field means: https://docs.atfinity.io/api/reference/\n\nGenerated from the atfinity source, so it matches the running version. Do not edit it by hand: it is replaced on the next release.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "Authorization"
      },
      {
        "key": "value",
        "value": "Api-Key {{api_key}}"
      },
      {
        "key": "in",
        "value": "header"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://your-tenant.atfinity.app"
    },
    {
      "key": "api_key",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Cases",
      "description": "Create cases, read their data, move them through their workflow and delete them.\n\nhttps://docs.atfinity.io/api/reference/cases",
      "item": [
        {
          "name": "List the activity log of a case",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/case_activity_log",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "case_activity_log"
              ],
              "query": [
                {
                  "key": "ordering",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/cases#case_activity_log_list"
          },
          "response": []
        },
        {
          "name": "List cases",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases"
              ]
            },
            "description": "Returns the cases the API key's tenant can see, newest first. Paginated.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_retrieve"
          },
          "response": [
            {
              "name": "Example",
              "originalRequest": {
                "method": "GET",
                "header": [],
                "url": {
                  "raw": "{{base_url}}/api/1/cases",
                  "host": [
                    "{{base_url}}"
                  ],
                  "path": [
                    "api",
                    "1",
                    "cases"
                  ]
                },
                "description": "Returns the cases the API key's tenant can see, newest first. Paginated.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_retrieve"
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"data\": [\n    {\n      \"id\": 4711,\n      \"name\": \"Onboarding Jane Doe\",\n      \"state_key\": \"in_review\",\n      \"user_readable_id\": \"#4711\"\n    },\n    {\n      \"id\": 4712,\n      \"name\": \"Onboarding Acme AG\",\n      \"state_key\": \"draft\",\n      \"user_readable_id\": \"#4712\"\n    }\n  ],\n  \"meta\": {\n    \"pagination\": {\n      \"count\": 24,\n      \"page\": 1,\n      \"pages\": 3\n    }\n  }\n}",
              "_postman_previewlanguage": "json"
            }
          ]
        },
        {
          "name": "Create a case",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Onboarding Jane Doe\",\n  \"owner_email\": \"advisor@example.com\",\n  \"process_key\": \"onboarding\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Starts a new case for a process. The rule engine runs before the response is returned, so the\nresponse already contains the questions the case asks.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_create"
          },
          "response": []
        },
        {
          "name": "List the activity log of a case",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/activity_log",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "activity_log"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "ordering",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_activity_log_list"
          },
          "response": []
        },
        {
          "name": "Comment on a case",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/comments",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "comments"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"text\": \"The passport scan is unreadable.\",\n  \"title\": \"Missing proof\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "`text` is the comment body and is required. Set `is_issue` to raise it as an issue rather\nthan a plain comment, `assigned_user` to make it a task for that user, and `reply_to` to\nanswer an existing comment.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_comments_create"
          },
          "response": []
        },
        {
          "name": "Delete a case",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_destroy"
          },
          "response": []
        },
        {
          "name": "Get a case",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "The full case: instances, information values, documents, buttons and workflow state.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_retrieve_2"
          },
          "response": []
        },
        {
          "name": "Update a case",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"fields\": [\n    {\n      \"information_key\": \"date_of_birth\",\n      \"instance_id\": 5001,\n      \"value\": \"1985-04-12\"\n    },\n    {\n      \"case_field_key\": \"Person.first_name\",\n      \"value\": \"Jane\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Writes field values, the owner, the assignee, the name, the language and the tags. Send only the\nkeys you want to change. `field` addresses one value, `fields` a list of them, and a value is\naddressed either by `case_field_key`, or by `information_key` together with `instance_id`. Add\n`structure_occurrence_index` and `structure_occurrence_information_key` for a value inside a\nstructure. The rule engine runs afterwards, so the response reflects the recalculated case.\n\n`given_name` only applies when the case's process allows given names.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_partial_update"
          },
          "response": []
        },
        {
          "name": "List the other cases of this case's outcome instance",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/case_history",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "case_history"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "The cases that share the outcome instance of this case, newest first, which is the client's\nhistory rather than revisions of this case.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_case_history_retrieve"
          },
          "response": []
        },
        {
          "name": "Copy a case",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/copy",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "copy"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_copy_create"
          },
          "response": []
        },
        {
          "name": "Check for background tasks still running on a case",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/has_ongoing_tasks",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "has_ongoing_tasks"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Useful after a transition that freezes documents: poll this until it returns false before\ndownloading them.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_has_ongoing_tasks_retrieve"
          },
          "response": [
            {
              "name": "Example",
              "originalRequest": {
                "method": "GET",
                "header": [],
                "url": {
                  "raw": "{{base_url}}/api/1/cases/:id/has_ongoing_tasks",
                  "host": [
                    "{{base_url}}"
                  ],
                  "path": [
                    "api",
                    "1",
                    "cases",
                    ":id",
                    "has_ongoing_tasks"
                  ],
                  "variable": [
                    {
                      "key": "id",
                      "value": ""
                    }
                  ],
                  "query": [
                    {
                      "key": "format",
                      "value": "",
                      "disabled": true
                    }
                  ]
                },
                "description": "Useful after a transition that freezes documents: poll this until it returns false before\ndownloading them.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_has_ongoing_tasks_retrieve"
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"has_ongoing_tasks\": true\n}",
              "_postman_previewlanguage": "json"
            }
          ]
        },
        {
          "name": "Set the tags of a case",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/set_tags",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "set_tags"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"tags\": [\n    {\n      \"id\": 12,\n      \"key\": \"high_risk\"\n    },\n    {\n      \"id\": 15,\n      \"key\": \"eu\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_set_tags_create"
          },
          "response": []
        },
        {
          "name": "Transition a case",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/transition",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "transition"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"transition_key\": \"submit_for_review\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Moves the case along one workflow transition. Pass either `transition_id` or `transition_key`.\nThe transition's condition is validated first, so a case that is not ready stays where it is.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/cases#cases_transition_create"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Values",
      "description": "Information values are the answers stored in a case. Each value belongs to an instance and to an information field identified by its key.\n\nhttps://docs.atfinity.io/api/reference/values",
      "item": [
        {
          "name": "List all values of a case",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/values",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "values"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "ordering",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/values#cases_values_list"
          },
          "response": [
            {
              "name": "Example",
              "originalRequest": {
                "method": "GET",
                "header": [],
                "url": {
                  "raw": "{{base_url}}/api/1/cases/:case_pk/values",
                  "host": [
                    "{{base_url}}"
                  ],
                  "path": [
                    "api",
                    "1",
                    "cases",
                    ":case_pk",
                    "values"
                  ],
                  "variable": [
                    {
                      "key": "case_pk",
                      "value": ""
                    }
                  ],
                  "query": [
                    {
                      "key": "ordering",
                      "value": "",
                      "disabled": true
                    },
                    {
                      "key": "page",
                      "value": "",
                      "disabled": true
                    },
                    {
                      "key": "page_size",
                      "value": "",
                      "disabled": true
                    },
                    {
                      "key": "search",
                      "value": "",
                      "disabled": true
                    }
                  ]
                },
                "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/values#cases_values_list"
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"meta\": {\n    \"pagination\": {\n      \"count\": 1,\n      \"page\": 1,\n      \"pages\": 1\n    }\n  },\n  \"results\": [\n    {\n      \"case_id\": 4711,\n      \"id\": 90001,\n      \"information_key\": \"date_of_birth\",\n      \"information_user_readable_id\": \"person.date_of_birth\",\n      \"instance_id\": 5001,\n      \"is_touched\": true,\n      \"value\": \"1985-04-12\"\n    }\n  ]\n}",
              "_postman_previewlanguage": "json"
            }
          ]
        },
        {
          "name": "List all values of an instance",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/instances/:instance_pk/values",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                ":instance_pk",
                "values"
              ],
              "variable": [
                {
                  "key": "instance_pk",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "ordering",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/values#instances_values_list"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Instances",
      "description": "Instances are the people, companies and objects a case is about. They live outside the case and can be shared between cases.\n\nhttps://docs.atfinity.io/api/reference/instances",
      "item": [
        {
          "name": "Add an instance to a case",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/instances",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "instances"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"fields\": {\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\"\n  },\n  \"ontology_key\": \"Person\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Creates an instance of the given ontology inside the case. Identify the ontology by\n`ontology_id` or by `ontology_key`. `fields` sets initial values, keyed by information key.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#cases_instances_create"
          },
          "response": []
        },
        {
          "name": "Remove an instance from a case",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/instances/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "instances",
                ":id"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "A draft instance is deleted. An instance that exists outside the case keeps existing: it is\nunlinked from the case and its values in that case are removed. Refused for managed ontologies.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#cases_instances_destroy"
          },
          "response": []
        },
        {
          "name": "Unlink a case instance",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/instances/:id/link",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "instances",
                ":id",
                "link"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Gives the case its own copy of the instance again, so later changes stay inside this case.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#cases_instances_link_destroy"
          },
          "response": []
        },
        {
          "name": "Link a case instance to a shared instance",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/instances/:id/link",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "instances",
                ":id",
                "link"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"new_instance_id\": 5001\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Replaces the instance in the case with `new_instance_id`, so the case points at an instance\nthat is shared with other cases. Refused when the instance does not allow link changes.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#cases_instances_link_create"
          },
          "response": []
        },
        {
          "name": "Give an instance a role in a case",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/instances/:instance_pk/roles",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "instances",
                ":instance_pk",
                "roles"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "instance_pk",
                  "value": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"role_key\": \"AccountHolder\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Identify the role by `role_id` or by `role_key`. The role has to be one the instance's\nontology can hold.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#cases_instances_roles_create"
          },
          "response": []
        },
        {
          "name": "Take a role away from an instance in a case",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/instances/:instance_pk/roles/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "instances",
                ":instance_pk",
                "roles",
                ":id"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                },
                {
                  "key": "instance_pk",
                  "value": ""
                }
              ]
            },
            "description": "The last path segment is the role id or the role key.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#cases_instances_roles_destroy"
          },
          "response": []
        },
        {
          "name": "List instances of an ontology",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/instances-for-ontology-:ontology_id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances-for-ontology-:ontology_id"
              ],
              "variable": [
                {
                  "key": "ontology_id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_for_ontology__retrieve"
          },
          "response": []
        },
        {
          "name": "Create an instance outside a case",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/instances/force_create",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                "force_create"
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"fields\": {\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\"\n  },\n  \"name\": \"Jane Doe\",\n  \"ontology_key\": \"Person\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Creates a valid instance directly, without going through a case. Identify the ontology by\n`ontology_id` or `ontology_key`; `fields` sets values keyed by information key. Refused for\nontologies whose instances are managed.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_force_create_create"
          },
          "response": []
        },
        {
          "name": "Delete an instance",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/instances/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Deletes the instance itself, wherever it is used. Every lifecycle case whose outcome this\ninstance is goes with it, and it is removed from the cases that merely link it. To take an\ninstance out of a single case without deleting it, use the case's own instance endpoint.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_destroy"
          },
          "response": []
        },
        {
          "name": "Get an instance",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/instances/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_retrieve"
          },
          "response": []
        },
        {
          "name": "Update an instance",
          "request": {
            "method": "PATCH",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/instances/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_partial_update"
          },
          "response": []
        },
        {
          "name": "Count the cases an instance is used in",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/instances/:id/case_count",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                ":id",
                "case_count"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_case_count_retrieve"
          },
          "response": []
        },
        {
          "name": "Update the values of an instance",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/instances/:id/force_update",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                ":id",
                "force_update"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "reindex",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"fields\": {\n    \"first_name\": \"Jane\",\n    \"risk_score\": 42\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Writes information values on the instance itself, keyed by information key, without going\nthrough a case. Ongoing cases that use the instance are warned about the change. Pass\n`reindex=false` while importing many instances, then reindex once at the end.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_force_update_partial_update"
          },
          "response": []
        },
        {
          "name": "List the value change history of an instance",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/instances/:instance_pk/history",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "instances",
                ":instance_pk",
                "history"
              ],
              "variable": [
                {
                  "key": "instance_pk",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "_created",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "_created_by_includes",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "_created_by_starts",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "_updated",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "_updated_by_includes",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "_updated_by_starts",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "changed_by",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "manual_instance_action_key",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "ordering",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "page_size",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "reason",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "source_key",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/instances#instances_history_list"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Proofs",
      "description": "Proofs are the files a case collects, for example an ID scan or a utility bill.\n\nhttps://docs.atfinity.io/api/reference/proofs",
      "item": [
        {
          "name": "Upload a proof",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/proofs",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "proofs"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                }
              ]
            },
            "description": "Send the file as `multipart/form-data`. The upload only stores the proof on the case; use the\nassign endpoint to attach it to a needed document.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/proofs#cases_proofs_create"
          },
          "response": []
        },
        {
          "name": "Delete a proof",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/proofs/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "proofs",
                ":id"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/proofs#cases_proofs_destroy"
          },
          "response": []
        },
        {
          "name": "Get a proof",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/proofs/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "proofs",
                ":id"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/proofs#cases_proofs_retrieve"
          },
          "response": []
        },
        {
          "name": "Update a proof",
          "request": {
            "method": "PATCH",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/proofs/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "proofs",
                ":id"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/proofs#cases_proofs_partial_update"
          },
          "response": []
        },
        {
          "name": "Assign a proof to a needed document",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/proofs/:id/assign",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "proofs",
                ":id",
                "assign"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"assign_to\": 3301\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/proofs#cases_proofs_assign_create"
          },
          "response": []
        },
        {
          "name": "Download the original file of a proof",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/proofs/:id/original",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "proofs",
                ":id",
                "original"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/proofs#cases_proofs_original_retrieve"
          },
          "response": []
        },
        {
          "name": "Unassign a proof",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/proofs/:id/unassign",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "proofs",
                ":id",
                "unassign"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/proofs#cases_proofs_unassign_create"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Documents and booklets",
      "description": "Documents are generated from the case data. A booklet bundles several documents into one PDF.\n\nhttps://docs.atfinity.io/api/reference/documents-and-booklets",
      "item": [
        {
          "name": "Download a booklet",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/booklets/:id/download",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "booklets",
                ":id",
                "download"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_booklets_download_create"
          },
          "response": []
        },
        {
          "name": "Send a booklet by email",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/booklets/:id/send",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "booklets",
                ":id",
                "send"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_booklets_send_create"
          },
          "response": []
        },
        {
          "name": "Get a document",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/documents/:id",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "documents",
                ":id"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_documents_retrieve"
          },
          "response": []
        },
        {
          "name": "Download a document preview",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/documents/:id/preview",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "documents",
                ":id",
                "preview"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_documents_preview_retrieve"
          },
          "response": []
        },
        {
          "name": "Download a signed document",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:case_pk/documents/:id/signed",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":case_pk",
                "documents",
                ":id",
                "signed"
              ],
              "variable": [
                {
                  "key": "case_pk",
                  "value": ""
                },
                {
                  "key": "id",
                  "value": ""
                }
              ]
            },
            "description": "Fields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_documents_signed_retrieve"
          },
          "response": []
        },
        {
          "name": "Download all proofs of a case",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/all_proofs",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "all_proofs"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "One zip archive of every provided proof file on the case.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_all_proofs_retrieve"
          },
          "response": []
        },
        {
          "name": "Download the case booklet",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/booklet",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "booklet"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "booklet_id",
                  "value": "",
                  "disabled": false
                },
                {
                  "key": "language",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "`booklet_id` selects the booklet and is required. Append the instance id to it, separated by a\ndash, to render the booklet for one instance of the case.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_booklet_retrieve"
          },
          "response": []
        },
        {
          "name": "Download the signed booklet",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/signed_booklet",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "signed_booklet"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "format",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "language",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "Available once the booklet has been signed.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_signed_booklet_retrieve"
          },
          "response": []
        },
        {
          "name": "Download the default unsigned booklet",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/cases/:id/unsigned_booklet",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "cases",
                ":id",
                "unsigned_booklet"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": ""
                }
              ],
              "query": [
                {
                  "key": "language",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "description": "The process's default booklet, without signatures. Use the case booklet endpoint to pick a\nspecific booklet.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#cases_unsigned_booklet_retrieve"
          },
          "response": []
        },
        {
          "name": "Upload a filled out document",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/documents_upload/upload",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "documents_upload",
                "upload"
              ]
            },
            "description": "Send a PDF that was generated by Atfinity and printed out. The QR codes on its pages say\nwhich case and which needed document each page belongs to, so one upload can carry pages of\nseveral cases. Pages whose case version is outdated are reported instead of stored.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/documents-and-booklets#documents_upload_upload_create"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Meta",
      "description": "https://docs.atfinity.io/api/reference/meta",
      "item": [
        {
          "name": "Get the application version",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/api/1/version",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "api",
                "1",
                "version"
              ]
            },
            "description": "Also the cheapest way to check that an API key works.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/meta#version_retrieve"
          },
          "response": [
            {
              "name": "Example",
              "originalRequest": {
                "method": "GET",
                "header": [],
                "url": {
                  "raw": "{{base_url}}/api/1/version",
                  "host": [
                    "{{base_url}}"
                  ],
                  "path": [
                    "api",
                    "1",
                    "version"
                  ]
                },
                "description": "Also the cheapest way to check that an API key works.\n\nFields, types and the response shape: https://docs.atfinity.io/api/reference/meta#version_retrieve"
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"conf_version\": 137,\n  \"software_version\": \"15.4.1\"\n}",
              "_postman_previewlanguage": "json"
            }
          ]
        }
      ]
    }
  ]
}