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

Document Upload

Endpoint to upload a customer's document

To differentiate the document evaluation items, the warningTags include the isDoc key. Example:

{ 
    "tag": "compromised_document", 
    "passed": true, 
     
    "label": "Compromised Document" 
}

Upload a document

POST https://api.waldo.ai/document

All evaluation requests are asynchronous. Therefore, the response to the document 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.

Headers

Name
Type
Description

Authorization*

String

The token in the format Bearer eyJhbG...

Content-Type*

String

Expected type is multipart/form-data

Request fields

Name
Type
Description
Location

document

binary file

Dcoument scan (.jpg, png, or .pdf) Maximum 10Mb size

Body

side

String

frontor back

Form data

customerId

String

Customer ID

Form data

documentType

String

driving_licence(US only), or passport(worldwide)

Form data

issuingCountry

String

Form data

Response

{
  "requestId": "ayclpQyi6p",
  "event": "evaluation",
  "evaluation": {
    "type": "document",
    "status": "initiated"
  },
  "validation": {
    "status": "APPROVED",
    "kyc": "PASSED",
    "fraudScore": 0.9,
    "fraudFlag": false
  },
  "customerId": "66b9fc5fcfd24a0bb512fdeb",
  "uri": "https://app.waldo.ai/customers/66b9fc5fcfd24a0bb512fdeb",
  "errors": []
}
{
    "code": "MISSING_DATA",
    "message": "Missing data: {field name}"
}
{
  "code": "NOT_AUTHORIZED",
  "message": "Not authorized."
}
{
  "code": "INVALID_TOKEN",
  "message": "Invalid token."
}
{
  "code": "NOT_AUTHORIZED",
  "message": "You are not authorized to perform this action. Please contact support for assistance."
}
{
  "code": "API_KEY_REVOKED",
  "message": "This API key has been revoked. Please visit the Waldo AI dashboard to review your API key."
}

Webhooks complete event notification

{
  "requestId": "ayclpQyi6p",
  "event": "evaluation",
  "evaluation": {
    "type": "document",
    "status": "completed"
  },
  "validation": {
    "status": "APPROVED",
    "kyc": "PASSED",
    "fraudScore": 0.9,
    "fraudFlag": false,
    "warnings": 3,
    "warningTags": [
      {
        "tag": "ssn",
        "passed": true,
        "label": "SSN Integrity"
      },
      {
        "tag": "date_of_birth",
        "passed": true,
        "label": "Date of Birth Integrity"
      },
      {
        "tag": "legal_and_regulatory_warnings",
        "passed": true,
        "label": "Legal and Regulatory Warnings"
      },
      {
        "tag": "politically_exposed_person",
        "passed": true,
        "label": "Politically Exposed Person"
      },
      {
        "tag": "sanction",
        "passed": true,
        "label": "Sanctions List"
      },
      {
        "tag": "age_validation",
        "passed": false,
        "isDoc": true,
        "label": "Age Validation"
      },
      {
        "tag": "image_integrity",
        "passed": false,
        "isDoc": true,
        "label": "Image Integrity"
      },
      {
        "tag": "data_comparison",
        "passed": true,
        "isDoc": true,
        "label": "Data Comparison"
      },
      {
        "tag": "data_consistency",
        "passed": true,
        "isDoc": true,
        "label": "Data Consistency"
      },
      {
        "tag": "compromised_document",
        "passed": true,
        "isDoc": true,
        "label": "Compromised Document"
      },
      {
        "tag": "visual_authenticity",
        "passed": false,
        "isDoc": true,
        "label": "Visual Authenticity"
      },
      {
        "tag": "data_validation",
        "passed": true,
        "isDoc": true,
        "label": "Data Validation"
      }
    ],
    "kycBreakdown": {
      "identityBreakdown": {},
      "watchlistBreakdown": {},
      "documentBreakdown": {
        "age_validation": {
          "label": "Age Validation",
          "passed": false,
          "tags": {
            "minimum_accepted_age": {
              "label": "Minimum Accepted Age",
              "passed": false
            }
          }
        },
        "image_integrity": {
          "label": "Image Integrity",
          "passed": false,
          "tags": {
            "colour_picture": {
              "label": "Colour Picture",
              "passed": false
            },
            "image_quality": {
              "label": "Image Quality",
              "passed": false
            }
          }
        },
        "visual_authenticity": {
          "label": "Visual Authenticity",
          "passed": false,
          "tags": {
            "digital_tampering": {
              "label": "Digital Tampering",
              "passed": false
            },
            "picture_face_integrity": {
              "label": "Picture Face Integrity",
              "passed": false
            }
          }
        }
      }
    }
  },
  "customerId": "<customer-id>",
  "uri": "https://app.waldo.ai/customers/<customer-id>",
  "errors": []
}
PreviousGet CustomerNextCheck Fraud

Last updated 5 months ago

Country code ( standard)

ISO 3166-1 alpha-3