iDox-ai Document
The iDox.ai Document API lets you capture document data from your apps. You can it to do things like extract personal information, read invoices, extract financial results, or discover agreement risks. Before using the API, please sign-up iDox.ai developer account and get an API key. https://developers-staging.idox.ai We've posted a step-by-step tutorial on Medium to help you get started iDox.ai…
36 subscribers
19 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
iDox-ai Document endpoints
| Method | Endpoint | Description |
|---|---|---|
| Documents | ||
| POST |
Redact document /api/{apiV2Version}/document-tool/{document-id}/pdf-redactor |
Redact or highlight a PDF by a configuration of the following information: * Keywords * Pages * Areas #### Request Body | name | required | description | | --- | --- | --- | |… |
| GET |
Download document /api/{apiV2Version}/document-tool/{document-id}/download |
Download a document from iDox.ai. |
| POST |
Redact document by coordintes /api/{apiV2Version}/document-tool/{document-id}/text-in-rects |
Redact a PDF by a configuration of coordinates of several squares. #### Request Body | name | required | description | | --- | --- | --- | | rects | true | Coordinates of… |
| POST |
Upload Document /api/{apiV2Version}/document-tool/pre-processing |
Upload a document to iDox.ai. `PDF` and MS Word (`DOC`, `DOCX`) file formats are supported. |
| Processing Status | ||
| GET |
Find job status /api/{apiV1Version}/job/{job-id} |
Return the job status. |
| PII Discovery | ||
| POST |
Asyn ccontent PII discovery /api/{apiV1Version}/ner/pii/async |
Discover PII information from text contents. This is an async mode API. #### Request Body | name | required | description | | --- | --- | --- | | paragraphs | true | Target… |
| POST |
Async document PII discovery /api/{apiV2Version}/ner/{document-id}/pii/async |
Discover PII information from a document. This is an async mode API. #### Request Body | name | required | description | | --- | --- | --- | | confidenceScore | false | Return… |
| POST |
Document PII discovery /api/{apiV2Version}/ner/{document-id}/pii |
Discover PII information from a document. #### Request Body | name | required | description | | --- | --- | --- | | categoriesFilter | false | Return the designated entity… |
| POST |
Content PII discovery /api/{apiV1Version}/ner/pii |
Discover PII information from textual contents. #### Request body | name | required | description | | --- | --- | --- | | paragraphs | true | Target content for analysis. The… |
| Classification | ||
| POST |
Classify contract clauses /api/{apiV1Version}/category/contract-type |
Classify the type of contract clauses. 31 types of contract are supported. #### Request Body | name | required | description | | --- | --- | --- | | content | true | Paragraph to… |
| POST |
Classify document /api/{apiV2Version}/category/{document-id}/document-type |
Classify the type of a given document. 6 types of document classification are supported. #### Response Body | **Name** | **Description** | | --- | --- | | type | The type can be… |
| POST |
Tag document /api/{apiV2Version}/category/{document-id}/document-tag |
Return a tag array to indicate the possible topics of a given document. #### Response | Parameter | Description | | --- | --- | | tags | A document might be tagged with multiple… |
| POST |
Classifyc ontract file /api/{apiV2Version}/category/{document-id}/contract-type |
Classify the type of a contract. 31 types of contract are supported. #### Response Body | | description | | --- | --- | | type | The type of a contract can be one of the contract… |
| POST |
Tag contents /api/{apiV1Version}/category/document-tag |
Return a tag array to indicate the possible topics of given textual contents. #### Request body | name | required | description | | --- | --- | --- | | content | true | Target… |
| POST |
Classify contents /api/{apiV1Version}/category/document-type |
Classify the type of given textual contents. 6 types of classification are supported. #### Request Body | name | required | description | | --- | --- | --- | | content | true |… |
| Legal Intelligence | ||
| POST |
AsyncReviewclauses /api/{apiV2Version}/contract/{document-id}/review/async |
Find risky clauses within a contract, such as incomplete clauses, missing clauses, missing contractual elements. #### Request Body | **Name** | **Required** | **Description** | |… |
| POST |
Review clauses /api/{apiV1Version}/contract/review |
Find risky clauses within a contract, such as incomplete clauses, missing clauses, missing contractual elements. #### Request Body | **Name** | **Required** | **Description** | |… |
| Layout Analysis | ||
| POST |
Analyze contract layout /api/{apiV2Version}/segmentation/{document-id}/contract-layout |
Extract layout objects from a contract. #### Response Body | **Name** | **Description** | | --- | --- | | items | Detected object items | #### Detected Object Items | **Name** |… |
| POST |
Async analyze contract layout /api/{apiV2Version}/segmentation/{document-id}/contract-layout/async |
#### Request Body | name | required | description | | --- | --- | --- | | callback | false | Successful callback URL, will be called using http post | #### Detected Object Items… |
iDox-ai Document pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
