{"info":{"_postman_id":"082caf80-760e-4689-9147-d071f16c4943","name":"CloudRedaction.AI","description":"<html><head></head><body><p>Welcome to the CloudRedaction API documentation. When exploring the API endpoints we provide, if you have any technical questions please send an email to <a href=\"https://mailto:support@readyredact.com\">support@cloudredaction.com</a>.</p>\n<h3 id=\"api-authentication\"><strong>API Authentication</strong></h3>\n<p>CloudRedaction uses an API key to validate all API requests.</p>\n<p>API keys can be found under Integrations when logged into the CloudRedaction portal.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"49244408","collectionId":"082caf80-760e-4689-9147-d071f16c4943","publishedId":"2sB3dSQoaS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-11T22:40:32.000Z"},"item":[{"name":"Redaction","item":[{"name":"Redact","id":"19709c9b-5e9b-476b-a19b-6e877ce3cb4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"5ec826ac-735e-4523-97ff-04080b3a5c15","src":"mnOd_sgPz/document_RR.pdf"},{"key":"execution_mode","value":"sync","type":"text","uuid":"dc1b1cb5-653c-424a-abfd-9a99af030400"},{"key":"response_format","value":"pdf","type":"text","uuid":"d031c5a8-0588-4f21-be67-9fcfbea80718"},{"key":"prompt","value":"People Names","type":"text","uuid":"e9d91de9-91ab-40a6-b757-70da48d4b3d7"}]},"url":"https://api.cloudredaction.ai/api/v1/redact","urlObject":{"protocol":"https","path":["api","v1","redact"],"host":["api","cloudredaction","ai"],"query":[],"variable":[]}},"response":[{"id":"3f3ed3f4-2385-4784-be01-a3da7ebe8771","name":"Redact Example","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"5ec826ac-735e-4523-97ff-04080b3a5c15","src":"o49_mmSR5/23-15992.pdf"},{"key":"execution_mode","value":"sync","type":"text","uuid":"dc1b1cb5-653c-424a-abfd-9a99af030400"},{"key":"response_format","value":"pdf","type":"text","uuid":"d031c5a8-0588-4f21-be67-9fcfbea80718"},{"key":"prompt","value":"People Names","type":"text","uuid":"e9d91de9-91ab-40a6-b757-70da48d4b3d7"}]},"url":"https://api.cloudredaction.ai/api/v1/redact"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"### PDF Response\n\nThis endpoint returns a PDF file.\n\n**Response Headers:**\n- Content-Type: application/pdf\n"}],"_postman_id":"19709c9b-5e9b-476b-a19b-6e877ce3cb4d"},{"name":"Get Redact","id":"8cafa110-e46e-4050-93e9-caf1bdbb31f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"document_id\": \"7NXQS1MCBVS95MDC2110CR3BV3\",\n    \"response_format\": \"pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudredaction.ai/api/v1/redact","urlObject":{"protocol":"https","path":["api","v1","redact"],"host":["api","cloudredaction","ai"],"query":[],"variable":[]}},"response":[{"id":"c95e3617-85a8-4652-bdc0-fdba336b2c4e","name":"Get Redact Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"document_id\": \"7NXQS1MCBVS95MDC2110CR3BV3\",\n    \"response_format\": \"pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cloudredaction.ai/api/v1/redact"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"### PDF Response\n\nThis endpoint returns a PDF file.\n\n**Response Headers:**\n- Content-Type: application/pdf\n"}],"_postman_id":"8cafa110-e46e-4050-93e9-caf1bdbb31f6"},{"name":"Predefined Redaction Rules","id":"2179f2ff-e0b4-45c6-9347-9036f78d930b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"url":"https://api.cloudredaction.ai/api/v1/predefined-prompts","urlObject":{"protocol":"https","path":["api","v1","predefined-prompts"],"host":["api","cloudredaction","ai"],"query":[],"variable":[]}},"response":[{"id":"16a4fed2-02fc-428a-9dc0-055b52e5922b","name":"Predefined Redaction Rules Example","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"url":"https://api.cloudredaction.ai/api/v1/predefined-prompts"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Sat, 13 Dec 2025 04:44:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"323"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Cache-Control","value":"max-age=172800"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Vary","value":"Authorization,Accept-Encoding"},{"key":"Expires","value":"Mon, 15 Dec 2025 04:44:47 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"data\": [\n        {\n            \"slug\": \"Name\",\n            \"name\": \"Names\"\n        },\n        {\n            \"slug\": \"Address\",\n            \"name\": \"Addresses\"\n        },\n        {\n            \"slug\": \"USSocialSecurityNumber\",\n            \"name\": \"Social Security Number\"\n        },\n        {\n            \"slug\": \"email_address\",\n            \"name\": \"Email\"\n        },\n        {\n            \"slug\": \"PhoneNumber\",\n            \"name\": \"Phone Number\"\n        },\n        {\n            \"slug\": \"CreditCardNumber\",\n            \"name\": \"Credit Card\"\n        },\n        {\n            \"slug\": \"USUKPassportNumber\",\n            \"name\": \"US/UK Passport Number\"\n        },\n        {\n            \"slug\": \"USBankAccountNumber\",\n            \"name\": \"US Bank Account Number\"\n        },\n        {\n            \"slug\": \"InternationalBankingAccountNumber\",\n            \"name\": \"International Bank Account Number\"\n        },\n        {\n            \"slug\": \"ABARoutingNumber\",\n            \"name\": \"ABA Routing Number\"\n        },\n        {\n            \"slug\": \"USDriversLicenseNumber\",\n            \"name\": \"US Driver's License Number\"\n        },\n        {\n            \"slug\": \"UKDriversLicenseNumber\",\n            \"name\": \"UK Driver's License Number\"\n        },\n        {\n            \"slug\": \"vin\",\n            \"name\": \"VIN\"\n        },\n        {\n            \"slug\": \"FEIN\",\n            \"name\": \"Federal Employer Identification Number\"\n        },\n        {\n            \"slug\": \"url_new\",\n            \"name\": \"URL\"\n        },\n        {\n            \"slug\": \"numeric_date\",\n            \"name\": \"Numeric Dates\"\n        },\n        {\n            \"slug\": \"alphanumeric_date\",\n            \"name\": \"Alphanumeric Dates\"\n        }\n    ]\n}"}],"_postman_id":"2179f2ff-e0b4-45c6-9347-9036f78d930b"},{"name":"Put File Text","id":"abb9fcfa-c758-45f8-8f0e-a5c211a8b21c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"text","value":"Hello,\nI noticed that my account was charged twice for my subscription this month. On August 15, 2025, I was billed $49.99 twice. One charge appears on my credit card statement under TechStream Services, and the other under TS Online Services.\nFor reference, here are the details:\nCredit Card Number: 4111 1111 1111 1234\nExpiration Date: 08/28\nCVV: 123\nSSN : 123-45-6789\nCould you please confirm which charge is valid and issue a refund for the duplicate?\nThanks,\nJohnathan","type":"text","uuid":"07751a4f-643b-4ff4-bc58-1a8ba2f5f9f6"},{"key":"type","value":"SSN,CREDIT_DEBIT_NUMBER,CREDIT_DEBIT_CVV,CREDIT_DEBIT_EXPIRY","type":"text","uuid":"d4b7492e-77d0-43df-bfb8-871f8cda5f63"}]},"url":"https://api.cloudredaction.ai/api/v1/put-file-text","description":"<p>If the \"type\" parameter is not included in the API request, or if its value is set to \"ALL\", then all supported Comprehend PII types will be applied by default. Otherwise, the request must explicitly specify the PII types to be used in that request payload for detection and masking. And the type values should be in the same format as in the following list. If any new type other than in the list is added, then the API will not process redaction and will respond with the validation message.<br />\"ADDRESS\",<br />\"AGE\",<br />\"AWS_ACCESS_KEY\",<br />\"AWS_SECRET_KEY\",<br />\"CREDIT_DEBIT_CVV\",<br />\"CREDIT_DEBIT_EXPIRY\",<br />\"CREDIT_DEBIT_NUMBER\",<br />\"DATE_TIME\",<br />\"DRIVER_ID\",<br />\"EMAIL\",<br />\"INTERNATIONAL_BANK_ACCOUNT_NUMBER\",<br />\"IP_ADDRESS\",<br />\"LICENSE_PLATE\",<br />\"MAC_ADDRESS\",<br />\"NAME\",<br />\"PASSWORD\",<br />\"PHONE\",<br />\"PIN\",<br />\"SWIFT_CODE\",<br />\"URL\",<br />\"USERNAME\",<br />\"VEHICLE_IDENTIFICATION_NUMBER\",<br />\"CA_HEALTH_NUMBER\",<br />\"CA_SOCIAL_INSURANCE_NUMBER\",<br />\"IN_AADHAAR\",<br />\"IN_NREGA\",<br />\"IN_PERMANENT_ACCOUNT_NUMBER\",<br />\"IN_VOTER_NUMBER\",<br />\"UK_NATIONAL_HEALTH_SERVICE_NUMBER\",<br />\"UK_NATIONAL_INSURANCE_NUMBER\",<br />\"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER\",<br />\"BANK_ACCOUNT_NUMBER\",<br />\"BANK_ROUTING\",<br />\"PASSPORT_NUMBER\",<br />\"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER\",<br />\"SSN\"</p>\n","urlObject":{"protocol":"https","path":["api","v1","put-file-text"],"host":["api","cloudredaction","ai"],"query":[],"variable":[]}},"response":[{"id":"a3b41d23-3aec-40de-9147-dbe42cf9706c","name":"Put File Text","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"x-api-key","value":"cdd4a431562afa5a3933277acb9f6a6e","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"text","value":"Subject: Payment Information for Order #123456\nHi John,\nThank you for your recent order placed on 09/01/2025.\nTo confirm, here are the payment details we have on file:\n- Credit Card Number: 4111 1111 1111 1111  \n- CVV: 123  \n- Expiry Date: 12/27  \n- Name on Card: John Doe  \nWe also have the following details for verification:\n- Social Security Number (SSN): 123-45-6789  \n- Date of Birth: 08/15/1985  \nPlease ensure the above information is accurate. If there are any discrepancies, contact our support team immediately.\nRegards,  \nCustomer Support  \nsupport@example.com ","type":"text","uuid":"07751a4f-643b-4ff4-bc58-1a8ba2f5f9f6"},{"key":"type","value":"SSN,CREDIT_DEBIT_NUMBER,CREDIT_DEBIT_CVV,CREDIT_DEBIT_EXPIRY","type":"text","uuid":"d4b7492e-77d0-43df-bfb8-871f8cda5f63"}]},"url":"https://api.cloudredaction.ai/api/v1/put-file-text"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": true,\n    \"masked\": \"Subject: Payment Information for Order #123456\\n\\nHi John,\\n\\nThank you for your recent order placed on 09/01/2025.\\n\\nTo confirm, here are the payment details we have on file:\\n\\n- Credit Card Number: XXXX XXXX XXXX XXXX  \\n- CVV: XXX  \\n- Expiry Date: XX/XX  \\n- Name on Card: John Doe  \\n\\nWe also have the following details for verification:\\n\\n- Social Security Number (SSN): XXX-XX-XXXX  \\n- Date of Birth: 08/15/1985  \\n\\nPlease ensure the above information is accurate. If there are any discrepancies, contact our support team immediately.\\n\\nRegards,  \\nCustomer Support  \\nsupport@example.com\"\n}\n"}],"_postman_id":"abb9fcfa-c758-45f8-8f0e-a5c211a8b21c"}],"id":"cecae02b-40e8-48cd-8651-30ce41dc09f2","_postman_id":"cecae02b-40e8-48cd-8651-30ce41dc09f2","description":""}]}