{"openapi":"3.1.0","info":{"title":"Klaris API","version":"1.0.0","description":"Klaris is an EU/GDPR-first validation and enrichment API. One key, one credit balance, success-billed lookups, 7-day cache."},"servers":[{"url":"https://0.0.0.0:3000/api/v1"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key"}}},"paths":{"/account":{"get":{"summary":"Account and credit balance","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Account"}}}},"/bulk/jobs":{"post":{"summary":"Start a bulk job","security":[{"bearerAuth":[]}],"responses":{"202":{"description":"Accepted"}}}},"/bulk/jobs/{id}":{"get":{"summary":"Bulk job status","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Job"}}}},"/bulk/jobs/{id}/results":{"get":{"summary":"Bulk job results","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Rows"}}}},"/phone":{"post":{"summary":"Phone validation","description":"Line type, country, carrier where derivable, and a risk level from numbering-plan data.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/email":{"post":{"summary":"Email validation","description":"Syntax, MX, SMTP mailbox probe, disposable/role/free detection and a 0–100 fraud score.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/ip":{"post":{"summary":"IP intelligence","description":"Geolocation, ASN/ISP, hosting, VPN/proxy/Tor flags and a risk score.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/phone-spam":{"post":{"summary":"Phone spam check","description":"0–100 spam score, robocaller flag, plus daily monitoring of numbers you own.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/hlr-lookup":{"post":{"summary":"HLR lookup","description":"Live mobile reachability from the home location register (provider required).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/carrier-lookup":{"post":{"summary":"Carrier lookup","description":"Current network and line type. Live porting data needs an upstream carrier feed.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/phone-scrub":{"post":{"summary":"Phone scrub","description":"List cleaning with DNC/litigator flags via a registered DNC adapter.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/fraud":{"post":{"summary":"Fraud detection","description":"Combined signup risk from phone, email and IP signals you already hold.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"phone_number":{"type":"string"},"ip":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/business-verify":{"post":{"summary":"Business verify","description":"One score for whether a business looks real, open and reachable.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"website":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/email-append":{"post":{"summary":"Email append","description":"Find an email from a name and postal address (people-data provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/reverse-email-append":{"post":{"summary":"Reverse email","description":"Identity context from an email address. Region-gated.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/reverse-ip-append":{"post":{"summary":"Reverse IP","description":"Org and hosting context from an IP, plus optional people-data adapter.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/reverse-phone-lookup":{"post":{"summary":"Reverse phone","description":"Owner context for a number. People-data provider, region-gated.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone_number":{"type":"string"},"lookup_source":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/phone-append":{"post":{"summary":"Skip trace","description":"Name and address in, phones out. Lawful-basis required.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postal_code":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/mobile-finder":{"post":{"summary":"Mobile finder","description":"Work email or profile URL to a mobile number (people-data provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile_url":{"type":"string"},"work_email":{"type":"string"},"personal_email":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/email-enrichment":{"post":{"summary":"Email enrichment","description":"Guess work-email patterns from name + domain, then MX-check them.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"domain":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/b2b-contact-append":{"post":{"summary":"B2B contact append","description":"Work email and title from a name and company (B2B provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"full_name":{"type":"string"},"company":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/company-firmographics":{"post":{"summary":"Company firmographics","description":"Industry, size and revenue band from a domain (B2B provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/company-profile-lookup":{"post":{"summary":"Company profile","description":"HQ, founding year and funding history from a domain (B2B provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/linkedin-profile-lookup":{"post":{"summary":"LinkedIn profile","description":"Public professional profile fields via a LinkedIn-licensed adapter.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile_url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/linkedin-company-lookup":{"post":{"summary":"LinkedIn company","description":"Company page fields via a LinkedIn-licensed adapter.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company_url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/linkedin-email-finder":{"post":{"summary":"LinkedIn email finder","description":"Work email from a profile URL (B2B/people provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profile_url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/business-lookup":{"post":{"summary":"Business lookup","description":"Listing data (address, hours, rating) from name + city.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"city":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/property-lookup":{"post":{"summary":"Property lookup","description":"US property attributes from an address (property-data provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/social-profile-check":{"post":{"summary":"Social profile check","description":"Handle existence and public counts across major platforms.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string"},"platform":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/social-post-lookup":{"post":{"summary":"Post lookup","description":"Public engagement fields for a post URL (social adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/video-transcript":{"post":{"summary":"Video transcript","description":"Spoken text from a public video URL (platform caption adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/social-search":{"post":{"summary":"Social search","description":"Keyword search across public posts (social adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"},"platform":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/ad-library-lookup":{"post":{"summary":"Ad library lookup","description":"Public ads from Meta, TikTok, LinkedIn and Google libraries.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"},"network":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/audience-demographics":{"post":{"summary":"TikTok audience demographics","description":"Follower country mix for a TikTok handle (social adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"handle":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/link-in-bio-lookup":{"post":{"summary":"Link-in-bio lookup","description":"Expands Linktree-style pages into destination URLs.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/search-intent-lookup":{"post":{"summary":"SERP scraper","description":"Organic results and related searches for a query (search adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string"},"country":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/keyword-metrics":{"post":{"summary":"Keyword metrics","description":"Volume, CPC and difficulty estimates (SEO adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyword":{"type":"string"},"country":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/domain-authority":{"post":{"summary":"Domain authority","description":"0–100 authority heuristic plus optional backlink-provider score.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/domain-age":{"post":{"summary":"Domain age","description":"Registration and expiry dates from RDAP/WHOIS.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/backlink-overview":{"post":{"summary":"Backlink overview","description":"Referring domains and follow mix (SEO adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/audience-intelligence":{"post":{"summary":"Audience intelligence","description":"Traffic mix and demographics for a domain (audience adapter).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/prospect-search":{"post":{"summary":"Prospect search","description":"People matching title, seniority and location (B2B provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"location":{"type":"string"},"company":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/account-search":{"post":{"summary":"Account search","description":"Companies by headcount, revenue and location (B2B provider).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"industry":{"type":"string"},"location":{"type":"string"},"headcount_min":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/website-scraper":{"post":{"summary":"Website scraper","description":"Fetch a URL and return cleaned text, title and links.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/website-contacts-scraper":{"post":{"summary":"Website contacts scraper","description":"Extract emails, phones and social profiles from a domain.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/audio-transcription":{"post":{"summary":"Audio transcription","description":"6 credits per minute. Speaker labels, word timestamps, language auto-detect.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"expected_duration_minutes":{"type":"string"}}}}}},"responses":{"200":{"description":"Lookup envelope"},"402":{"description":"Insufficient credits"}}}},"/job-change-monitors":{"post":{"summary":"Create a job-change monitor","security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Created"}}},"get":{"summary":"List job-change monitors","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"List"}}}},"/monitors":{"post":{"summary":"Create a phone spam monitor","security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Created"}}},"get":{"summary":"List phone monitors","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"List"}}}}}}