Advanced Usage

Combining Multiple Analysis Types

The analyse_type parameter specifies which analyses you want to perform. You can combine multiple analysis types in a single request to retrieve different types of information from the same document.

The available Analysis Types are:

Type	Description	Details
risk	The risk of overall fraud analysis - low, medium, and high	Fraud Analysis →
explanation	Detailed fraud explanations	Fraud Analysis →
data_extraction	Classification of the document and extract structured data	Data Extraction →
pdf_report	The PDF evidence report associated with the document (base64 response)	Advanced →
pdf_summary_report	A summarized version of the PDF evidence report (base64 response)	Advanced →
share_link	Create shareable investigation link	Share Link →
document_validation	Compliance analysis (returns true/false key for each validation)	Document Validation →

Example Payload

Python

import requests
import json

url = "https://api-v2.finovox.com/analyse"
headers = {"api-key": "YOUR_API_KEY_HERE"}

payload = {
    "analyse_type": ["risk", "tags", "data_extraction", "explanation"]
}

with open("sample.pdf", "rb") as f:
    files = [("file", ("sample.pdf", f.read()))]
    data = {"payload": json.dumps(payload)}
    response = requests.post(url, headers=headers, files=files, data=data, timeout=150)
    print(response.json())

JavaScript

// npm install axios form-data
const fs = require('fs')
const axios = require('axios')
const FormData = require('form-data')

const url = 'https://api-v2.finovox.com/analyse'
const API_KEY = 'YOUR_API_KEY_HERE'

const form = new FormData()
form.append('file', fs.createReadStream('sample.pdf'))
form.append('payload', JSON.stringify({
  analyse_type: ['risk', 'tags', 'data_extraction', 'explanation']
}))

axios.post(url, form, {
  headers: { 'api-key': API_KEY, ...form.getHeaders() },
  timeout: 150000
}).then(response => {
  console.log(response.data)
})

---

Share Link Additional Parameters

The share_link analysis type generates a secure web link that allows you to share document analysis results with others. This link provides an interactive view of the document analysis.

When using share links, you can customize the access settings:

• access : access rights to the link:
  • user: only the user who made the API call can access the link
  • organization: only users from the same organization as the user who made the API call can access the link
  • public: everyone can access the link
• password : password that will be requested to access the document analysis. If this field is not used, no password will be requested.

Example Payload

Input format:

Python

payload = {
    "analyse_type": ["risk", "share_link"],
    "share_link_settings": {
        "access": "public",
        "password": "test"
    }
}

JavaScript

const payload = {
  analyse_type: ['risk', 'share_link'],
  share_link_settings: {
    access: 'public',
    password: 'test'
  }
}

Output format:

{
  "name": "sample.pdf",
  "global_risk": "high",
  // ... other risk fields ...
  "share_link": "https://app.finovox.com/share/XXXXX_YY=="
}

Language Support for Share Link

You can specify your preferred language for document analysis by appending the lang parameter to your share link:

• English (default): ?lang=en
• French: ?lang=fr

If no lang parameter is provided, the default language will be English.

Example of an appended share_link:

{
  "share_link": "https://app.finovox.com/share/XXXXX_YY==?lang=fr"
}

---

Next: To avoid timeout issues on long-running analyses, see Asynchronous Mode → to learn how to handle requests asynchronously.