fraudapi API Reference

Easily and directly scan and block fraudulent security threats in input.

Version: v1

Authentication

Apikey

type

apiKey

name

Apikey

header

Paths

FraudDetection

AI Fraud Detection for Documents

POST /fraud-ai/detection/document

Perform fraud detection and classification on input document and user context. Input document formats supported include DOCX, PDF, PNG and JPG.

InputFile: file

in formData

Input document, or photos of a document, to perform fraud detection on

Code Example:

200 OK

FraudDetectionResult

Response Content-Types: text/plain, application/json, text/json

Response Example (200 OK)

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FraudRiskLevel": "number (double)",
  "ContainsFinancialLiability": "boolean",
  "ContainsSensitiveInformationCollection": "boolean",
  "ContainsAssetTransfer": "boolean",
  "ContainsPurchaseAgreement": "boolean",
  "ContainsEmploymentAgreement": "boolean"
}

FraudDetection

Advanced AI Fraud Detection for Documents

POST /fraud-ai/detection/document/advanced

Perform advanced fraud detection and classification on input document and user context. Input document formats supported include DOCX, PDF, PNG and JPG.

preprocessing: string

in header

Optional: Set the level of image pre-processing to enhance accuracy. Possible values are 'Auto' and 'None'. Default is Auto.

resultCrossCheck: string

in header

Optional: Set the level of output accuracy cross-checking to perform on the input. Possible values are 'None' and 'Advanced'. Default is None.

UserEmailAddress: string

in header

User email address for context (optional)

UserEmailAddressVerified: boolean

in header

True if the user's email address was verified (optional)

InputFile: file

in formData

Input document, or photos of a document, to perform fraud detection on

Code Example:

200 OK

AdvancedFraudDetectionResult

Response Content-Types: text/plain, application/json, text/json

Response Example (200 OK)

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FraudRiskLevel": "number (double)",
  "ContainsFinancialLiability": "boolean",
  "ContainsSensitiveInformationCollection": "boolean",
  "ContainsAssetTransfer": "boolean",
  "ContainsPurchaseAgreement": "boolean",
  "ContainsEmploymentAgreement": "boolean",
  "ContainsExpiredDocument": "boolean",
  "ContainsAiGeneratedContent": "boolean",
  "AnalysisRationale": "string",
  "DocumentClass": "string"
}

Schema Definitions

AdvancedFraudDetectionResult: object

Result of performing an advanced document fraud analysis

Successful: boolean: True if successful, false otherwise
CleanResult: boolean: True if the document is clean, false if fraud threats were found
FraudRiskLevel: number (double): Overall fraud risk level between 0.0 and 1.0
ContainsFinancialLiability: boolean: True if the document contains financial liability
ContainsSensitiveInformationCollection: boolean: True if the document contains sensitive data collection from the recipient
ContainsAssetTransfer: boolean: True if the document contains an asset transfer
ContainsPurchaseAgreement: boolean: True if the document contains a purchase agreement
ContainsEmploymentAgreement: boolean: True if the document contains an employment agreement
ContainsExpiredDocument: boolean: True if the document is expired
ContainsAiGeneratedContent: boolean: True if the document contains AI generated content
AnalysisRationale: string: Rationale on why the document was classified as such
DocumentClass: string: Standardized class of the input document

Example

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FraudRiskLevel": "number (double)",
  "ContainsFinancialLiability": "boolean",
  "ContainsSensitiveInformationCollection": "boolean",
  "ContainsAssetTransfer": "boolean",
  "ContainsPurchaseAgreement": "boolean",
  "ContainsEmploymentAgreement": "boolean",
  "ContainsExpiredDocument": "boolean",
  "ContainsAiGeneratedContent": "boolean",
  "AnalysisRationale": "string",
  "DocumentClass": "string"
}

FraudDetectionResult: object

Result of performing fraud detection on a document

Successful: boolean: True if successful, false otherwise
CleanResult: boolean: True if the document is clean, false if fraud threats were found
FraudRiskLevel: number (double): Overall fraud risk level between 0.0 and 1.0
ContainsFinancialLiability: boolean: True if the document contains financial liability
ContainsSensitiveInformationCollection: boolean: True if the document contains sensitive data collection from the recipient
ContainsAssetTransfer: boolean: True if the document contains an asset transfer
ContainsPurchaseAgreement: boolean: True if the document contains a purchase agreement
ContainsEmploymentAgreement: boolean: True if the document contains an employment agreement

Example

{
  "Successful": "boolean",
  "CleanResult": "boolean",
  "FraudRiskLevel": "number (double)",
  "ContainsFinancialLiability": "boolean",
  "ContainsSensitiveInformationCollection": "boolean",
  "ContainsAssetTransfer": "boolean",
  "ContainsPurchaseAgreement": "boolean",
  "ContainsEmploymentAgreement": "boolean"
}

Documentation by Spectacle