{"info":{"_postman_id":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","name":"iDox.ai Data Privacy API","description":"

The iDox.ai Legal and Privacy API lets you build document sensitive data discovery and protection in your apps. You can do things like discovering PII in documents from file systems, pinpointing PII in a document, and redact PII in documents.

Before using the API, please sign-up iDox.ai developer account and get an API key.

We've posted a step-by-step tutorial on Medium to help you get started iDox.ai fast.

To use the iDox.ai API. there are two approaches. The first approach is to input text. The second approach is to upload a file, such as PDF and MS Word (doc and docx) , and then process the file by calling APIs.

Upload document get a job ID (jobId)
Find job status get a document ID (docId)
Call other API with the document ID (docId)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19495898","collectionId":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","publishedId":"Uyr7Gy7W","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-19T07:58:53.000Z"},"item":[{"name":"Upload and Download","item":[{"name":"Upload document","id":"08cf7cd7-2837-4c99-86ab-b9607a74dc42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"

The target file for analysis

\n","type":"file","src":"/Users/brian/Dropbox/Infogem/iDox.ai/Test Data/Redaction/Sample Personal Statement_2_0.pdf"},{"key":"callback","value":"","description":"

The callback URL. HTTP POST is supported.

\n","type":"text"}]},"url":"https://docs.idox.ai/api/v3/document-tool/pre-processing","description":"

Upload a document to iDox.ai. Multiple file types are supported, 42 in total; including:

PDF file
Microsoft Office files
Word - DOC, DOCX, DOCM, DOT, DOTX, DOTM
Excel - XLS, XLSX, XLSM, XLSB, XLT, XLTX, XLTM
PowerPoint - PPT, PPTX, PPTM, POT, POTX, POTM, PPS, PPSX, PPSM
Visio - VSD, VSDX
Image files
BMP, DIB, GIF, JFIF, JPE, JPEG, JPG, PJPG, PNG, TIF, TIFF
Text & rich text files
CSV, TEXT, TXT, RTF
HTML files
HTML, SHTML

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1fb4c334-d6e0-46aa-b05b-490f29f257f5","id":"1fb4c334-d6e0-46aa-b05b-490f29f257f5","name":"Upload and Download","type":"folder"}},"urlObject":{"path":["api","v3","document-tool","pre-processing"],"host":["https://docs.idox.ai"],"query":[],"variable":[]}},"response":[{"id":"f8f48892-8f03-417b-afe6-40f93caa8438","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"The target file for analysis","type":"file","value":null},{"key":"callback","value":"https://example/callback","description":"The call URL. HTTP POST is supported","type":"text"}]},"url":"https://docs.idox.ai/api/v3/document-tool/pre-processing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 07:43:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"1397"},{"key":"x-envoy-decorator-operation","value":"api-engine-gateway-preview.idoxai-in-house.svc.cluster.local:80/*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=2pGBlInyf1oTEXtDVYEjEcUSeQOPkuju78esJ8c%2FlODo2g%2Bth3jc4n9P8zS2U9qnp00yIo6%2B2qCqWptrUo19qstvW9Qc6Rtr9fxp4E7ryWL%2FB19hl2NFB%2Fz2I6QQVSdbnkyE13so\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6f0589b92a647d70-LAX"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"623acfb33797606f72d33a06\",\n \"taskCategory\": \"DOC_TOOL\",\n \"taskSubcategory\": \"PRE_PROCESSING\",\n \"status\": \"Processing\",\n \"startDateTime\": \"2022-03-23T07:43:47.685Z\",\n \"expirationDateTime\": \"2022-03-24T07:43:47.685Z\"\n}"}],"_postman_id":"08cf7cd7-2837-4c99-86ab-b9607a74dc42"},{"name":"Download document","id":"682c84b5-eb8a-4321-89b4-e673c0356a59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"url":"https://docs.idox.ai/api/v3/document-tool/:document-id/download","description":"

Download a document by document id from iDox.ai.

The document ID (docId) returned by the Find Job Status API.

The colon in front of document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"f154ab0b-0d4f-4a2c-962a-2e30a3db619a","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"url":{"raw":"https://docs.idox.ai/api/v3/document-tool/:document-id/download","host":["https://docs.idox.ai"],"path":["api","v3","document-tool",":document-id","download"],"variable":[{"id":"88bfa039-39e9-4467-8993-82e838ee7130","key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"682c84b5-eb8a-4321-89b4-e673c0356a59"}],"id":"1fb4c334-d6e0-46aa-b05b-490f29f257f5","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7d840144-1668-4736-baac-68d439c668a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff18f3cd-9f8a-493a-8340-ccd566d61eb4","type":"text/javascript","exec":[""]}}],"_postman_id":"1fb4c334-d6e0-46aa-b05b-490f29f257f5","description":""},{"name":"Job Status","item":[{"name":"Find job status","id":"3b61616d-82ce-44d7-bc0c-ae9c5e9db4fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Please sign-up iDox.ai and get an API key.

\n","key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY"},{"key":"Accept","value":"application/json; charset=utf-8"}],"url":"https://docs.idox.ai/api/v3/job/:job-id","description":"

Return the job status. Return the job status and document id if a document is uploaded.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"604448dc-a85b-442b-9c95-4f214c553b82","id":"604448dc-a85b-442b-9c95-4f214c553b82","name":"Job Status","type":"folder"}},"urlObject":{"path":["api","v3","job",":job-id"],"host":["https://docs.idox.ai"],"query":[],"variable":[{"description":{"content":"

The Job ID (jobId) dreturned by the Upload Document API.

The colon in front of the job-id (:job-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_job_id_here","key":"job-id"}]}},"response":[{"id":"0818e119-ae63-4bea-baa4-4b1fe4882208","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"url":{"raw":"https://docs.idox.ai/api/v3/job/:job-id","host":["https://docs.idox.ai"],"path":["api","v3","job",":job-id"],"variable":[{"key":"job-id","value":"623a69e83797606f72d338d5","description":"The Job ID (jobId) dreturned by the Upload Document API.\n\nThe colon in front of the job-id (:job-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:11:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"4"},{"key":"x-envoy-decorator-operation","value":"api-engine-gateway-preview.idoxai-in-house.svc.cluster.local:80/*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=YAX031K0FfZhoRtj0NEc3FkZB5cDy9N%2FMF5IEyjfKOb%2FGhmN520N3cVOmpVV9hJ78SdQpBA9ZRy80ZBx58QZf43xXlwKqCJ3gQEY5D6etpoMUG4CvpQRTUVa2sWHH66Z6C2VeOrw\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6f06b9bbaead7beb-LAX"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"623a69e83797606f72d338d5\",\n \"taskCategory\": \"DOC_TOOL\",\n \"taskSubcategory\": \"PRE_PROCESSING\",\n \"status\": \"Succeeded\",\n \"startDateTime\": \"2022-03-23T00:29:28.584Z\",\n \"completeDateTime\": \"2022-03-23T00:29:33.415Z\",\n \"expirationDateTime\": \"2022-03-24T00:29:28.584Z\",\n \"payload\": {\n \"filename\": \"Test 2 - Lisa.docx\",\n \"docId\": \"623a69e83797606f72d338d6\"\n }\n}"}],"_postman_id":"3b61616d-82ce-44d7-bc0c-ae9c5e9db4fc"}],"id":"604448dc-a85b-442b-9c95-4f214c553b82","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e6fb512d-1682-4eed-8c8f-03b0942417cb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"03fdc0c0-1623-4267-a237-8d17b0a637ae","type":"text/javascript","exec":[""]}}],"_postman_id":"604448dc-a85b-442b-9c95-4f214c553b82","description":""},{"name":"Privacy Protection","item":[{"name":"Redact document by coordinates","id":"8764dbd1-c2d6-43e0-a3d6-d364ffbd6e30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"rects\": [\n [\n 534,\n 747,\n 587,\n 759,\n 0\n ],\n [\n 534,\n 747,\n 587,\n 759,\n 0\n ],\n [\n 148,\n 582,\n 581,\n 717,\n 0\n ],\n [\n 206,\n 590,\n 411,\n 601,\n 0\n ],\n [\n 284,\n 579,\n 334,\n 588,\n 0\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/document-tool/:document-id/text-in-rects","description":"

Redact a PDF by a configuration of coordinates of several squares.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
rects	true	Coordinates of paragraphs, the order is left, bottom, right, top, and the page number.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"495c83a0-8e89-44fa-a426-d4c47026db7b","id":"495c83a0-8e89-44fa-a426-d4c47026db7b","name":"Privacy Protection","type":"folder"}},"urlObject":{"path":["api","v3","document-tool",":document-id","text-in-rects"],"host":["https://docs.idox.ai"],"query":[],"variable":[{"description":{"content":"

The document ID (docId) returned by the Find Job Status API.

The colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"70c70168-5450-4fbc-8420-542263f3786e","name":"200 Sucess","originalRequest":{"method":"POST","header":[{"description":"Please sign-up iDox.ai and get an API key. ","key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY"},{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json; charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"rects\": [\n [\n 534,\n 747,\n 587,\n 759,\n 0\n ],\n [\n 534,\n 747,\n 587,\n 759,\n 0\n ],\n [\n 148,\n 582,\n 581,\n 717,\n 0\n ],\n [\n 206,\n 590,\n 411,\n 601,\n 0\n ],\n [\n 284,\n 579,\n 334,\n 588,\n 0\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docs.idox.ai/api/v3/document-tool/:document-id/text-in-rects","host":["https://docs.idox.ai"],"path":["api","v3","document-tool",":document-id","text-in-rects"],"variable":[{"key":"document-id","value":"","description":"The document ID (doc-id) dreturned by the Job Status API.\n\nThe colon in front of the document-id (:jdocument-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 10:25:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"288"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"3290"},{"key":"x-envoy-decorator-operation","value":"traefik.ai-ingress.svc.cluster.local:80/*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"matchSentences\": [\n \"\",\n \"\",\n \"ity\\r\\nSCLOSURE AND CONFIDENTIALITY AGREEMENT\\r\\nure and Confidentiality Agreement (this “Agreement”) is entered into as of Aug. 1st, 2021\\r\\nate”) by and between:\\r\\ny: Carbon Corporation, as a(n) Corporation and\",\n \"rporation, as a(n) Corporation and\",\n \"\"\n ]\n}"}],"_postman_id":"8764dbd1-c2d6-43e0-a3d6-d364ffbd6e30"},{"name":"Redact document","id":"32b52d4c-1265-4e33-819a-acf7eb215f7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"redactTexts\": [\n \"Confidential\",\n \"information\"\n ],\n \"redactTextPages\": [\n 1,\n 3\n ],\n \"redactRectArray\": [\n [\n 0,\n 534,\n 747,\n 587,\n 759\n ]\n ],\n \"highlight\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/document-tool/:document-id/pdf-redactor","description":"

Redact or highlight a PDF by a configuration of the following information:

Keywords
Pages
Areas

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
redactTexts	false	Words to be redacted.
redactTextPages	false	Pages to be redacted
redactRectArray	false	Coordinates of squares to be masked
highlight	false	Whether to use highlight mode (`true`) or redaction (`false`) mode.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"495c83a0-8e89-44fa-a426-d4c47026db7b","id":"495c83a0-8e89-44fa-a426-d4c47026db7b","name":"Privacy Protection","type":"folder"}},"urlObject":{"path":["api","v3","document-tool",":document-id","pdf-redactor"],"host":["https://docs.idox.ai"],"query":[],"variable":[{"description":{"content":"

The document ID (docId) returned by the Find Job Status API.

The colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"939b0a43-c35f-4875-8550-577eba96d166","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"redactTexts\": [\n \"Confidential\",\n \"information\"\n ],\n \"redactTextPages\": [\n 1,\n 3\n ],\n \"redactRectArray\": [\n [\n 0,\n 534,\n 747,\n 587,\n 759\n ]\n ],\n \"highlight\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docs.idox.ai/api/v3/document-tool/:document-id/pdf-redactor","host":["https://docs.idox.ai"],"path":["api","v3","document-tool",":document-id","pdf-redactor"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API.\n\nThe colon in front of the document-id (:jdocument-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"32b52d4c-1265-4e33-819a-acf7eb215f7a"},{"name":"Async redactor-wizard","id":"1eea1c03-6c0b-48b3-974c-50b2c5953f87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","type":"text","description":"

Please sign-up iDox.ai and get an API key.

\n"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"highlight","value":"true","type":"text","description":"

Use this parameter to enable or disable the highlight option.

\n"},{"key":"markColor","value":"#8600FF","type":"text","description":"

Insert the hex color code to set the color for redactioin.

\n"},{"key":"categoriesFilter","value":"[Person,Organization,PersonType,PhoneNumber,Address,Email,DateTime,Temperature,Currency,Age,Percentage,CreditCardNumber,InternationalBankingAccountNumber,ABARoutingNumber,SWIFTCode,USIndividualTaxpayerIdentification,USSocialSecurityNumber,USDriversLicenseNumber,USUKPassportNumber,USBankAccountNumber]","type":"text","description":"

Insert the scanning entities for sensitive data filtering.

\n"},{"key":"region","value":"US","type":"text","description":"

Use region parameter to select entities that be contained in a specific region. US, UK, AU or disable this option.

\n"}]},"url":"https://docs.idox.ai/api/v3/convenience/redactor-wizard/async","description":"

This is a wizard API to combine the procedures for sensitive data discovery and redaction from a document. This is an async mode API.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"495c83a0-8e89-44fa-a426-d4c47026db7b","id":"495c83a0-8e89-44fa-a426-d4c47026db7b","name":"Privacy Protection","type":"folder"}},"urlObject":{"path":["api","v3","convenience","redactor-wizard","async"],"host":["https://docs.idox.ai"],"query":[],"variable":[]}},"response":[{"id":"16d4ca36-c96c-4f7c-988f-687b894b8ae0","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","type":"text","description":"Please sign-up iDox.ai and get an API key."}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"highlight","value":"true","type":"text","description":"Use this parameter to enable or disable the highlight option. "},{"key":"markColor","value":"#8600FF","type":"text","description":"Insert the hex color code to set the color for redactioin. "},{"key":"categoriesFilter","value":"[Person,Organization,PersonType,PhoneNumber,Address,Email,DateTime,Temperature,Currency,Age,Percentage,CreditCardNumber,InternationalBankingAccountNumber,ABARoutingNumber,SWIFTCode,USIndividualTaxpayerIdentification,USSocialSecurityNumber,USDriversLicenseNumber,USUKPassportNumber,USBankAccountNumber]","type":"text","description":"Insert the scanning entities for sensitive data filtering. "},{"key":"region","value":"US","type":"text","description":"Use region parameter to select entities that be contained in a specific region. US, UK, AU or disable this option. "}]},"url":"https://docs.idox.ai/api/v3/convenience/redactor-wizard/async"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1eea1c03-6c0b-48b3-974c-50b2c5953f87"}],"id":"495c83a0-8e89-44fa-a426-d4c47026db7b","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"35cf3419-9514-49b4-951c-178e62bef4d5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"686268a0-1078-44c0-9e07-79170c798e97","type":"text/javascript","exec":[""]}}],"_postman_id":"495c83a0-8e89-44fa-a426-d4c47026db7b","description":""},{"name":"Sensitive Data Discovery","item":[{"name":"Document PII discovery","id":"7e6f3380-d321-4cc1-bf5d-4b0fc6339ba4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"confidenceScore\": 0.0,\n \"categoriesFilter\": [\"Person\", \"PhoneNumber\", \"Email\", \"Data\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/ner/:document-id/pii","description":"

Discover PII information from a document. Support the file types uploaded from \"Upload document\" API.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
categoriesFilter	false	Return the designated entity categories. The supported categories are listed below this table. Empty array [] to return all PII categories. Only PII entities fill in array to return filled in related PII categories. Only PHI entities fill in array to return filled in related PHI categories and all PII categories. PII and PHI entities fill in array to return filled in related PII and PHI categories.

Entity Categories

This API supports 80 types of categories.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code Name	Country	Remark
Person	All	(PII)
Organization	All	(PII)
PersonType	All	(PII)
Address	All	(PII)
ZipCode	All	(PII) First three digits of a zip code
Location	All	(PII) LocationAllIncludes names like cities, countries, regions, states manmade structures, and geographical locations, like rivers, oceans, and deserts.
Email	All	(PII)
FaxNumber	All	(PII)
DateTime	All	(PII)
Temperature	All	(PII)
Currency	All	(PII)
Age	All	(PII)
Percentage	All	(PII)
CreditCardNumber	All	(PII)
InternationalBankingAccountNumber	All	(PII) IBAN
Gender	All	(PII) Terms that disclose the gender of the subject, e.g., male, female, woman, gentleman, or lady.
SWIFTCode	All
SocialMediaUrl	All	(PII) It supports the social media account detection: * Twitter username * Facebook username * YouTube account * Vimeo account * Instagrame username * LinkedIn URL * Pinterest username
HumanRace	All	(PII) Examples: \"African\", \"Asian\", \"European\", \"Native American\", \"Oceanian\"
ReligiousView	All	(PII) Example: \"Judaism\", \"Catholic\"
SexualPreference	All	(PII) Example: \"bisexual\", \"homosexual\", \"heterosexual\"
PoliticalAffiliation	All	(PII) Example: \"Democratic Party (United States)\" or \"Republican Party (United States)\"
CountryCode	All	(PII) Example: +591, +886
Language	All	(PII) Example: English, French
Occupation	All	(PII) Example: Scientist, Doctor
BloodType	All	(PII) eg. A, B, AB, O
MaritalStatus	All	(PII) eg. Married, Single, Divorced
IP	All	(PII) Network IP4 and IP6 address. Example: 168.131.1.1 and 21DA:D3:0:2F3B:2AA:FF:FE28:9C5A
ABARoutingNumber	US	(PII)
USPhoneNumber	US	(PII)
USIndividualTaxpayerIdentification	US	(PII)
USSocialSecurityNumber	US	(PII)
USDriversLicenseNumber	US	(PII)
USUKPassportNumber	US and UK	(PII) Context-aware cognition. Needs passport number text around numbers.
USBankAccountNumber	US	(PII)
ACHRoutingNumber	US	(PII) Automatic Clearing House number
InsuranceProvider	US	(PII)
MemberID	US	(PII) Insurance member ID number
GroupID	US	Insurance group number
AUDriversLicense	Australia	(PII) Insurance group number
AUPassportNumber	Australia	(PII) Insurance group number
AUBusinessNumber	Australia	(PII) Australia business number
BSBCode	Australia	(PII) Bank state branch code
AUSTRALIAPhoneNumber	Australia	(PII)
CustomerReferenceNumber	Australia	(PII) A CRN is 9 numbers and ends with a letter. For example: 123 456 789A.
TaxFileNumber	Australia	(PII) A tax file number (TFN) is free and identifies the user for tax and superannuation purposes.
UKDriversLicenseNumber	UK	(PII) UK driver license number
CommunityHealthIndex	UK	(PII) Community Health Index (CHI) number, e.g. 0911640250
UKNationalHealthNumber	UK	(PII) National Health Service (NHS) number
UKNationalInsuranceNumber	UK	(PII) National insurance number
UKNationalHealthNumber	UK	(PII) National Health Service number
UKPhoneNumber	UK	(PII) U.K. phone number
ExaminationName	All	Examination (PHI); diagnostic procedures and tests, including vital signs and body measurements
Diagnosis	All	Diagnosis (PHI); disease, syndrome, poisoning
SymptomOrSign	All	Symptom (PHI); subjective or objective evidence of disease or other diagnoses
TreatmentName	All	Treatment (PHI); therapeutic procedures
Allergen	All	Allergen (PHI); an antigen triggering an allergic reaction
Course	All	Course (PHI); description of a change in another entity over time, such as condition progression, a course of treatment or medication
MeasurementValue	All	Measurement value (PHI); the value related to an examination or a medical condition measurement
Variant	All	Variant (PHI); all mentions of gene variations and mutations
GeneOrProtein	All	Gene/Protein (PHI); all mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins
MutationType	All	Mutation type (PHI); description of the mutation, including its type, effect, and location
Expression	All	Expression (PHI); gene expression level
AdministrativeEvent	All	Administrative event (PHI); events that relate to the healthcare system but of an administrative/semi-administrative nature
CareEnvironment	All	Care environment (PHI); an environment or location where patients are given care
ConditionQualifier	All	Condition qualifier (PHI); qualitative terms that are used to describe a medical condition
MedicationName	All	Medication name (PHI); medication mentions, including copyrighted brand names, and non-brand names
Dosage	All	Dosage (PHI); amount of medication ordered
FamilyRelation	All	Family relation (PHI); mentions of family relatives of the subject
BodyStructure	All	Body structure (PHI); body systems, anatomic locations or regions, and body sites
Direction	All	Direction (PHI); directional terms that may relate to a body structure, medical condition, examination, or treatment
Frequency	All	Frequency (PHI); describes how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur
Time	All	Time (PHI); temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event
MeasurementUnit	All	Measurement unit (PHI); the unit of measurement related to an examination or a medical condition measurement
RelationalOperator	All	Relational operator (PHI); phrases that express the quantitative relation between an entity and some additional information
HealthcareProfession	All	Healthcare profession (PHI); a healthcare practitioner licensed or non-licensed
ConditionScale	All	Condition scale (PHI); qualitative terms that characterize the condition by a scale, which is a finite ordered list of values
MedicationClass	All	Medication class (PHI); a set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease
MedicationForm	All	Medication form (PHI); the form of the medication
MedicationRoute	All	Medication route (PHI); the administration method of medication

The document ID (docId) returned by the Find Job Status API.

The colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"4bd547ef-9740-4878-af66-d12538324647","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"confidenceScore\": 0.0,\n \"categoriesFilter\": [\"Person\", \"PhoneNumber\", \"Email\", \"Data\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docs.idox.ai/api/v3/ner/:document-id/pii","host":["https://docs.idox.ai"],"path":["api","v3","ner",":document-id","pii"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API.\n\nThe colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Mar 2022 11:20:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"754"},{"key":"x-envoy-decorator-operation","value":"api-engine-gateway-preview.idoxai-in-house.svc.cluster.local:80/*"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=H%2FWXtRlcit%2B0%2BwrBg1Yf0CzDxfuegmpJzfhguJTlkOH5I250eQKoeM7Adidc%2FUgbkzImkViTUWvjvutyiuzjf4XF36JHatXQnw0dQc42X7xkYgOQCgH5vp7cuFuGG1ZwD1gY2%2Fw8\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"6f06c72d1e467ebf-LAX"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"paragraph\": \" LAW PC \\r\\n DREW PIUNTI \\r\\nANDREW J. PIUNTI \\r\\n\",\n \"entities\": [\n {\n \"text\": \"DREW PIUNTI\",\n \"category\": \"Person\",\n \"subcategory\": \"\",\n \"confidenceScore\": 0.95,\n \"offset\": 11,\n \"length\": 11\n },\n {\n \"text\": \"ANDREW J. PIUNTI\",\n \"category\": \"Person\",\n \"subcategory\": \"\",\n \"confidenceScore\": 0.99,\n \"offset\": 25,\n \"length\": 16\n }\n ]\n }\n ]\n}"}],"_postman_id":"7e6f3380-d321-4cc1-bf5d-4b0fc6339ba4"},{"name":"Async document PII discovery","id":"0ede1f5e-a37e-4df5-940c-c083513d865c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"confidenceScore\": 0.7,\n \"categoriesFilter\": [\"Person\", \"PhoneNumber\", \"Email\", \"Date\"],\n \"callback\": \"http://examplehost:8080/examplepath\"\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/ner/:document-id/pii/async","description":"

Discover PII information from a document. Support the file types uploaded from \"Upload document\" API. This is an async mode API.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
categoriesFilter	false	Return the designated entity categories. The supported categories are listed below this table. Empty array [] to return all PII categories. Only PII entities fill in array to return filled in related PII categories. Only PHI entities fill in array to return filled in related PHI categories and all PII categories. PII and PHI entities fill in array to return filled in related PII and PHI categories.
callback	false	The callback URL. HTTP `POST` is supported.

Entity Categories

This API supports 80 types of categories.

Code Name	Country	Remark
Person	All	(PII)
Organization	All	(PII)
PersonType	All	(PII)
Address	All	(PII)
ZipCode	All	(PII) First three digits of a zip code
Location	All	(PII) LocationAllIncludes names like cities, countries, regions, states manmade structures, and geographical locations, like rivers, oceans, and deserts.
Email	All	(PII)
FaxNumber	All	(PII)
DateTime	All	(PII)
Temperature	All	(PII)
Currency	All	(PII)
Age	All	(PII)
Percentage	All	(PII)
CreditCardNumber	All	(PII)
InternationalBankingAccountNumber	All	(PII) IBAN
Gender	All	(PII) Terms that disclose the gender of the subject, e.g., male, female, woman, gentleman, or lady.
SWIFTCode	All
SocialMediaUrl	All	(PII) It supports the social media account detection: * Twitter username * Facebook username * YouTube account * Vimeo account * Instagrame username * LinkedIn URL * Pinterest username
HumanRace	All	(PII) Examples: \"African\", \"Asian\", \"European\", \"Native American\", \"Oceanian\"
ReligiousView	All	(PII) Example: \"Judaism\", \"Catholic\"
SexualPreference	All	(PII) Example: \"bisexual\", \"homosexual\", \"heterosexual\"
PoliticalAffiliation	All	(PII) Example: \"Democratic Party (United States)\" or \"Republican Party (United States)\"
CountryCode	All	(PII) Example: +591, +886
Language	All	(PII) Example: English, French
Occupation	All	(PII) Example: Scientist, Doctor
BloodType	All	(PII) eg. A, B, AB, O
MaritalStatus	All	(PII) eg. Married, Single, Divorced
IP	All	(PII) Network IP4 and IP6 address. Example: 168.131.1.1 and 21DA:D3:0:2F3B:2AA:FF:FE28:9C5A
ABARoutingNumber	US	(PII)
USPhoneNumber	US	(PII)
USIndividualTaxpayerIdentification	US	(PII)
USSocialSecurityNumber	US	(PII)
USDriversLicenseNumber	US	(PII)
USUKPassportNumber	US and UK	(PII) Context-aware cognition. Needs passport number text around numbers.
USBankAccountNumber	US	(PII)
ACHRoutingNumber	US	(PII) Automatic Clearing House number
InsuranceProvider	US	(PII)
MemberID	US	(PII) Insurance member ID number
GroupID	US	Insurance group number
AUDriversLicense	Australia	(PII) Insurance group number
AUPassportNumber	Australia	(PII) Insurance group number
AUBusinessNumber	Australia	(PII) Australia business number
BSBCode	Australia	(PII) Bank state branch code
AUSTRALIAPhoneNumber	Australia	(PII)
CustomerReferenceNumber	Australia	(PII) A CRN is 9 numbers and ends with a letter. For example: 123 456 789A.
TaxFileNumber	Australia	(PII) A tax file number (TFN) is free and identifies the user for tax and superannuation purposes.
UKDriversLicenseNumber	UK	(PII) UK driver license number
CommunityHealthIndex	UK	(PII) Community Health Index (CHI) number, e.g. 0911640250
UKNationalHealthNumber	UK	(PII) National Health Service (NHS) number
UKNationalInsuranceNumber	UK	(PII) National insurance number
UKNationalHealthNumber	UK	(PII) National Health Service number
UKPhoneNumber	UK	(PII) U.K. phone number
ExaminationName	All	Examination (PHI); diagnostic procedures and tests, including vital signs and body measurements
Diagnosis	All	Diagnosis (PHI); disease, syndrome, poisoning
SymptomOrSign	All	Symptom (PHI); subjective or objective evidence of disease or other diagnoses
TreatmentName	All	Treatment (PHI); therapeutic procedures
Allergen	All	Allergen (PHI); an antigen triggering an allergic reaction
Course	All	Course (PHI); description of a change in another entity over time, such as condition progression, a course of treatment or medication
MeasurementValue	All	Measurement value (PHI); the value related to an examination or a medical condition measurement
Variant	All	Variant (PHI); all mentions of gene variations and mutations
GeneOrProtein	All	Gene/Protein (PHI); all mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins
MutationType	All	Mutation type (PHI); description of the mutation, including its type, effect, and location
Expression	All	Expression (PHI); gene expression level
AdministrativeEvent	All	Administrative event (PHI); events that relate to the healthcare system but of an administrative/semi-administrative nature
CareEnvironment	All	Care environment (PHI); an environment or location where patients are given care
ConditionQualifier	All	Condition qualifier (PHI); qualitative terms that are used to describe a medical condition
MedicationName	All	Medication name (PHI); medication mentions, including copyrighted brand names, and non-brand names
Dosage	All	Dosage (PHI); amount of medication ordered
FamilyRelation	All	Family relation (PHI); mentions of family relatives of the subject
BodyStructure	All	Body structure (PHI); body systems, anatomic locations or regions, and body sites
Direction	All	Direction (PHI); directional terms that may relate to a body structure, medical condition, examination, or treatment
Frequency	All	Frequency (PHI); describes how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur
Time	All	Time (PHI); temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event
MeasurementUnit	All	Measurement unit (PHI); the unit of measurement related to an examination or a medical condition measurement
RelationalOperator	All	Relational operator (PHI); phrases that express the quantitative relation between an entity and some additional information
HealthcareProfession	All	Healthcare profession (PHI); a healthcare practitioner licensed or non-licensed
ConditionScale	All	Condition scale (PHI); qualitative terms that characterize the condition by a scale, which is a finite ordered list of values
MedicationClass	All	Medication class (PHI); a set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease
MedicationForm	All	Medication form (PHI); the form of the medication
MedicationRoute	All	Medication route (PHI); the administration method of medication

The document ID (docId) returned by the Find Job Status API.

The colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"7af86c58-7013-400f-bb6a-51af6ce69987","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"confidenceScore\": 0.7,\n \"categoriesFilter\": [\"Person\", \"PhoneNumber\", \"Email\", \"Date\"],\n \"callback\": \"http://examplehost:8080/examplepath\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docs.idox.ai/api/v3/ner/:document-id/pii/async","host":["https://docs.idox.ai"],"path":["api","v3","ner",":document-id","pii","async"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API.\n\nThe colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"6142b5bc983efe5d2f12fe65\",\n \"taskCategory\": \"NER\",\n \"taskSubcategory\": \"PII\",\n \"status\": \"Processing\",\n \"startDateTime\": \"2021-09-16T03:10:52.546Z\",\n \"expirationDateTime\": \"2021-09-17T03:10:52.546Z\"\n}"}],"_postman_id":"0ede1f5e-a37e-4df5-940c-c083513d865c"},{"name":"Async content PII discovery","id":"5d71fd57-8040-44a2-9219-62fadcdc994a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paragraphs\": [\n \"Pyroclastic flows at La Soufriere could possibly cause destruction and devastation of areas close to the volcano, according to NEMO.\",\n \"Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.\",\n \"The University of the West Indies Seismic Research Centre tweeted photos taken by one of its researchers Sunday morning of an ash covered landscape in St. Vincent, using the hashtag #stilldangerous.\"\n ],\n \"confidenceScore\": 0.7,\n \"categoriesFilter\": [\"Person\", \"PhoneNumber\", \"Email\", \"Date\"],\n \"callback\": \"http://examplehost:8080/examplepath\"\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/ner/pii/async","description":"

Discover PII information from text contents. This is an async mode API.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
paragraphs	true	Target content for analysis. The format is a JSON array. The maximum number of array values is 5. The maximum length of an array value is 5210 characters.
callback	false	The callback URL. HTTP `POST` is supported.
categoriesFilter	false	Return the designated entity categories. The supported categories are listed below this table. Empty array [] to return all PII categories. Only PII entities fill in array to return filled in related PII categories. Only PHI entities fill in array to return filled in related PHI categories and all PII categories. PII and PHI entities fill in array to return filled in related PII and PHI categories.

Entity Categories

This API supports 80 types of categories.

Code Name	Country	Remark
Person	All	(PII)
Organization	All	(PII)
PersonType	All	(PII)
Address	All	(PII)
ZipCode	All	(PII) First three digits of a zip code
Location	All	(PII) LocationAllIncludes names like cities, countries, regions, states manmade structures, and geographical locations, like rivers, oceans, and deserts.
Email	All	(PII)
FaxNumber	All	(PII)
DateTime	All	(PII)
Temperature	All	(PII)
Currency	All	(PII)
Age	All	(PII)
Percentage	All	(PII)
CreditCardNumber	All	(PII)
InternationalBankingAccountNumber	All	(PII) IBAN
Gender	All	(PII) Terms that disclose the gender of the subject, e.g., male, female, woman, gentleman, or lady.
SWIFTCode	All
SocialMediaUrl	All	(PII) It supports the social media account detection: * Twitter username * Facebook username * YouTube account * Vimeo account * Instagrame username * LinkedIn URL * Pinterest username
HumanRace	All	(PII) Examples: \"African\", \"Asian\", \"European\", \"Native American\", \"Oceanian\"
ReligiousView	All	(PII) Example: \"Judaism\", \"Catholic\"
SexualPreference	All	(PII) Example: \"bisexual\", \"homosexual\", \"heterosexual\"
PoliticalAffiliation	All	(PII) Example: \"Democratic Party (United States)\" or \"Republican Party (United States)\"
CountryCode	All	(PII) Example: +591, +886
Language	All	(PII) Example: English, French
Occupation	All	(PII) Example: Scientist, Doctor
BloodType	All	(PII) eg. A, B, AB, O
MaritalStatus	All	(PII) eg. Married, Single, Divorced
IP	All	(PII) Network IP4 and IP6 address. Example: 168.131.1.1 and 21DA:D3:0:2F3B:2AA:FF:FE28:9C5A
ABARoutingNumber	US	(PII)
USPhoneNumber	US	(PII)
USIndividualTaxpayerIdentification	US	(PII)
USSocialSecurityNumber	US	(PII)
USDriversLicenseNumber	US	(PII)
USUKPassportNumber	US and UK	(PII) Context-aware cognition. Needs passport number text around numbers.
USBankAccountNumber	US	(PII)
ACHRoutingNumber	US	(PII) Automatic Clearing House number
InsuranceProvider	US	(PII)
MemberID	US	(PII) Insurance member ID number
GroupID	US	Insurance group number
AUDriversLicense	Australia	(PII) Insurance group number
AUPassportNumber	Australia	(PII) Insurance group number
AUBusinessNumber	Australia	(PII) Australia business number
BSBCode	Australia	(PII) Bank state branch code
AUSTRALIAPhoneNumber	Australia	(PII)
CustomerReferenceNumber	Australia	(PII) A CRN is 9 numbers and ends with a letter. For example: 123 456 789A.
TaxFileNumber	Australia	(PII) A tax file number (TFN) is free and identifies the user for tax and superannuation purposes.
UKDriversLicenseNumber	UK	(PII) UK driver license number
CommunityHealthIndex	UK	(PII) Community Health Index (CHI) number, e.g. 0911640250
UKNationalHealthNumber	UK	(PII) National Health Service (NHS) number
UKNationalInsuranceNumber	UK	(PII) National insurance number
UKNationalHealthNumber	UK	(PII) National Health Service number
UKPhoneNumber	UK	(PII) U.K. phone number
ExaminationName	All	Examination (PHI); diagnostic procedures and tests, including vital signs and body measurements
Diagnosis	All	Diagnosis (PHI); disease, syndrome, poisoning
SymptomOrSign	All	Symptom (PHI); subjective or objective evidence of disease or other diagnoses
TreatmentName	All	Treatment (PHI); therapeutic procedures
Allergen	All	Allergen (PHI); an antigen triggering an allergic reaction
Course	All	Course (PHI); description of a change in another entity over time, such as condition progression, a course of treatment or medication
MeasurementValue	All	Measurement value (PHI); the value related to an examination or a medical condition measurement
Variant	All	Variant (PHI); all mentions of gene variations and mutations
GeneOrProtein	All	Gene/Protein (PHI); all mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins
MutationType	All	Mutation type (PHI); description of the mutation, including its type, effect, and location
Expression	All	Expression (PHI); gene expression level
AdministrativeEvent	All	Administrative event (PHI); events that relate to the healthcare system but of an administrative/semi-administrative nature
CareEnvironment	All	Care environment (PHI); an environment or location where patients are given care
ConditionQualifier	All	Condition qualifier (PHI); qualitative terms that are used to describe a medical condition
MedicationName	All	Medication name (PHI); medication mentions, including copyrighted brand names, and non-brand names
Dosage	All	Dosage (PHI); amount of medication ordered
FamilyRelation	All	Family relation (PHI); mentions of family relatives of the subject
BodyStructure	All	Body structure (PHI); body systems, anatomic locations or regions, and body sites
Direction	All	Direction (PHI); directional terms that may relate to a body structure, medical condition, examination, or treatment
Frequency	All	Frequency (PHI); describes how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur
Time	All	Time (PHI); temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event
MeasurementUnit	All	Measurement unit (PHI); the unit of measurement related to an examination or a medical condition measurement
RelationalOperator	All	Relational operator (PHI); phrases that express the quantitative relation between an entity and some additional information
HealthcareProfession	All	Healthcare profession (PHI); a healthcare practitioner licensed or non-licensed
ConditionScale	All	Condition scale (PHI); qualitative terms that characterize the condition by a scale, which is a finite ordered list of values
MedicationClass	All	Medication class (PHI); a set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease
MedicationForm	All	Medication form (PHI); the form of the medication
MedicationRoute	All	Medication route (PHI); the administration method of medication

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paragraphs\": [\n \"The Kremlin and the West held out the possibility of a diplomatic path out of the Ukraine crisis, even as Russia appeared to continue preparations for a potential invasion, including moving troops and military hardware closer to its neighbor.\",\n \"At a made-for-television meeting with President Vladimir Putin, Foreign Minister Sergey Lavrov signaled Monday that Russia was ready to keep talking about the security grievances that have led to the crisis.\",\n \"The University of the West Indies Seismic Research Centre tweeted photos taken by one of its researchers Sunday morning of an ash covered landscape in St. Vincent, using the hashtag #stilldangerous.\"\n ],\n \"confidenceScore\": 0.7,\n \"categoriesFilter\": [\"Person\", \"PhoneNumber\", \"Email\", \"Date\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/ner/pii","description":"

Discover PII information from textual contents.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
paragraphs	true	Target content for analysis. The format is a JSON array. The maximum number of array values is 5. The maximum length of an array value is 5120 characters.
categoriesFilter	false	Return the designated entity categories. The supported categories are listed below this table. Empty array [] to return all PII categories. Only PII entities fill in array to return filled in related PII categories. Only PHI entities fill in array to return filled in related PHI categories and all PII categories. PII and PHI entities fill in array to return filled in related PII and PHI categories.

Entity Categories

This API supports 80 types of categories.

Code Name	Country	Remark
Person	All	(PII)
Organization	All	(PII)
PersonType	All	(PII)
Address	All	(PII)
ZipCode	All	(PII) First three digits of a zip code
Location	All	(PII) LocationAllIncludes names like cities, countries, regions, states manmade structures, and geographical locations, like rivers, oceans, and deserts.
Email	All	(PII)
FaxNumber	All	(PII)
DateTime	All	(PII)
Temperature	All	(PII)
Currency	All	(PII)
Age	All	(PII)
Percentage	All	(PII)
CreditCardNumber	All	(PII)
InternationalBankingAccountNumber	All	(PII) IBAN
Gender	All	(PII) Terms that disclose the gender of the subject, e.g., male, female, woman, gentleman, or lady.
SWIFTCode	All
SocialMediaUrl	All	(PII) It supports the social media account detection: * Twitter username * Facebook username * YouTube account * Vimeo account * Instagrame username * LinkedIn URL * Pinterest username
HumanRace	All	(PII) Examples: \"African\", \"Asian\", \"European\", \"Native American\", \"Oceanian\"
ReligiousView	All	(PII) Example: \"Judaism\", \"Catholic\"
SexualPreference	All	(PII) Example: \"bisexual\", \"homosexual\", \"heterosexual\"
PoliticalAffiliation	All	(PII) Example: \"Democratic Party (United States)\" or \"Republican Party (United States)\"
CountryCode	All	(PII) Example: +591, +886
Language	All	(PII) Example: English, French
Occupation	All	(PII) Example: Scientist, Doctor
BloodType	All	(PII) eg. A, B, AB, O
MaritalStatus	All	(PII) eg. Married, Single, Divorced
IP	All	(PII) Network IP4 and IP6 address. Example: 168.131.1.1 and 21DA:D3:0:2F3B:2AA:FF:FE28:9C5A
ABARoutingNumber	US	(PII)
USPhoneNumber	US	(PII)
USIndividualTaxpayerIdentification	US	(PII)
USSocialSecurityNumber	US	(PII)
USDriversLicenseNumber	US	(PII)
USUKPassportNumber	US and UK	(PII) Context-aware cognition. Needs passport number text around numbers.
USBankAccountNumber	US	(PII)
ACHRoutingNumber	US	(PII) Automatic Clearing House number
InsuranceProvider	US	(PII)
MemberID	US	(PII) Insurance member ID number
GroupID	US	Insurance group number
AUDriversLicense	Australia	(PII) Insurance group number
AUPassportNumber	Australia	(PII) Insurance group number
AUBusinessNumber	Australia	(PII) Australia business number
BSBCode	Australia	(PII) Bank state branch code
AUSTRALIAPhoneNumber	Australia	(PII)
CustomerReferenceNumber	Australia	(PII) A CRN is 9 numbers and ends with a letter. For example: 123 456 789A.
TaxFileNumber	Australia	(PII) A tax file number (TFN) is free and identifies the user for tax and superannuation purposes.
UKDriversLicenseNumber	UK	(PII) UK driver license number
CommunityHealthIndex	UK	(PII) Community Health Index (CHI) number, e.g. 0911640250
UKNationalHealthNumber	UK	(PII) National Health Service (NHS) number
UKNationalInsuranceNumber	UK	(PII) National insurance number
UKNationalHealthNumber	UK	(PII) National Health Service number
UKPhoneNumber	UK	(PII) U.K. phone number
ExaminationName	All	Examination (PHI); diagnostic procedures and tests, including vital signs and body measurements
Diagnosis	All	Diagnosis (PHI); disease, syndrome, poisoning
SymptomOrSign	All	Symptom (PHI); subjective or objective evidence of disease or other diagnoses
TreatmentName	All	Treatment (PHI); therapeutic procedures
Allergen	All	Allergen (PHI); an antigen triggering an allergic reaction
Course	All	Course (PHI); description of a change in another entity over time, such as condition progression, a course of treatment or medication
MeasurementValue	All	Measurement value (PHI); the value related to an examination or a medical condition measurement
Variant	All	Variant (PHI); all mentions of gene variations and mutations
GeneOrProtein	All	Gene/Protein (PHI); all mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins
MutationType	All	Mutation type (PHI); description of the mutation, including its type, effect, and location
Expression	All	Expression (PHI); gene expression level
AdministrativeEvent	All	Administrative event (PHI); events that relate to the healthcare system but of an administrative/semi-administrative nature
CareEnvironment	All	Care environment (PHI); an environment or location where patients are given care
ConditionQualifier	All	Condition qualifier (PHI); qualitative terms that are used to describe a medical condition
MedicationName	All	Medication name (PHI); medication mentions, including copyrighted brand names, and non-brand names
Dosage	All	Dosage (PHI); amount of medication ordered
FamilyRelation	All	Family relation (PHI); mentions of family relatives of the subject
BodyStructure	All	Body structure (PHI); body systems, anatomic locations or regions, and body sites
Direction	All	Direction (PHI); directional terms that may relate to a body structure, medical condition, examination, or treatment
Frequency	All	Frequency (PHI); describes how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur
Time	All	Time (PHI); temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event
MeasurementUnit	All	Measurement unit (PHI); the unit of measurement related to an examination or a medical condition measurement
RelationalOperator	All	Relational operator (PHI); phrases that express the quantitative relation between an entity and some additional information
HealthcareProfession	All	Healthcare profession (PHI); a healthcare practitioner licensed or non-licensed
ConditionScale	All	Condition scale (PHI); qualitative terms that characterize the condition by a scale, which is a finite ordered list of values
MedicationClass	All	Medication class (PHI); a set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease
MedicationForm	All	Medication form (PHI); the form of the medication
MedicationRoute	All	Medication route (PHI); the administration method of medication

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"52973ebf-4eb5-4ab7-ae7a-37f22b4a3170","id":"52973ebf-4eb5-4ab7-ae7a-37f22b4a3170","name":"Sensitive Data Discovery","type":"folder"}},"urlObject":{"path":["api","v3","ner","pii"],"host":["https://docs.idox.ai"],"query":[],"variable":[]}},"response":[{"id":"feb1c9c2-55c3-4f48-a041-f5e44a5b2c15","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paragraphs\": [\n \"The Kremlin and the West held out the possibility of a diplomatic path out of the Ukraine crisis, even as Russia appeared to continue preparations for a potential invasion, including moving troops and military hardware closer to its neighbor.\",\n \"At a made-for-television meeting with President Vladimir Putin, Foreign Minister Sergey Lavrov signaled Monday that Russia was ready to keep talking about the security grievances that have led to the crisis.\",\n \"The University of the West Indies Seismic Research Centre tweeted photos taken by one of its researchers Sunday morning of an ash covered landscape in St. Vincent, using the hashtag #stilldangerous.\"\n ],\n \"confidenceScore\": 0.7,\n \"categoriesFilter\": [\"Person\", \"PhoneNumber\", \"Email\", \"Date\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/ner/pii"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:09:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1076"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"2098"},{"key":"x-envoy-decorator-operation","value":"traefik.ai-ingress.svc.cluster.local:80/*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"paragraph\": \"The Kremlin and the West held out the possibility of a diplomatic path out of the Ukraine crisis, even as Russia appeared to continue preparations for a potential invasion, including moving troops and military hardware closer to its neighbor.\",\n \"entities\": []\n },\n {\n \"paragraph\": \"At a made-for-television meeting with President Vladimir Putin, Foreign Minister Sergey Lavrov signaled Monday that Russia was ready to keep talking about the security grievances that have led to the crisis.\",\n \"entities\": [\n {\n \"text\": \"Vladimir Putin\",\n \"category\": \"Person\",\n \"subcategory\": \"\",\n \"confidenceScore\": 0.99,\n \"offset\": 48,\n \"length\": 14\n },\n {\n \"text\": \"Sergey Lavrov\",\n \"category\": \"Person\",\n \"subcategory\": \"\",\n \"confidenceScore\": 0.99,\n \"offset\": 81,\n \"length\": 13\n },\n {\n \"text\": \"Monday\",\n \"category\": \"DateTime\",\n \"subcategory\": \"Date\",\n \"confidenceScore\": 0.8,\n \"offset\": 104,\n \"length\": 6\n }\n ]\n },\n {\n \"paragraph\": \"The University of the West Indies Seismic Research Centre tweeted photos taken by one of its researchers Sunday morning of an ash covered landscape in St. Vincent, using the hashtag #stilldangerous.\",\n \"entities\": []\n }\n ]\n}"}],"_postman_id":"0fed565e-3482-40e3-bd29-b12eedaa2c03"}],"id":"52973ebf-4eb5-4ab7-ae7a-37f22b4a3170","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"377131cf-9c10-4b72-9f14-83f26ab9b304","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3263a2f6-9f3c-4871-8d5d-6ee6baf5fb12","type":"text/javascript","exec":[""]}}],"_postman_id":"52973ebf-4eb5-4ab7-ae7a-37f22b4a3170","description":""},{"name":"Table Extraction","item":[{"name":"Async table extraction","id":"69eef067-3952-4243-b909-c47805026e42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","type":"text","description":"

Please sign-up iDox.ai and get an API key.

\n"}],"body":{"mode":"raw","raw":"{\r\n \"callback\": \"http://examplehost:8080/examplepath\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/layout/:document-id/table-extraction/async","description":"

Extract the tables from a document. Support the file types uploaded from \"Upload document\" API. This is an async mode API.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"idox-api-engine-key"},{"key":"value","value":"SIGN_UP_TO_GET_KEY"}]},"isInherited":true,"source":{"_postman_id":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","id":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","name":"iDox.ai Data Privacy API","type":"collection"}},"urlObject":{"path":["api","v3","layout",":document-id","table-extraction","async"],"host":["https://docs.idox.ai"],"query":[],"variable":[{"id":"3fbbf555-839e-4a58-ba73-364efaec2539","description":{"content":"

The document ID (docId) returned by the Find Job Status API.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"dd5be1f3-bed0-44bf-9a6b-955a3a348940","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","type":"text","description":"Please sign-up iDox.ai and get an API key."}],"body":{"mode":"raw","raw":"{\r\n \"callback\": \"http://examplehost:8080/examplepath\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docs.idox.ai/api/v3/layout/:document-id/table-extraction/async","host":["https://docs.idox.ai"],"path":["api","v3","layout",":document-id","table-extraction","async"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"X-Frame-Options","value":"sameorigin","description":"","type":"text"},{"key":"content-type","value":"application/json; charset=utf-8","description":"","type":"text"},{"key":"content-length","value":"256","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"6254ffb21283fa162a1450b6\",\n \"taskCategory\": \"LAYOUT\",\n \"taskSubcategory\": \"ASYNC_TABLE_EXTRACTION\",\n \"status\": \"Processing\",\n \"callback\": \"http://examplehost:8080/examplepath\",\n \"startDateTime\": \"2022-04-12T04:27:30.147Z\",\n \"expirationDateTime\": \"2022-04-13T04:27:30.147Z\"\n}"}],"_postman_id":"69eef067-3952-4243-b909-c47805026e42"},{"name":"Async result export","id":"c3deb529-e48b-49b7-b9f1-316dc590ad3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","type":"text","description":"

Please sign-up iDox.ai and get an API key.

\n"}],"body":{"mode":"raw","raw":"{\r\n \"exportFormat\": \"xlsx\",\r\n \"callback\": \"http://examplehost:8080/examplepath\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/layout/:document-id/table-extraction/export/async","description":"

Export the extracted tables as a Excel file with multiple sheets. Support the file types uploaded from \"Upload document\" API. This is an async mode API.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"idox-api-engine-key"},{"key":"value","value":"SIGN_UP_TO_GET_KEY"}]},"isInherited":true,"source":{"_postman_id":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","id":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","name":"iDox.ai Data Privacy API","type":"collection"}},"urlObject":{"path":["api","v3","layout",":document-id","table-extraction","export","async"],"host":["https://docs.idox.ai"],"query":[],"variable":[{"id":"22f13150-dbeb-4bf3-abc3-19feb26514fa","description":{"content":"

The document ID (docId) returned by the Find Job Status API.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"3bf6e47e-2968-43f1-8ae6-b0cbe56f6293","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","type":"text","description":"Please sign-up iDox.ai and get an API key."}],"body":{"mode":"raw","raw":"{\r\n \"exportFormat\": \"xlsx\",\r\n \"callback\": \"http://examplehost:8080/examplepath\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docs.idox.ai/api/v3/layout/:document-id/table-extraction/export/async","host":["https://docs.idox.ai"],"path":["api","v3","layout",":document-id","table-extraction","export","async"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API."}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Content-Type-Options","value":"nosniff","description":"","type":"text"},{"key":"X-XSS-Protection","value":"1; mode=block","description":"","type":"text"},{"key":"X-Frame-Options","value":"sameorigin","description":"","type":"text"},{"key":"content-type","value":"application/json; charset=utf-8","description":"","type":"text"},{"key":"application/json; charset=utf-8","value":"263","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"jobId\": \"6254ffc51283fa162a1450c6\",\n \"taskCategory\": \"LAYOUT\",\n \"taskSubcategory\": \"ASYNC_EXPORT_TABLE_EXTRACTION\",\n \"status\": \"Processing\",\n \"callback\": \"http://examplehost:8080/examplepath\",\n \"startDateTime\": \"2022-04-12T04:27:49.533Z\",\n \"expirationDateTime\": \"2022-04-13T04:27:49.533Z\"\n}"}],"_postman_id":"c3deb529-e48b-49b7-b9f1-316dc590ad3c"}],"id":"a9c08c2c-ae59-4307-a85c-c5f34e7d2b56","_postman_id":"a9c08c2c-ae59-4307-a85c-c5f34e7d2b56","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"idox-api-engine-key"},{"key":"value","value":"SIGN_UP_TO_GET_KEY"}]},"isInherited":true,"source":{"_postman_id":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","id":"3b5b2005-b425-4b3c-8092-28103cc1e3f3","name":"iDox.ai Data Privacy API","type":"collection"}}},{"name":"Classification","item":[{"name":"Tag document","id":"67c07e0a-2c5b-4baf-9826-1d8472c0a7bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/category/:document-id/document-tag","description":"

Return a tag array to indicate the possible topics of a given document. Support the file types uploaded from \"Upload document\" API.

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
tags	A document might be tagged with multiple values. The possible tags include any of below: * Nature * Entertainment * Food * Religion * Biology * Sport * Business * Military * Legal * Environment * Education

The document ID (docId) returned by the Find Job Status API.

The colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"f1a06ab1-0123-44fb-9732-2a14e42d6ff9","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://docs.idox.ai/api/v3/category/:document-id/document-tag","host":["https://docs.idox.ai"],"path":["api","v3","category",":document-id","document-tag"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API.\n\nThe colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:23:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"29"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"1952"},{"key":"x-envoy-decorator-operation","value":"traefik.ai-ingress.svc.cluster.local:80/*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": [\n \"business\",\n \"legal\"\n ]\n}"}],"_postman_id":"67c07e0a-2c5b-4baf-9826-1d8472c0a7bc"},{"name":"Tag contents","id":"18257bae-432f-4022-9492-a230e962e346","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/category/document-tag","description":"

Return a tag array to indicate the possible topics of given textual contents.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
content	true	Target contents for analysis.

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
tags	A document might be tagged with multiple values. The possible tags include any of below: * Nature * Entertainment * Food * Religion * Biology * Sport * Business * Military * Legal * Environment * Education

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"049dc921-08e0-47fa-b4e8-931d95181f31","id":"049dc921-08e0-47fa-b4e8-931d95181f31","name":"Classification","type":"folder"}},"urlObject":{"path":["api","v3","category","document-tag"],"host":["https://docs.idox.ai"],"query":[],"variable":[]}},"response":[{"id":"6171235e-5a55-4640-a413-f812c366c627","name":"200 Success","originalRequest":{"method":"POST","header":[{"description":"Please sign-up iDox.ai and get an API key. ","key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/category/document-tag"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": [\n \"food\",\n \"environment\"\n ]\n}"}],"_postman_id":"18257bae-432f-4022-9492-a230e962e346"},{"name":"Classify contract file","id":"cad9d0a1-e318-4f4a-8371-80b755d374b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"url":"https://docs.idox.ai/api/v3/category/:document-id/contract-type","description":"

Classify the type of a contract. 31 types of contract are supported. Support the file types uploaded from \"Upload document\" API.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n

	description
type	The type of a contract can be one of the contract types below: * Underwriting-Agreement * Security-Agreement * Supplemental-Indenture * Amended-and-Restated-Credit-Agreement * Amendment-to-Employment-Agreement * Registration-Rights-Agreement * Stock-Option-Agreement * Amended-and-Restated-Employment-Agreement * Services-Agreement * Investment-Advisory-Agreement * Loan-Agreement * Securities-Purchase-Agreement * Participation-Agreement * Purchase-Agreement * Limited-Liability-Company-Agreement * Indemnification-Agreement * Subscription-Agreement * Asset-Purchase-Agreement * Executive-Employment-Agreement * Management-Agreement * Purchase-and-Sale-Agreement * Consulting-Agreement * Credit-Agreement * Distribution-Agreement * Stock-Purchase-Agreement * Employment-Agreement * License-Agreement * Trust-Agreement * Administration-Agreement * Loan-and-Security-Agreement * Non-Disclosure-Agreement

description

type

The type of a contract can be one of the contract types below:
* Underwriting-Agreement
* Security-Agreement
* Supplemental-Indenture
* Amended-and-Restated-Credit-Agreement
* Amendment-to-Employment-Agreement
* Registration-Rights-Agreement
* Stock-Option-Agreement
* Amended-and-Restated-Employment-Agreement
* Services-Agreement
* Investment-Advisory-Agreement
* Loan-Agreement
* Securities-Purchase-Agreement
* Participation-Agreement
* Purchase-Agreement
* Limited-Liability-Company-Agreement
* Indemnification-Agreement
* Subscription-Agreement
* Asset-Purchase-Agreement
* Executive-Employment-Agreement
* Management-Agreement
* Purchase-and-Sale-Agreement
* Consulting-Agreement
* Credit-Agreement
* Distribution-Agreement
* Stock-Purchase-Agreement
* Employment-Agreement
* License-Agreement
* Trust-Agreement
* Administration-Agreement
* Loan-and-Security-Agreement
* Non-Disclosure-Agreement

The document ID (docId) returned by the Find Job Status API.

The colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"4fa5d930-9c62-4089-806a-0cdbc54a0d1b","name":"200 Success","originalRequest":{"method":"POST","header":[{"description":"Please sign-up iDox.ai and get an API key. ","key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY"}],"url":{"raw":"https://docs.idox.ai/api/v3/category/:document-id/contract-type","host":["https://docs.idox.ai"],"path":["api","v3","category",":document-id","contract-type"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API.\n\nThe colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"GENERAL\"\n}"}],"_postman_id":"cad9d0a1-e318-4f4a-8371-80b755d374b0"},{"name":"Classify contract clauses","id":"2cfd4ae6-ede9-4d8c-8481-57f0e3ed322f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Please sign-up iDox.ai and get an API key.

\n","key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY"},{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json; charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/category/contract-type","description":"

Classify the type of contract clauses. 31 types of contract are supported.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
content	true	Paragraph to be analyzed

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n

	description
type	The type of a contract can be one of the contract types below: * Underwriting-Agreement * Security-Agreement * Supplemental-Indenture * Amended-and-Restated-Credit-Agreement * Amendment-to-Employment-Agreement * Registration-Rights-Agreement * Stock-Option-Agreement * Amended-and-Restated-Employment-Agreement * Services-Agreement * Investment-Advisory-Agreement * Loan-Agreement * Securities-Purchase-Agreement * Participation-Agreement * Purchase-Agreement * Limited-Liability-Company-Agreement * Indemnification-Agreement * Subscription-Agreement * Asset-Purchase-Agreement * Executive-Employment-Agreement * Management-Agreement * Purchase-and-Sale-Agreement * Consulting-Agreement * Credit-Agreement * Distribution-Agreement * Stock-Purchase-Agreement * Employment-Agreement * License-Agreement * Trust-Agreement * Administration-Agreement * Loan-and-Security-Agreement * Non-Disclosure-Agreement

description

type

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"049dc921-08e0-47fa-b4e8-931d95181f31","id":"049dc921-08e0-47fa-b4e8-931d95181f31","name":"Classification","type":"folder"}},"urlObject":{"path":["api","v3","category","contract-type"],"host":["https://docs.idox.ai"],"query":[],"variable":[]}},"response":[{"id":"3552cae6-8f3c-4dd5-8945-30107b7f0687","name":"200 Success","originalRequest":{"method":"POST","header":[{"description":"Please sign-up iDox.ai and get an API key. ","key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY"},{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"application/json; charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/category/contract-type"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 00:32:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"620"},{"key":"x-envoy-decorator-operation","value":"traefik.ai-ingress.svc.cluster.local:80/*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"Securities-Purchase-Agreement\"\n}"}],"_postman_id":"2cfd4ae6-ede9-4d8c-8481-57f0e3ed322f"},{"name":"Classify contents","id":"7573355c-ffcc-4270-b362-9918bf2383b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

Classify the type of given textual contents. 6 types of classification are supported.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

name	required	description
content	true	Paragraph to be analyzed

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n

	description
type	The type can be one of below: * General * Contract * Research paper * Invoice * Bank statement * Utility bill

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"049dc921-08e0-47fa-b4e8-931d95181f31","id":"049dc921-08e0-47fa-b4e8-931d95181f31","name":"Classification","type":"folder"}},"urlObject":{"path":["api","v3","category","document-type"],"host":["https://docs.idox.ai"],"query":[],"variable":[]}},"response":[{"id":"eb92fbc6-e9f8-4687-b6e9-d9d69ecade12","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"content\": \"Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://docs.idox.ai/api/v3/category/document-type"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 00:33:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"18"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"404"},{"key":"x-envoy-decorator-operation","value":"traefik.ai-ingress.svc.cluster.local:80/*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"GENERAL\"\n}"}],"_postman_id":"7573355c-ffcc-4270-b362-9918bf2383b5"},{"name":"Classify document","id":"9eef5856-8d0a-4643-a8e1-fa5ab7b7d9cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"

Please sign-up iDox.ai and get an API key.

\n","type":"text"}],"url":"https://docs.idox.ai/api/v3/category/:document-id/document-type","description":"

Classify the type of a given document. 6 types of document classification are supported. Support the file types uploaded from \"Upload document\" API.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
type	The type can be one of below: * General * Contract * Research paper * Invoice * Bank statement * Utility bill

The document ID (docId) returned by the Find Job Status API.

The colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL.

\n","type":"text/plain"},"type":"any","value":"place_doc_id_here","key":"document-id"}]}},"response":[{"id":"85838da2-9076-4d6a-b789-a675142d587f","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"idox-api-engine-key","value":"SIGN_UP_TO_GET_KEY","description":"Please sign-up iDox.ai and get an API key.","type":"text"}],"url":{"raw":"https://docs.idox.ai/api/v3/category/:document-id/document-type","host":["https://docs.idox.ai"],"path":["api","v3","category",":document-id","document-type"],"variable":[{"key":"document-id","value":"place_doc_id_here","description":"The document ID (docId) returned by the Find Job Status API.\n\nThe colon in front of the document-id (:document-id) indicates a URL path parameter in Postman. The colon is not a part of the URL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:00:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"18"},{"key":"Connection","value":"keep-alive"},{"key":"x-envoy-upstream-service-time","value":"483"},{"key":"x-envoy-decorator-operation","value":"traefik.ai-ingress.svc.cluster.local:80/*"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"CONTRACT\"\n}"}],"_postman_id":"9eef5856-8d0a-4643-a8e1-fa5ab7b7d9cb"}],"id":"049dc921-08e0-47fa-b4e8-931d95181f31","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"17682c0d-0b25-4b9a-a22c-27d9d04e151e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4a8e0280-48a7-4a4d-87e4-25e0195b2b0e","type":"text/javascript","exec":[""]}}],"_postman_id":"049dc921-08e0-47fa-b4e8-931d95181f31","description":""}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"idox-api-engine-key"},{"key":"value","value":"SIGN_UP_TO_GET_KEY"}]}},"event":[{"listen":"prerequest","script":{"id":"98a37893-ea72-434e-8a68-d47751278648","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dbce4112-f68d-4f68-872e-66d5175a6c3a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://docs.idox.ai","type":"string"},{"key":"idoxAPIKey","value":"idox-api-engine-key","type":"string"},{"key":"idoxAPIKeyValue","value":"SIGN_UP_TO_GET_KEY","type":"string"},{"key":"apiV1Version","value":"v1"},{"key":"apiV2Version","value":"v2"},{"key":"apiV3Version","value":"v3","type":"string"},{"key":"docId","value":"place_doc_id_here","type":"string"},{"key":"jobId","value":"place_job_id_here","type":"string"}]}