{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"50da1f68-23d8-404b-a24f-617cea89bcb3","name":"Victoria Connect API","description":"This documentation is continuously being updated. If you notice anything missing, require further clarification, or have any other questions, please don't hesitate to contact us. We're always here to help.\n\n## Additional documentation\n\nThis documentaion does not include:\n\n- Database schemas.\n    \n- Request / response filters.\n    \n- Validation rules.\n    \n- Additional documentation not covered in this guide.\n    \n\nYou can find this information in the [victoria_connect_api_documentation](https://github.com/victoria-id/victoria_connect_api_documentation) repository.\n\n## Permissions\n\nPermission codes have format `category.level`, where category relates to a part of the platform, and level determines the level of access.\n\n| Permission code | Description |\n| --- | --- |\n| `portal.full` | Portal admin. Only works when assigned in the primary group. Primary group is determined by `Portal.group.id`. See `GET /portal/own/`. |\n| `portal.read` | View portal. |\n| `portal.write` | Modify portal. |\n| `group.delete` | Delete group. |\n| `group.full` | Group admin. |\n| `group.read` | View group. |\n| `group.write` | Modify group. |\n| `profile.create` | Create screening profile. |\n| `profile.delete` | Delete screening profile. |\n| `profile.full` | Screening profile admin. |\n| `profile.read` | View screening profile. |\n| `profile.write` | Modify screening profile. |\n| `screening.create` | Create screening. |\n| `screening.delete` | Delete screening. |\n| `screening.full` | Screening admin. |\n| `screening.read` | View screening. |\n| `screening.write` | Modify screening. |\n| `screenee.create` | Add screenee. |\n| `screenee.delete` | Remove screenee. |\n| `screenee.full` | Screenee admin. |\n| `screenee.read` | View screenee. |\n| `screenee.write` | Modify screenee. |\n| `user.create` | Add users. |\n| `user.delete` | Delete users. |\n| `user.full` | User admin. |\n| `user.read` | View users. |\n| `user.write` | Modify users. |\n\nImplied rights:\n\n- `full` implies `create`, `write`, `read`, and `delete`.\n    \n- `write` also implies `read`.\n    \n\nRight levels compared to HTTP verbs / methods:\n\n| Right level | HTTP verb / method |\n| --- | --- |\n| `full` | \\* (any) |\n| `delete` | `DELETE` |\n| `create` | `POST` |\n| `write` | `PATCH` |\n| `read` | `GET` |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"29541604","team":5531426,"collectionId":"50da1f68-23d8-404b-a24f-617cea89bcb3","publishedId":"2s9YBxZGWS","public":true,"publicUrl":"https://doc.api.victoria-id.com","privateUrl":"https://go.postman.co/documentation/29541604-50da1f68-23d8-404b-a24f-617cea89bcb3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-09-02T18:01:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"api.victoria-id.com","id":"00fbb2db-8088-42ab-88cb-90484dabad4d","owner":"26674293","values":[{"key":"protocol","value":"https","enabled":true},{"key":"address","value":"api.victoria-id.com","enabled":true},{"key":"port","value":"443","enabled":true},{"key":"format","value":"json","enabled":true},{"key":"path","value":"/","enabled":true},{"key":"base","value":"{{protocol}}://{{address}}:{{port}}{{path}}","enabled":true},{"key":"portal_domain","value":"portal.victoria-id.com","enabled":true},{"key":"user_name_personal","value":"Willeke Liselotte","enabled":true},{"key":"user_name_family","value":"de Bruijn","enabled":true},{"key":"user_name_display","value":"Willeke de Bruijn","enabled":true},{"key":"user_name_short","value":"Willeke","enabled":true,"type":"default"},{"key":"user_address_mail","value":"john.doe@victoria-id.com","enabled":true},{"key":"user_address_tele_phone","value":"+31 20 12345678","enabled":true},{"key":"user_address_mail_token","value":"","enabled":true},{"key":"user_password","value":"bettie_serveert","enabled":true,"type":"secret"},{"key":"user_gender","value":"male","enabled":true},{"key":"user_locale","value":"en_us","enabled":true},{"key":"screenee_invite_token","value":"","enabled":true,"type":"default"},{"key":"authorization_code","value":"","enabled":true,"type":"default"},{"key":"access_token","value":"","enabled":true},{"key":"refresh_token","value":"","enabled":true},{"key":"increment_value","value":"0","enabled":true,"type":"any"},{"key":"portal_id","value":"","enabled":true},{"key":"user_id","value":"","enabled":true},{"key":"group_id","value":"","enabled":true},{"key":"group_primary_id","value":"","enabled":true,"type":"any"},{"key":"profile_id","value":"","enabled":true,"type":"default"},{"key":"screening_id","value":"","enabled":true},{"key":"screenee_id","value":"","enabled":true},{"key":"check_id","value":"","enabled":true,"type":"any"},{"key":"check_step","value":"","enabled":true},{"key":"check_token","value":"","enabled":true},{"key":"form_id","value":"","enabled":true,"type":"default"},{"key":"form_name","value":"","enabled":true,"type":"default"},{"key":"form_element_id","value":"q1","enabled":true,"type":"default"},{"key":"file_name","value":"/root/IMAGE.jpeg","enabled":true,"type":"default"},{"key":"file_name_url_encoded","value":"%2Froot%2FIMAGE.jpeg","enabled":true,"type":"default"},{"key":"hatch_id","value":"","enabled":true,"type":"any"},{"key":"hatch_token","value":"","enabled":true,"type":"any"},{"key":"subscription_category_code","value":"reminder","enabled":true,"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/3c6e752d0440605bf07a30a6e1b90a6615ede8787b949c9c26ed5e4e52e96339","favicon":"https://victoria-id.com/favicon.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":"api.victoria-id.com","value":"26674293-00fbb2db-8088-42ab-88cb-90484dabad4d"}],"canonicalUrl":"https://doc.api.victoria-id.com/view/metadata/2s9YBxZGWS"}