Skip to content

VAARHAFT API (v2.3.1)

API for image and document verification.

Send us your files in a ZIP archive through a request like below, and we verify them for you. You can give us images (like JPEG, PNG, ...) or PDF documents - we extract relevant items like embedded images or document scans automatically.

You will get back a response where we detail exactly what the results of our different analyses are - and if your file is suspicious.

The results are packaged in a clean, structured JSON response like below, that is easy to understand, read and integrate. Additionally, depending on the results, we may send you one or multiple ZIP attachments containing additional results or indicators, like heatmaps that show you where your files have been edited.

We can even generate an evaluation report for you, which shows you everything we found in an intuitive way that everyone, even without technical knowledge, can understand.



One more thing:

If you're using Python (v3.9 or higher), the easiest way to integrate our API is through our SDK - just do pip install vaarhaft-fraudscanner and you're good to go! (more info here)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://vaarhaft.com

E-mail

team@vaarhaft.com

Languages
Servers
Mock server

https://docs.vaarhaft.com/_mock/openapi/

https://api.vaarhaft.com/

FraudScanner

Operations

Upload a ZIP file for fraud analysis

Request

This endpoint allows you to upload a ZIP file to analyze contained image and document files in the context of a specific case.

Note that due to our compute heavy analysis features, requests with many or large files can take longer than usual to complete. Thus, the request timeout is set to an extended period of 120s, although this is much longer than the average request will take.

Security
apiKeyAuth
Headers
x-api-keystringrequired

The API key for authentication.

caseNumberstringrequired

A case number to assign to the request. Typically matches the one that you use internally to track the files you're sending us.

issueDatestring(date)

The issue date of the case, if available.

Bodymultipart/form-datarequired
filestring(zip)required

The ZIP file to be uploaded for analysis.

curl -i -X POST \
  https://docs.vaarhaft.com/_mock/openapi/v2/fraudscanner \
  -H 'Content-Type: multipart/form-data' \
  -H 'caseNumber: string' \
  -H 'issueDate: 2019-08-24' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -F file=string

Responses

Success. The file was successfully uploaded and processed.

Body
suspicion_levelstring

An indicator as to how suspicious the contents of the request were. Is calculated from the suspicion levels of the contained files.

Enum"Green""Yellow""Red"
Filesobject

A mapping of filename to file analysis results.

caseNumberstring

The case number assigned to the request.

Example: "Case 123A"
sessionIdstring(UUID)

A unique identifier generated for the request.

Example: "5a8d8fd2-3317-4964-8298-caa96cd5cfa3"
modelVersionsobject

Overview of the internal VAARHAFT AI models used for classification.

tokensConsumedinteger

The amount of API tokens that were consumed by this request, depending for example on the number and types of processed files.

Example: 12
Response
{
  "suspicion_level": "Green",
  "Files": {
    "<FileID>1": { … },
    "<FileID>2": { … }
  },
  "caseNumber": "Case 123A",
  "sessionId": "5a8d8fd2-3317-4964-8298-caa96cd5cfa3",
  "modelVersions": {
    "generatedModelVersion": "vh-gen-uranus",
    "tamperedModelVersion": "vh-tp-venus",
    "semanticModelVersion": "vh-sem-mars"
  },
  "tokensConsumed": 12
}