Skip to main content
GET
/
v3
/
{customerId}
/
upload
/
fraudanalysis
/
{loginId}
Fraud Analysis
curl --request GET \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/upload/fraudanalysis/{loginId}
{
  "HttpStatusCode": 123,
  "Message": "<string>",
  "Login": {
    "LoginId": "<string>",
    "RequestId": "<string>"
  },
  "DocumentAnalysis": [
    {
      "Status": "<string>",
      "FullAnalysis": [
        {
          "DocumentType": "<string>",
          "FraudSignals": [
            {
              "Type": "<string>",
              "PageNumber": 123,
              "Count": 123,
              "UnderlyingData": [
                {
                  "Details": [
                    {
                      "SpecificType": "<string>",
                      "Value": "<string>",
                      "DataType": "<string>"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
Use the /FraudAnalysis endpoint if you are using Flinks Upload and want to check if our fraud signals were triggered by documents that were uploaded. This endpoint returns a different 200 response based on if fraud was detected or not.

Headers

Authorization
string

Contains the Bearer Token (the API secret key that Flinks provides you with).

Response

Result

HttpStatusCode
integer
Message
string

Message indicating no fraud was detected (e.g., "No Fraud Signal Detected").

Login
object
DocumentAnalysis
object[]

Contains the analysis results for the uploaded documents.