The following Content Risk Review capabilities are available in the IntelligenceBank API and can be used to submit local reviews directly from third-party applications, as per our out-to-the-box Content Risk Review connectors (e.g. Microsoft Word, Microsoft PowerPoint, Adobe GenStudio...).
The Content Risk Review can be conducted on a File or Text Copy. Below is the process and the API calls in scope for each review type.
File Review
- Upload File with the corresponding target as a preliminary step. Learn more about supported formats and applicable size limits here.
- Create File Review, which will return a Risk Review id that is to be used in subsequent calls.
- Get Review Results as Comments, with annotations data when available.
- This call is also to be used for polling the Risk Review status until completed.
| IntelligenceBank API response attribute (all within each comment object) | Description | Example |
| "compCheckTerm" | Term that triggered the risk. | "bank" |
| "compCheckTermStart" | Start of the term that the feedback is about in character count from the start of the sentence. | 61 |
| "compCheckExplanation" | This is a description of the risk identified. | "This document mentions: 'bank' without including a disclaimer." |
| "compCheckSentenceStart" | Relevant for Create Text Review when an entire body of text is sent for review. This is the start of the sentence that contains the term that triggered the risk, in character count from the start of the text submitted for review. | 43 |
| "compCheckSentence" | This is the full sentence that the triggered risk is about. | "The future of VIP banking awaits-offering you exclusive access to the best." |
| "compCheckFeedback" | This is additional feedback on the triggered risk. It is not always returned. | "Please ensure your disclaimer is acceptable or use this one, e.g.\n\nProducts and services including banking, superannuation and insurance are provided by different entities of IntelligenceBank. Each entity is not responsible for, or liable in respect of, products and services provided by other entities." |
| "ruleName" | This is the static name of the rule. | "02-IB-DISCLAIMER" |
| "ruleDescription" | This is the static description of the rule. | "Financial Product Entity Disclaimer" |
Text Review
- Create Text Review, which will return a Risk Review id that is to be used in subsequent calls.
- Get Review Results as Comments, with annotations data when available.
- This call is also to be used for polling the Risk Review status until completed.
- See table of key attributes above.
Note that the Create Review endpoint requires the use of a mandatory product key value, that is to be provided by your Customer Success Manager, and also that limits on the total number of Content Risk Reviews that can be submitted via the IntelligenceBank API apply. The default limit is 1,000 Content Risk Reviews per month, or 12,000 per annum.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article