CLEARCHECK API Reference
  • ClearCheck API Reference
  • Disclaimer for ClearCheck Search Portal and Services
  • Introduction
  • Authenticate
  • Requests Endpoints
  • API lookup types
  • LookupId-List API Endpoint
  • BreachScan
    • Headers and Body Request by deepweb values
    • GET Get lookup data for a request by deepweb values
    • Search Response Schema
  • Phone Lookup API
    • Headers and Body Request by Phone
    • GET Get lookup data for a request by Phone
    • Search Response Schema
  • Phone Validation Request
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Phone Vs Name Validator
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • E-mail Lookup API
    • Headers and Body Request by E-mail Lookup
    • GET Get lookup data for a request by E-mail Lookup
    • Search Response Schema
  • Name Lookup API
    • Headers and Body Request by Name Lookup
    • GET Get lookup data for a request by Name Lookup
    • Search Response Schema
  • Leads Search API
    • Headers and Body Request by Topick
    • GET Get lookup data for a request by Post
    • Search Response Schema
  • Facial Recognition API
    • Headers and Body Request by Face image Lookup
    • GET Get lookup data for a request by Face image Lookup
    • Search Response Schema
  • Sentiment Analysis API
    • Headers and Body Request by Text body
    • GET Get lookup data for a request by Text body
    • Search Response Schema
  • Delete Record API
    • Headers and Body Request for Delete Record
  • Retrieve the API Results for all requests.
    • GET Multiple Results
    • Search Response Schema
  • KYC Search API
    • Headers and Body Request by KYC
    • Request KYC Results
    • Search Response Schema
  • Web Scrapy API
    • Headers and Body Request by Web Collection
    • Request Response Data
    • Search Response Schema
  • IP Geolocation API
    • Headers and Body by IP Ad
    • Request Response Data
    • Search Response Schema
  • Ip Phone Verification
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Psycho Profile and Summary by Facebook ID
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • Psycho Profile and Summary by Text & Name
    • Headers and Body
    • Request Response Data
    • Search Response Schema
  • COMPLIANCE SCREENING
    • SSN Trace (US only)
  • National Criminal Screening (US only)
  • Watchlists and Politically Exposed Persons (International)
Powered by GitBook
On this page
  1. KYC Search API

Search Response Schema

VAT_VALIDATE Response Schema

{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "properties": {
      "criteria": {
         "type": "string"
      },
      "type": {
         "type": "string"
      },
      "status": {
         "type": "string"
      },
      "sources": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "name": {
                  "type": "string"
               }
            },
            "required": [
               "name"
            ]
         }
      },
      "data": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "web_collection": {
                  "type": "object",
                  "properties": {
                     "vat_number": {
                        "type": "string"
                     },
                     "valid": {
                        "type": "boolean"
                     },
                     "company": {
                        "type": "object",
                        "properties": {
                           "name": {
                              "type": "string"
                           },
                           "address": {
                              "type": "string"
                           }
                        },
                        "required": [
                           "address",
                           "name"
                        ]
                     },
                     "country": {
                        "type": "object",
                        "properties": {
                           "code": {
                              "type": "string"
                           },
                           "name": {
                              "type": "string"
                           }
                        },
                        "required": [
                           "code",
                           "name"
                        ]
                     }
                  },
                  "required": [
                     "company",
                     "country",
                     "valid",
                     "vat_number"
                  ]
               }
            },
            "required": [
               "web_collection"
            ]
         }
      }
   },
   "required": [
      "criteria",
      "data",
      "sources",
      "status",
      "type"
   ]
}

IBAN Response Schema

{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "properties": {
      "criteria": {
         "type": "string"
      },
      "type": {
         "type": "string"
      },
      "status": {
         "type": "string"
      },
      "sources": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "name": {
                  "type": "string"
               }
            },
            "required": [
               "name"
            ]
         }
      },
      "data": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "web_collection": {
                  "type": "object",
                  "properties": {
                     "iban": {
                        "type": "string"
                     },
                     "is_valid": {
                        "type": "boolean"
                     }
                  },
                  "required": [
                     "iban",
                     "is_valid"
                  ]
               }
            },
            "required": [
               "web_collection"
            ]
         }
      }
   },
   "required": [
      "criteria",
      "data",
      "sources",
      "status",
      "type"
   ]
}

COMPANY_ENRICH Response Schema

{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "properties": {
      "criteria": {
         "type": "string"
      },
      "type": {
         "type": "string"
      },
      "status": {
         "type": "string"
      },
      "sources": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "name": {
                  "type": "string"
               }
            },
            "required": [
               "name"
            ]
         }
      },
      "data": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "web_collection": {
                  "type": "object",
                  "properties": {
                     "name": {
                        "type": "string"
                     },
                     "domain": {
                        "type": "string"
                     },
                     "year_founded": {
                        "type": "integer"
                     },
                     "industry": {
                        "type": "string"
                     },
                     "employees_count": {
                        "type": "integer"
                     },
                     "locality": {
                        "type": "string"
                     },
                     "country": {
                        "type": "string"
                     },
                     "linkedin_url": {
                        "type": "string"
                     }
                  },
                  "required": [
                     "country",
                     "domain",
                     "employees_count",
                     "industry",
                     "linkedin_url",
                     "locality",
                     "name",
                     "year_founded"
                  ]
               }
            },
            "required": [
               "web_collection"
            ]
         }
      }
   },
   "required": [
      "criteria",
      "data",
      "sources",
      "status",
      "type"
   ]
}
PreviousRequest KYC ResultsNextWeb Scrapy API