{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7918e4c6-111c-47ee-9dd9-76643a883304","name":"Secure Redact API - v2","description":"Access to the system is provided by signing into your [SecureRedact](https://app.secureredact.co.uk) account. You can generate a client_id and client_secret from your account page. These are used to generated Basic tokens to fetch more secure JWT tokens.\n\nA Javascript SDK is available at [https://www.npmjs.com/package/@secure-redact/javascript-sdk](https://www.npmjs.com/package/@secure-redact/javascript-sdk)\n\nThere are two flows to use the Secure Redact API.\n\n**Standard Flow** does **not** use the Secure Redact UI. Videos are processed without review or editing.\n\n**Enterprise Flow** involves using the Secure Redact User Interface to review and edit media.\n\n<img src=\"https://content.pstmn.io/8d9c1743-a71d-43bb-9c8f-83b6cc860945/U2NyZWVuc2hvdCAyMDIzLTAxLTMwIGF0IDEyLjE1LjM2LnBuZw==\">\n\n#### Detailed steps for Standard Flow\n\n1. [Fetch Token](#fb3173e2-0cf7-44f8-8e7e-821b89df1104)\n    \n2. [Upload Media](#3a149f82-27ae-4673-a7f4-17cc28d8c146)\n    \n3. Monitor the media's progress through SecureRedact. Either via the 'state_callback' url (Secure Redact will periodically POST to this URL) or using [Fetch Media Status](#ca89fc7a-fafd-44f6-bee8-4f57ddde1579) is poll for the status.\n    \n4. Once the status equals 'detected' the media is now ready for review in our UI.\n    \n5. [Redact Media](#fbf2f894-4db3-43cc-ae5b-62d03c3d83fb). This can only happen once the media status equals 'detected'.\n    \n6. Once the redaction process has completed our system will send the 'completed' status message via the 'export_callback' URL provided when the media was uploaded.\n    \n7. Download the media using the [Download Media](#6a691701-2c86-4eda-bb8f-1bfeff0f4d3d) endpoint\n    \n\n#### Detailed steps for Enterprise Flow.\n\n1. [Fetch Token](#fb3173e2-0cf7-44f8-8e7e-821b89df1104)\n    \n2. [Create User](#37abd470-679a-4e2a-9c4f-f5fe18405cd5)\n    \n3. [Fetch Token](#fb3173e2-0cf7-44f8-8e7e-821b89df1104) (for specific user)\n    \n4. [Upload Media](#3a149f82-27ae-4673-a7f4-17cc28d8c146)\n    \n5. Monitor the media's progress through SecureRedact. Either via the 'state_callback' url (Secure Redact will periodically POST to this URL) or using [Fetch Media Status](#ca89fc7a-fafd-44f6-bee8-4f57ddde1579) is poll for the status.\n    \n6. Once the status == 'detected' the media is now ready for review in our UI\n    \n7. [Login User](#9b2e4dfc-7c04-4a0b-8a5a-13608e32dbd8)\n    \n8. Load SecureRedact UI\n    \n9. User edits and clicks the 'Redact' button in the UI\n    \n10. The system will now generate the redacted media\n    \n11. Once the redaction process has completed our system will send a 'completed' status message to the \\`export_callback\\` variable. A 'completed' status will also be returned when calling [Fetch Media Status](#ca89fc7a-fafd-44f6-bee8-4f57ddde1579)\n    \n12. Download the media using the [Download Media](#6a691701-2c86-4eda-bb8f-1bfeff0f4d3d) endpoint\n    \n\n### Changelog\n\n#### v2\n\n- Removed the fetch user token endpoint. Instead you should now use the fetch token endpoint and provide a username in the request parameters when you want to fetch a user token\n    \n- Simplified download endpoint to only require the media_id. No need to call Fetch Media Status endpoint to get the download_url","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14371206","collectionId":"7918e4c6-111c-47ee-9dd9-76643a883304","publishedId":"2s8ZDSck1e","public":true,"publicUrl":"https://docs.v2.secureredact.co.uk","privateUrl":"https://go.postman.co/documentation/14371206-7918e4c6-111c-47ee-9dd9-76643a883304","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"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":"EF5B25"}}]}},"version":"8.10.1","publishDate":"2025-06-18T16:05:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Documentation-v2","id":"21cebec7-2443-4891-b5ec-7a07d13d3cad","owner":"14371206","values":[{"key":"SERVER","value":"https://app.secureredact.co.uk","enabled":true,"type":"default"},{"key":"client_id","value":"client_id","enabled":true,"type":"default"},{"key":"client_secret","value":"client_secret","enabled":true},{"key":"access_token","value":"string","enabled":true,"type":"any"},{"key":"user_id","value":"string","enabled":true},{"key":"username","value":"string","enabled":true},{"key":"video_url","value":"string","enabled":true},{"key":"media_id","value":"string","enabled":true},{"key":"video_tag","value":"string","enabled":true},{"key":"state_callback","value":"string","enabled":true},{"key":"export_callback","value":"string","enabled":true,"type":"default"},{"key":"export_token","value":"string","enabled":true,"type":"default"},{"key":"fetch_url","value":"boolean","enabled":true,"type":"default"},{"key":"increased_detection_accuracy","value":"boolean","enabled":true,"type":"default"},{"key":"redact_audio","value":"boolean","enabled":true,"type":"default"},{"key":"blur","value":"string","enabled":true,"type":"default"},{"key":"enlarge_boxes","value":"float","enabled":true,"type":"default"},{"key":"detect_faces","value":"boolean","enabled":true,"type":"default"},{"key":"detect_license_plates","value":"boolean","enabled":true,"type":"default"},{"key":"blur_level","value":"integer","enabled":true,"type":"default"},{"key":"project_id","value":"string","enabled":true,"type":"default"},{"key":"page_num","value":"number","enabled":true,"type":"default"},{"key":"page_size","value":"number","enabled":true,"type":"default"},{"key":"project_name","value":"string","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/866e06618352e276ee9a620b60e4557dcd3913332dc2bcc4b9fa27310ffe1d6c","favicon":"https://secureredact.co.uk/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":"Documentation-v2","value":"14371206-21cebec7-2443-4891-b5ec-7a07d13d3cad"}],"canonicalUrl":"https://docs.v2.secureredact.co.uk/view/metadata/2s8ZDSck1e"}