Waldo AI Docs
Dashboard
  • Meet Waldo AI
  • Quick Start
  • Getting Started
  • Guides
    • Authentication process
  • Features
    • Overview
    • Onboarding
    • Fraud Evaluation
    • Express KYC
    • Document Upload
    • Deep Background Check
    • Webhooks
    • Sandbox
  • API Reference
    • Authentication
    • Customer Onboarding
    • KYC History
    • Get Customer
    • Document Upload
    • Check Fraud
    • Fraud History
    • Flag Customer
  • General Information
    • Data Sources
Powered by GitBook
On this page
  1. API Reference

Check Fraud

Endpoint to execute a fraud evaluation for an existing customer

Request a fraud evaluation

POST https://api.waldo.ai/check-fraud

All evaluation requests are asynchronous. Therefore, the response to the fraud check request will not be completed in real time. If you have set up the webhooks, your system will receive notifications automatically. Otherwise, your system can poll Waldo's API until the evaluation is completed.

Request body

Name
Type
Description

customerId*

string

Customer ID

Response

When requesting a fraud check, always verify the evaluation property; if its status is initiated, the fraudScore value is the last known fraud score, not of the current evaluation.

{
    "requestId": "ayclpQyi6p",
    "event": "evaluation",
    "evaluation": {
        "type": "fraud",
        "status": "initiated"
    },
    "validation": {
        "status": "APPROVED",
        "kyc": "PASSED",
        "fraudScore": 0.82
    },
    "externalId": "abcd-123-456-efgh",
    "customerId": "<customer-id>",
    "uri": "https://app.waldo.ai/customers/<customer-id>",
    "errors": []
}
{ 
  "code": "INVALID_DATA",
  "message": "Invalid <field name>"
}
{
  "code": "INVALID_TOKEN", 
  "message": "Invalid token."
}
{ 
  "code": "NOT_AUTHORIZED",
  "message": "Not authorized."
}
{ 
  "code": "NOT_AUTHORIZED",
  "message": "You are not authorized to perform this action. Please contact support for assistance."
}

Webhooks complete event notification

{
  "event": "evaluation",
  "evaluation": {
    "type": "fraud",
    "status": "completed"
  },
  "customerId": "<customer-id>",
  "uri": "https://app.waldo.ai/customers//<customer-id>",
  "validation": {
    "status": "APPROVED",
    "kyc": "PASSED",
    "fraudScore": 0.89,
    "fraudFlag": false,
    "warnings": 3,
    "warningTags": {
      "ssn": {
        "tag": "ssn",
        "label": "SSN Integrity",
        "passed": true
      },
      "date_of_birth": {
        "tag": "date_of_birth",
        "label": "Date of Birth Integrity",
        "passed": true
      },
      "address": {
        "tag": "address",
        "label": "Address Integrity",
        "passed": true
      },
      "legal_and_regulatory_warnings": {
        "tag": "legal_and_regulatory_warnings",
        "label": "Legal and Regulatory Warnings",
        "passed": true
      },
      "politically_exposed_person": {
        "tag": "politically_exposed_person",
        "label": "Politically Exposed Person",
        "passed": true
      },
      "sanction": {
        "tag": "sanction",
        "label": "Sanctions List",
        "passed": true
      },
      "fraud_reports": {
        "tag": "fraud_reports",
        "label": "Network Fraud Detection",
        "passed": false
      },
      "watchlists_validation": {
        "tag": "watchlists_validation",
        "label": "Watchlists Validation",
        "passed": true
      },
      "phone_number_validation": {
        "tag": "phone_number_validation",
        "label": "Phone Number Validation",
        "passed": false
      },
      "email_address_validation": {
        "tag": "email_address_validation",
        "label": "Email Address Validation",
        "passed": false
      }
    },
    "kycBreakdown": {
      "identityBreakdown": {},
      "watchlistBreakdown": {},
      "documentBreakdown": {}
    }
  }
}
PreviousDocument UploadNextFraud History

Last updated 7 months ago