Post Web Presence Request
curl --request POST \
--url https://api.baselayer.com/web_presence_requests \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data @- <<EOF
{
"name": "<string>",
"address": "<string>",
"options": [
"Order.NaicsPrediction",
"Order.WebsiteAnalysis",
"Order.SocialMedia",
"Order.ReviewSummary",
"Order.ReviewFull"
],
"iso2_country_code": "US",
"alternative_names": "Orginal Ray's Pizza",
"officer_names": [
"<string>"
],
"website": "<string>",
"phone_number": "<string>",
"email": "<string>",
"reference_id": "WebPresence1234",
"social_profiles": [
{
"site": "linked_in:company",
"value": "acme-corp"
}
]
}
EOFimport requests
url = "https://api.baselayer.com/web_presence_requests"
payload = {
"name": "<string>",
"address": "<string>",
"options": ["Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull"],
"iso2_country_code": "US",
"alternative_names": "Orginal Ray's Pizza",
"officer_names": ["<string>"],
"website": "<string>",
"phone_number": "<string>",
"email": "<string>",
"reference_id": "WebPresence1234",
"social_profiles": [
{
"site": "linked_in:company",
"value": "acme-corp"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: '<string>',
options: [
'Order.NaicsPrediction',
'Order.WebsiteAnalysis',
'Order.SocialMedia',
'Order.ReviewSummary',
'Order.ReviewFull'
],
iso2_country_code: 'US',
alternative_names: 'Orginal Ray\'s Pizza',
officer_names: ['<string>'],
website: '<string>',
phone_number: '<string>',
email: '<string>',
reference_id: 'WebPresence1234',
social_profiles: [{site: 'linked_in:company', value: 'acme-corp'}]
})
};
fetch('https://api.baselayer.com/web_presence_requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.baselayer.com/web_presence_requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'address' => '<string>',
'options' => [
'Order.NaicsPrediction',
'Order.WebsiteAnalysis',
'Order.SocialMedia',
'Order.ReviewSummary',
'Order.ReviewFull'
],
'iso2_country_code' => 'US',
'alternative_names' => 'Orginal Ray\'s Pizza',
'officer_names' => [
'<string>'
],
'website' => '<string>',
'phone_number' => '<string>',
'email' => '<string>',
'reference_id' => 'WebPresence1234',
'social_profiles' => [
[
'site' => 'linked_in:company',
'value' => 'acme-corp'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/web_presence_requests"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"options\": [\n \"Order.NaicsPrediction\",\n \"Order.WebsiteAnalysis\",\n \"Order.SocialMedia\",\n \"Order.ReviewSummary\",\n \"Order.ReviewFull\"\n ],\n \"iso2_country_code\": \"US\",\n \"alternative_names\": \"Orginal Ray's Pizza\",\n \"officer_names\": [\n \"<string>\"\n ],\n \"website\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_id\": \"WebPresence1234\",\n \"social_profiles\": [\n {\n \"site\": \"linked_in:company\",\n \"value\": \"acme-corp\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.baselayer.com/web_presence_requests")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"options\": [\n \"Order.NaicsPrediction\",\n \"Order.WebsiteAnalysis\",\n \"Order.SocialMedia\",\n \"Order.ReviewSummary\",\n \"Order.ReviewFull\"\n ],\n \"iso2_country_code\": \"US\",\n \"alternative_names\": \"Orginal Ray's Pizza\",\n \"officer_names\": [\n \"<string>\"\n ],\n \"website\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_id\": \"WebPresence1234\",\n \"social_profiles\": [\n {\n \"site\": \"linked_in:company\",\n \"value\": \"acme-corp\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/web_presence_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"options\": [\n \"Order.NaicsPrediction\",\n \"Order.WebsiteAnalysis\",\n \"Order.SocialMedia\",\n \"Order.ReviewSummary\",\n \"Order.ReviewFull\"\n ],\n \"iso2_country_code\": \"US\",\n \"alternative_names\": \"Orginal Ray's Pizza\",\n \"officer_names\": [\n \"<string>\"\n ],\n \"website\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_id\": \"WebPresence1234\",\n \"social_profiles\": [\n {\n \"site\": \"linked_in:company\",\n \"value\": \"acme-corp\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_type": "UNITED_STATES",
"id": "df6fc8ed-b90f-422e-9347-9c104acf0e13",
"state": "COMPLETED",
"created_at": "2026-10-29T05:44:48.455999",
"name": "Ray's Pizza",
"idempotency_key": "<string>",
"updated_at": "2026-10-29T05:44:48.456022",
"options": [
"Order.NaicsPrediction",
"Order.WebsiteAnalysis"
],
"alternative_names": "Orginal Ray's Pizza",
"address": "123 Main St, Anytown, USA",
"iso2_country_code": "US",
"website": "https://www.actual-valid-company-website.com/",
"officer_names": [
"John Doe",
"Jane Smith"
],
"phone_number": "123-456-7890",
"email": "support@example.com",
"reference_id": "WebPresence1234",
"business_address_match": "EXACT",
"business_address_match_sources": [
"FOUND_WEBSITE",
"REVIEW"
],
"phone_number_match": "EXACT",
"phone_number_match_sources": [
"FOUND_WEBSITE",
"SOCIAL_PROFILE"
],
"email_match": "EXACT",
"email_match_sources": [
"FOUND_WEBSITE",
"SOCIAL_PROFILE"
],
"people_match": true,
"people_match_sources": [
"FOUND_WEBSITE",
"DIRECTORY"
],
"business_website_match": true,
"business_website_redirect_match": true,
"found_website": "https://example.com/",
"website_accuracy": 0.95,
"found_social_profiles": [
{
"site": "instagram",
"username": "certifiedpowerinc",
"url": "https://www.instagram.com/certifiedpowerinc",
"confidence": "high",
"metadata": {
"is_private": false,
"is_business_account": true,
"has_business_address": true,
"bio": "Professional roofing services since 2010 🏠",
"followers_count": 1250,
"phone_number": "+12125551234",
"email": "contact@business.com",
"address": "123 Main St, Anytown, USA",
"business_website": "https://www.business.com"
},
"found_on": [
"FOUND_WEBSITE"
]
}
],
"input_social_profiles": [
{
"site": "instagram",
"username": "certifiedpowerinc",
"url": "https://www.instagram.com/certifiedpowerinc",
"confidence": "high",
"metadata": {
"is_private": false,
"is_business_account": true,
"has_business_address": true,
"bio": "Professional roofing services since 2010 🏠",
"followers_count": 1250,
"phone_number": "+12125551234",
"email": "contact@business.com",
"address": "123 Main St, Anytown, USA",
"business_website": "https://www.business.com"
},
"found_on": [
"FOUND_WEBSITE"
]
}
],
"social_profiles_match": [
{
"site": "instagram",
"value": "acme-corp",
"matched": true
}
],
"found_reviews": [
{
"url": "https://www.yelp.com/biz/certified-power-inc-mundelein",
"source": "yelp",
"confidence": "high",
"rating": 4.5,
"volume": 23,
"summary": "5 reviews mention that the service was great and the owner was very helpful.",
"phone_number": "+12125551234",
"address": "123 Main St, Anytown, USA",
"business_website": "https://www.example.com",
"reviews": [
{
"username": "John Doe",
"text": "This is a great review!",
"date": "2024-01-01",
"rating": 5
}
],
"metadata": {
"open_state": "Open",
"operating_hours": {},
"description": "<string>",
"types": [
"Restaurant",
"Italian restaurant"
],
"service_options": {}
}
}
],
"found_directory_listings": [
{
"source": "bbb.org",
"url": "https://www.bbb.org/us/ca/modesto/profile/plumber/joes-plumbing-1234",
"category": "Plumbing Contractor",
"business_name": "Joe's Plumbing & Heating",
"phone_number": "<string>",
"email": "<string>",
"business_website": "<string>",
"address": "<string>",
"people": [
{
"name": "<string>",
"title": "<string>"
}
]
}
],
"website_analysis": {
"addresses": [],
"console_url": "https://console.baselayer.com/website_analysis/uuid",
"email_deliverable": null,
"emails": [
"contact@example.com"
],
"id": "931a60db-33d9-427d-af7e-fd70aa05bde0",
"parked": false,
"people": [],
"phone_numbers": [
"123-456-7890"
],
"redirects": null,
"screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot",
"social_profiles": [],
"ssl_validity": null,
"url": "http://example.com/",
"website_build_status": null,
"website_structure_metrics": null,
"website_summary": null,
"whois_record": null
},
"input_website_analysis": {
"addresses": [],
"console_url": "https://console.baselayer.com/website_analysis/uuid",
"email_deliverable": null,
"emails": [
"contact@example.com"
],
"id": "c0ac144a-ef4c-4b1b-8dfb-82b11d98bd58",
"parked": false,
"people": [],
"phone_numbers": [
"123-456-7890"
],
"redirects": null,
"screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot",
"social_profiles": [],
"ssl_validity": null,
"url": "http://example.com/",
"website_build_status": null,
"website_structure_metrics": null,
"website_summary": null,
"whois_record": null
},
"industry_prediction": {
"accuracy": 0.95,
"code": "541330",
"keywords": [
"Engineering",
"Services"
],
"mcc_codes": [
{
"code": "1234",
"description": null,
"mastercard_risk": null,
"visa_risk_tier": null
}
],
"reasoning": null,
"risk_level": "low",
"sic_codes": [
{
"code": "5678",
"description": null
}
],
"title": "Engineering Services"
},
"scores": [
{
"type": "risk",
"score": 95,
"rating": "A"
}
],
"reason_codes": [
"SEARCH_ADDRESS_CMRA"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Web Presence
Post Web Presence Request
Submit a web presence request.
POST
/
web_presence_requests
Post Web Presence Request
curl --request POST \
--url https://api.baselayer.com/web_presence_requests \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data @- <<EOF
{
"name": "<string>",
"address": "<string>",
"options": [
"Order.NaicsPrediction",
"Order.WebsiteAnalysis",
"Order.SocialMedia",
"Order.ReviewSummary",
"Order.ReviewFull"
],
"iso2_country_code": "US",
"alternative_names": "Orginal Ray's Pizza",
"officer_names": [
"<string>"
],
"website": "<string>",
"phone_number": "<string>",
"email": "<string>",
"reference_id": "WebPresence1234",
"social_profiles": [
{
"site": "linked_in:company",
"value": "acme-corp"
}
]
}
EOFimport requests
url = "https://api.baselayer.com/web_presence_requests"
payload = {
"name": "<string>",
"address": "<string>",
"options": ["Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull"],
"iso2_country_code": "US",
"alternative_names": "Orginal Ray's Pizza",
"officer_names": ["<string>"],
"website": "<string>",
"phone_number": "<string>",
"email": "<string>",
"reference_id": "WebPresence1234",
"social_profiles": [
{
"site": "linked_in:company",
"value": "acme-corp"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: '<string>',
options: [
'Order.NaicsPrediction',
'Order.WebsiteAnalysis',
'Order.SocialMedia',
'Order.ReviewSummary',
'Order.ReviewFull'
],
iso2_country_code: 'US',
alternative_names: 'Orginal Ray\'s Pizza',
officer_names: ['<string>'],
website: '<string>',
phone_number: '<string>',
email: '<string>',
reference_id: 'WebPresence1234',
social_profiles: [{site: 'linked_in:company', value: 'acme-corp'}]
})
};
fetch('https://api.baselayer.com/web_presence_requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.baselayer.com/web_presence_requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'address' => '<string>',
'options' => [
'Order.NaicsPrediction',
'Order.WebsiteAnalysis',
'Order.SocialMedia',
'Order.ReviewSummary',
'Order.ReviewFull'
],
'iso2_country_code' => 'US',
'alternative_names' => 'Orginal Ray\'s Pizza',
'officer_names' => [
'<string>'
],
'website' => '<string>',
'phone_number' => '<string>',
'email' => '<string>',
'reference_id' => 'WebPresence1234',
'social_profiles' => [
[
'site' => 'linked_in:company',
'value' => 'acme-corp'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/web_presence_requests"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"options\": [\n \"Order.NaicsPrediction\",\n \"Order.WebsiteAnalysis\",\n \"Order.SocialMedia\",\n \"Order.ReviewSummary\",\n \"Order.ReviewFull\"\n ],\n \"iso2_country_code\": \"US\",\n \"alternative_names\": \"Orginal Ray's Pizza\",\n \"officer_names\": [\n \"<string>\"\n ],\n \"website\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_id\": \"WebPresence1234\",\n \"social_profiles\": [\n {\n \"site\": \"linked_in:company\",\n \"value\": \"acme-corp\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.baselayer.com/web_presence_requests")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"options\": [\n \"Order.NaicsPrediction\",\n \"Order.WebsiteAnalysis\",\n \"Order.SocialMedia\",\n \"Order.ReviewSummary\",\n \"Order.ReviewFull\"\n ],\n \"iso2_country_code\": \"US\",\n \"alternative_names\": \"Orginal Ray's Pizza\",\n \"officer_names\": [\n \"<string>\"\n ],\n \"website\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_id\": \"WebPresence1234\",\n \"social_profiles\": [\n {\n \"site\": \"linked_in:company\",\n \"value\": \"acme-corp\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/web_presence_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"options\": [\n \"Order.NaicsPrediction\",\n \"Order.WebsiteAnalysis\",\n \"Order.SocialMedia\",\n \"Order.ReviewSummary\",\n \"Order.ReviewFull\"\n ],\n \"iso2_country_code\": \"US\",\n \"alternative_names\": \"Orginal Ray's Pizza\",\n \"officer_names\": [\n \"<string>\"\n ],\n \"website\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"reference_id\": \"WebPresence1234\",\n \"social_profiles\": [\n {\n \"site\": \"linked_in:company\",\n \"value\": \"acme-corp\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_type": "UNITED_STATES",
"id": "df6fc8ed-b90f-422e-9347-9c104acf0e13",
"state": "COMPLETED",
"created_at": "2026-10-29T05:44:48.455999",
"name": "Ray's Pizza",
"idempotency_key": "<string>",
"updated_at": "2026-10-29T05:44:48.456022",
"options": [
"Order.NaicsPrediction",
"Order.WebsiteAnalysis"
],
"alternative_names": "Orginal Ray's Pizza",
"address": "123 Main St, Anytown, USA",
"iso2_country_code": "US",
"website": "https://www.actual-valid-company-website.com/",
"officer_names": [
"John Doe",
"Jane Smith"
],
"phone_number": "123-456-7890",
"email": "support@example.com",
"reference_id": "WebPresence1234",
"business_address_match": "EXACT",
"business_address_match_sources": [
"FOUND_WEBSITE",
"REVIEW"
],
"phone_number_match": "EXACT",
"phone_number_match_sources": [
"FOUND_WEBSITE",
"SOCIAL_PROFILE"
],
"email_match": "EXACT",
"email_match_sources": [
"FOUND_WEBSITE",
"SOCIAL_PROFILE"
],
"people_match": true,
"people_match_sources": [
"FOUND_WEBSITE",
"DIRECTORY"
],
"business_website_match": true,
"business_website_redirect_match": true,
"found_website": "https://example.com/",
"website_accuracy": 0.95,
"found_social_profiles": [
{
"site": "instagram",
"username": "certifiedpowerinc",
"url": "https://www.instagram.com/certifiedpowerinc",
"confidence": "high",
"metadata": {
"is_private": false,
"is_business_account": true,
"has_business_address": true,
"bio": "Professional roofing services since 2010 🏠",
"followers_count": 1250,
"phone_number": "+12125551234",
"email": "contact@business.com",
"address": "123 Main St, Anytown, USA",
"business_website": "https://www.business.com"
},
"found_on": [
"FOUND_WEBSITE"
]
}
],
"input_social_profiles": [
{
"site": "instagram",
"username": "certifiedpowerinc",
"url": "https://www.instagram.com/certifiedpowerinc",
"confidence": "high",
"metadata": {
"is_private": false,
"is_business_account": true,
"has_business_address": true,
"bio": "Professional roofing services since 2010 🏠",
"followers_count": 1250,
"phone_number": "+12125551234",
"email": "contact@business.com",
"address": "123 Main St, Anytown, USA",
"business_website": "https://www.business.com"
},
"found_on": [
"FOUND_WEBSITE"
]
}
],
"social_profiles_match": [
{
"site": "instagram",
"value": "acme-corp",
"matched": true
}
],
"found_reviews": [
{
"url": "https://www.yelp.com/biz/certified-power-inc-mundelein",
"source": "yelp",
"confidence": "high",
"rating": 4.5,
"volume": 23,
"summary": "5 reviews mention that the service was great and the owner was very helpful.",
"phone_number": "+12125551234",
"address": "123 Main St, Anytown, USA",
"business_website": "https://www.example.com",
"reviews": [
{
"username": "John Doe",
"text": "This is a great review!",
"date": "2024-01-01",
"rating": 5
}
],
"metadata": {
"open_state": "Open",
"operating_hours": {},
"description": "<string>",
"types": [
"Restaurant",
"Italian restaurant"
],
"service_options": {}
}
}
],
"found_directory_listings": [
{
"source": "bbb.org",
"url": "https://www.bbb.org/us/ca/modesto/profile/plumber/joes-plumbing-1234",
"category": "Plumbing Contractor",
"business_name": "Joe's Plumbing & Heating",
"phone_number": "<string>",
"email": "<string>",
"business_website": "<string>",
"address": "<string>",
"people": [
{
"name": "<string>",
"title": "<string>"
}
]
}
],
"website_analysis": {
"addresses": [],
"console_url": "https://console.baselayer.com/website_analysis/uuid",
"email_deliverable": null,
"emails": [
"contact@example.com"
],
"id": "931a60db-33d9-427d-af7e-fd70aa05bde0",
"parked": false,
"people": [],
"phone_numbers": [
"123-456-7890"
],
"redirects": null,
"screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot",
"social_profiles": [],
"ssl_validity": null,
"url": "http://example.com/",
"website_build_status": null,
"website_structure_metrics": null,
"website_summary": null,
"whois_record": null
},
"input_website_analysis": {
"addresses": [],
"console_url": "https://console.baselayer.com/website_analysis/uuid",
"email_deliverable": null,
"emails": [
"contact@example.com"
],
"id": "c0ac144a-ef4c-4b1b-8dfb-82b11d98bd58",
"parked": false,
"people": [],
"phone_numbers": [
"123-456-7890"
],
"redirects": null,
"screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot",
"social_profiles": [],
"ssl_validity": null,
"url": "http://example.com/",
"website_build_status": null,
"website_structure_metrics": null,
"website_summary": null,
"whois_record": null
},
"industry_prediction": {
"accuracy": 0.95,
"code": "541330",
"keywords": [
"Engineering",
"Services"
],
"mcc_codes": [
{
"code": "1234",
"description": null,
"mastercard_risk": null,
"visa_risk_tier": null
}
],
"reasoning": null,
"risk_level": "low",
"sic_codes": [
{
"code": "5678",
"description": null
}
],
"title": "Engineering Services"
},
"scores": [
{
"type": "risk",
"score": 95,
"rating": "A"
}
],
"reason_codes": [
"SEARCH_ADDRESS_CMRA"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Headers
An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked Idempotent-Replayed: true, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.
Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.
Example:
"respond-async"
Body
application/json
The name of the business to search for.
The address of the business.
The options for the web presence request. Defaults to Order.NaicsPrediction and Order.WebsiteAnalysis if not provided.
Available options:
Order.SocialMedia, Order.ReviewSummary, Order.ReviewFull, Order.NaicsPrediction, Order.WebsiteAnalysis, Order.DirectoryListing Example:
[ "Order.NaicsPrediction", "Order.WebsiteAnalysis", "Order.SocialMedia", "Order.ReviewSummary", "Order.ReviewFull" ]
The ISO 2 country code of the business. Omit it for a US business. US territories (PR, VI, GU, AS) are treated as US; any other code runs the international analysis.
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"US"
Alternative names for the business (e.g., DBA names)
Maximum array length:
10Example:
"Orginal Ray's Pizza"
List of business officers' names.
The website URL associated with the business.
Maximum string length:
2083A phone number associated with the business.
An email address associated with the business.
An optional reference ID to associate with the web presence request.
Maximum string length:
128Example:
"WebPresence1234"
Social media profiles associated with the business.
Maximum array length:
10Show child attributes
Show child attributes
Response
Response
- USWebPresenceResponse (v1)
- InternationalWebPresenceResponse (v1)
Web presence response - either US or International based on the request's country code.
This is a discriminated union that selects the appropriate response type
based on the request_type field.
The type of web presence request.
Allowed value:
"UNITED_STATES"Example:
"UNITED_STATES"
The ID of the Web Presence request
Example:
"df6fc8ed-b90f-422e-9347-9c104acf0e13"
The status of the Web Presence request
Available options:
PENDING, EXECUTING, COMPLETED, FAILED, CANCELLED Example:
"COMPLETED"
The date and time when the Web Presence request was created.
Example:
"2026-10-29T05:44:48.455999"
The name of the business as it was input for the search.
Example:
"Ray's Pizza"
The Idempotency-Key header the request that created this resource carried, if any.
The most recent date and time when the Web Presence request was updated.
Example:
"2026-10-29T05:44:48.456022"
The options for the web presence request.
Available options:
Order.SocialMedia, Order.ReviewSummary, Order.ReviewFull, Order.NaicsPrediction, Order.WebsiteAnalysis, Order.DirectoryListing Example:
[ "Order.NaicsPrediction", "Order.WebsiteAnalysis" ]
Alternative names for the business (e.g., DBA names)
Maximum array length:
10Example:
"Orginal Ray's Pizza"
The address of the business as it was input for the search.
Maximum string length:
255Example:
"123 Main St, Anytown, USA"
The ISO 2 country code the request was served under. A US territory given as input is reported as US.
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Example:
"US"
The website of the business as it was input for the search.
Example:
"https://www.actual-valid-company-website.com/"
A list of business officers related to the business as they were input for the search.
Example:
["John Doe", "Jane Smith"]
The phone number as it was input for the search.
Example:
"123-456-7890"
The email as it was input for the search.
Example:
"support@example.com"
An optional reference ID associated with the web presence request.
Maximum string length:
128Example:
"WebPresence1234"
Indicates how closely the inputted address matches the found business entity.
Available options:
NO_MATCH, CITY, STATE, SIMILAR, EXACT Example:
"EXACT"
The sources where the best address match was found. Only populated when business_address_match is not NoMatch.
Available options:
INPUT_WEBSITE, FOUND_WEBSITE, SOCIAL_PROFILE, INPUT_SOCIAL_PROFILE, REVIEW, DIRECTORY Example:
["FOUND_WEBSITE", "REVIEW"]
Indicates how closely the inputted phone number matches phone numbers found during discovery. Only populated when a phone number was provided in the request.
Available options:
NO_MATCH, EXACT, AREA_CODE Example:
"EXACT"
The sources where the best phone number match was found. Only populated when phone_number_match is not NoMatch.
Available options:
INPUT_WEBSITE, FOUND_WEBSITE, SOCIAL_PROFILE, INPUT_SOCIAL_PROFILE, REVIEW, DIRECTORY Example:
["FOUND_WEBSITE", "SOCIAL_PROFILE"]
Indicates how closely the inputted email matches emails found during discovery. Only populated when an email was provided in the request.
Available options:
NO_MATCH, EXACT, DOMAIN Example:
"EXACT"
The sources where the best email match was found. Only populated when email_match is not NoMatch.
Available options:
INPUT_WEBSITE, FOUND_WEBSITE, SOCIAL_PROFILE, INPUT_SOCIAL_PROFILE, REVIEW, DIRECTORY Example:
["FOUND_WEBSITE", "SOCIAL_PROFILE"]
True if at least one officer name matches a person discovered during web presence analysis (exact or similar). Only populated when officer_names were provided in the request.
Example:
true
The sources where the people match was found.
Available options:
INPUT_WEBSITE, FOUND_WEBSITE, SOCIAL_PROFILE, INPUT_SOCIAL_PROFILE, REVIEW, DIRECTORY Example:
["FOUND_WEBSITE", "DIRECTORY"]
Indicates whether the inputted website matches the found business entity.
Example:
true
Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.
Example:
true
The discovered website of the business.
Example:
"https://example.com/"
The confidence score of the discovered website.
Example:
0.95
A list of discovered social profiles related to the business.
Show child attributes
Show child attributes
Scraped social profiles from user-provided inputs.
Show child attributes
Show child attributes
Match results for user-provided social profile inputs. Each entry echoes back the original input (site, value) and indicates whether it was also independently found during organic social discovery.
Show child attributes
Show child attributes
A list of discovered reviews related to the business.
Show child attributes
Show child attributes
A list of discovered directory listings related to the business.
Show child attributes
Show child attributes
The website analysis details associated with the web presence.
Show child attributes
Show child attributes
Example:
{ "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": ["contact@example.com"], "id": "931a60db-33d9-427d-af7e-fd70aa05bde0", "parked": false, "people": [], "phone_numbers": ["123-456-7890"], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null }
The website analysis details associated with the input website.
Show child attributes
Show child attributes
Example:
{ "addresses": [], "console_url": "https://console.baselayer.com/website_analysis/uuid", "email_deliverable": null, "emails": ["contact@example.com"], "id": "c0ac144a-ef4c-4b1b-8dfb-82b11d98bd58", "parked": false, "people": [], "phone_numbers": ["123-456-7890"], "redirects": null, "screenshot_url": "https://api.baselayer.com/website_analysis/uuid/screenshot", "social_profiles": [], "ssl_validity": null, "url": "http://example.com/", "website_build_status": null, "website_structure_metrics": null, "website_summary": null, "whois_record": null }
The predicted NAICS code associated with the web presence.
Show child attributes
Show child attributes
Example:
{ "accuracy": 0.95, "code": "541330", "keywords": ["Engineering", "Services"], "mcc_codes": [ { "code": "1234", "description": null, "mastercard_risk": null, "visa_risk_tier": null } ], "reasoning": null, "risk_level": "low", "sic_codes": [{ "code": "5678", "description": null }], "title": "Engineering Services" }
The scores associated with the web presence request, including WebKYB and WebRisk scores.
Show child attributes
Show child attributes
The reason codes that hold on this result, sorted: conditions a rules engine can branch on. Each code's category, recommended severity and description are served by GET /reason_codes. Empty when none hold.
Every reason code Baselayer has ever issued.
Members are named exactly as their value so the code a customer sees is the code a developer greps for. A member is never removed: rows that recorded it still name it.
Available options:
ADDRESS_FAILED_TO_NORMALIZE, ENTITY_NOT_FOUND, BUSINESS_NAME_NO_MATCH, NO_ACTIVE_REGISTRATIONS, DOMESTIC_REGISTRATION_INACTIVE, SOLE_REGISTRATION_STATUS_UNKNOWN, ENTITY_AGE_UNDER_7D, ENTITY_AGE_UNDER_30D, ENTITY_AGE_UNDER_90D, ENTITY_AGE_UNDER_6M, ENTITY_AGE_UNDER_12M, TIN_MISMATCH, TIN_IS_SSN, ADDRESS_NO_MATCH, ADDRESS_PARTIAL_MATCH, SEARCH_ADDRESS_UNDELIVERABLE, SEARCH_ADDRESS_PO_BOX, SEARCH_ADDRESS_CMRA, SEARCH_ADDRESS_RESIDENTIAL, PRIMARY_ADDRESS_UNDELIVERABLE, PRIMARY_ADDRESS_PO_BOX, PRIMARY_ADDRESS_CMRA, PRIMARY_ADDRESS_RESIDENTIAL, NO_OFFICER_MATCH, SUBMITTED_DOMAIN_UNDER_7D, DISCOVERED_DOMAIN_UNDER_7D, TAX_LIEN_ACTIVE, TAX_LIEN_PAST, UCC_LIEN_ACTIVE, BANKRUPTCY_ACTIVE, BANKRUPTCY_RECENT, LITIGATION_ACTIVE, LITIGATION_RECENT, NETWORK_HIGH_VELOCITY, NETWORK_HIGH_APPLICATION_COUNT, ADDRESS_MISMATCH, NETWORK_NO_HISTORY Example:
["SEARCH_ADDRESS_CMRA"]