{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"339ff7b1-03eb-449a-a16c-601065382f55","name":"Atfinity Developer API","description":"# Introduction\n\nThis is the Atfinity api to create and manage atfinity cases.\n\nYou can request a list of all or only some cases, get an overview of all the data present in a single case, see a list of all the instances of a specific [ontology](https://config-doc.atfinity.io/glossary/ontology), and retrieve [information](https://config-doc.atfinity.io/glossary/information) on a specific instance.\n\nYou can also create and delete cases through the API, change the value of information fields in a case, and change the owner of a case.  \n‌  \nOther possibilities include uploading and deleting [proofs](https://config-doc.atfinity.io/glossary/proof), downloading case materials (e.g. booklets), [transitioning](https://config-doc.atfinity.io/glossary/workflow#transition) cases, and sending case booklets out via email.\n\nUsing webhooks, you can select to be notified of specific case updates in real time.\n\nAll endpoints are listed below.\n\n# Versioning\n\nThis documentation is about the latest version of Atfinity, which is currently version 10.2.0. If you are using older versions there might be slight differences.\n\nWhere responses have changes significantly we try to mark it in the documentation. However, it's better to be safe than sorry, so we always recommend to test thoroughly when upgrading to a new version\n\n# Overview\n\nTo use this api you need two things:\n\n1. An API Key\n    \n2. A configured atfinity tenant\n    \n\nIf you are unsure on how to configure atfinity, read our [configuration documentation](https://config-doc.atfinity.io/) or contact us at [support@atfinity.ch](https://mailto:support@atfinity.ch).\n\n# Authentication\n\nRequest to the atfinity API need to include an API-Key.\n\n## Acquiring an API Key\n\nYou can create as many API-Keys as you need in the administration area of your atfinity tenant. You need at least admin rights to create and manage API-Keys.\n\n## Using API Keys\n\nAdd your API-Key to the HTTP Header or your request like so:  \n`Authorization: Api-Key ****`\n\n## Throttling\n\nWe allow a maximum of 500 requests per minute or 10000 request per hour in our public environments. Note that enterprise customers can finely manipulate these values in their on-site deployments if necessary, so check your actual throttling rates if you experience problems.\n\n## Acting on behalf of a user\n\nYou can restrict the rights of your api call and act on behave of a user in atfinity.  \nFor this, add the username of the user you would like to act as into either the `From` or `X-Username` header.  \nAll your requests will then be performed as if executed by that user. Note that this is a voluntary restriction and should be used with security considerations in mind.\n\n### Example\n\n```\n# Header\nFrom: thorben@atfinity.ch\n\n ```\n\nThe request is performed with the access rights of the user with the username `thorben@atfinity.ch`. Requests are also logged as coming from that user.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"262040","team":454945,"collectionId":"339ff7b1-03eb-449a-a16c-601065382f55","publishedId":"TVsrE8XS","public":true,"publicUrl":"https://api-docs.atfinity.io","privateUrl":"https://go.postman.co/documentation/262040-339ff7b1-03eb-449a-a16c-601065382f55","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-03-07T10:40:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Public Documentation","id":"6b59bdc3-c33f-402a-8938-93c286cfa8ed","owner":"262040","values":[{"key":"host","value":"http://localhost:17000","enabled":true,"type":"default"},{"key":"api-key","value":"rokOTRyL.crBqxwNyNUF6AcHRpPP6mbjmoZLW6ply","enabled":true,"type":"default"},{"key":"process-id","value":"1","enabled":true,"type":"default"},{"key":"case-id","value":"23","enabled":true,"type":"default"},{"key":"booklet-id","value":"2","enabled":true,"type":"default"},{"key":"case-document-id","value":"141","enabled":true,"type":"default"},{"key":"ontology-id","value":"3","enabled":true,"type":"default"},{"key":"role-id","value":"5","enabled":true,"type":"default"},{"key":"instance-id","value":"61","enabled":true,"type":"default"},{"key":"requested-proof-id","value":"223","enabled":true,"type":"default"},{"key":"proof-id","value":"223","enabled":true,"type":"default"},{"key":"transition-id","value":"11","enabled":true,"type":"default"},{"key":"case-etag","value":"628bbbd2-3a73-4103-94c1-85536eb3abea","enabled":true,"type":"default"},{"key":"language","value":"en","enabled":true,"type":"default"},{"key":"idnow_webhook_secret","value":"test","enabled":true,"type":"default"},{"key":"idnow_company_id","value":"test","enabled":true,"type":"default"},{"key":"end-user-wizard","value":"9439e9babe6f4f24a849d80103139ee5","enabled":true,"type":"default"},{"key":"end-user-wizard-case","value":"","enabled":true,"type":"default"},{"enabled":true,"key":"case-instance-id","value":"","type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/19d9130a503c641b630fdf2ffc33132b4ff37c7e179f471352b01a58371552bc","favicon":"https://res.cloudinary.com/postman/image/upload/v1609847456/team/tbxpkdwlv66vpp226jpm.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Public Documentation","value":"262040-6b59bdc3-c33f-402a-8938-93c286cfa8ed"}],"canonicalUrl":"https://api-docs.atfinity.io/view/metadata/TVsrE8XS"}