Referência para desenvolvedores

Consulta de empresa

Explore a documentação da API de Consulta de empresa, os parâmetros de solicitação, os campos de resposta, os exemplos de código e o tratamento de erros para integrações com o DomScan.

Consulta de empresa

Obtenha informações públicas sobre a empresa associada a um domínio, como razão social, setor, descrição e perfis nas redes sociais. O DomScan combina várias fontes públicas para montar o perfil, portanto a precisão e a abrangência dos dados podem variar.

GET /v1/company

Parâmetros de Consulta

ParâmetroTipoDescrição
domain obrigatório string Domínio da empresa que você deseja consultar (por exemplo, "stripe.com")

Campos de Resposta

CampoDescrição
company.nameNome oficial da empresa
company.industryClassificação por setor
company.descriptionDescrição da atividade
company.foundedAno de fundação (se conhecido)
company.employeesFaixa estimada de funcionários
company.locationLocalização da sede
socialLinks do LinkedIn, Twitter, Facebook

Casos de Utilização

  • Enriquecimento e qualificação de leads
  • Enriquecimento de dados do CRM
  • Inteligência competitiva
  • Pesquisa de fornecedores e parceiros

Pedido de Exemplo

curl -H "X-API-Key: your-api-key" "https://domscan.net/v1/company?domain=stripe.com"

Resposta de Exemplo

{
                "domain": "stripe.com",
                "company": {
                "name": "Stripe, Inc.",
                "industry": "Financial Technology",
                "description": "Online payment processing platform",
                "founded": 2010,
                "employees": "1000-5000",
                "location": "San Francisco, CA"
                },
                "social": {
                "linkedin": "https://linkedin.com/company/stripe",
                "twitter": "https://twitter.com/stripe"
                }
                }
GET /v1/identity-assets

Parâmetros de Consulta

Parâmetro Tipo obrigatório
domain string obrigatório

Campos de Resposta

Campo Tipo
domain string
website_url string
fetch_state string
organization_name string | null
assets object
assets.logo_url string | null
assets.logo_kind string | null
assets.logo_source string | null
assets.logo_verification string | null
assets.favicon_url string | null
assets.touch_icon_url string | null
assets.preview_image_url string | null
assets.manifest_url string | null
assets.theme_color string | null
assets.candidates[] object[]
assets.candidates[] object
assets.candidates[].url string
assets.candidates[].kind string
assets.candidates[].source string
assets.candidates[].type string | null
assets.candidates[].sizes string | null
assets.candidates[].score integer
assets.candidates[].confidence string
social_profiles[] object[]
social_profiles[] object
social_profiles[].platform string
social_profiles[].type string
social_profiles[].handle string | null
social_profiles[].url string
social_profiles[].source string
social_profiles[].confidence string
confidence number
evidence[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string

Pedido de Exemplo

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/identity-assets?domain=example.com"

Resposta de Exemplo

{
  "domain": "example.com",
  "website_url": "https://example.com",
  "fetch_state": "ok",
  "organization_name": "string",
  "assets": {
    "logo_url": "https://example.com",
    "logo_kind": "logo",
    "logo_source": "string",
    "logo_verification": "verified",
    "favicon_url": "https://example.com",
    "touch_icon_url": "https://example.com",
    "preview_image_url": "https://example.com",
    "manifest_url": "https://example.com",
    "theme_color": "string",
    "candidates": [
      {
        "url": "https://example.com",
        "kind": "string",
        "source": "string",
        "type": "string",
        "sizes": "string",
        "score": 1,
        "confidence": "high"
      }
    ]
  },
  "social_profiles": [
    {
      "platform": "github",
      "type": "social",
      "handle": "example",
      "url": "https://example.com",
      "source": "same_as",
      "confidence": "high"
    }
  ],
  "confidence": 1,
  "evidence": [
    "string"
  ],
  "meta": {
    "checked_at": "2026-04-15T12:00:00Z",
    "cached": true,
    "fetch_transport": "worker"
  }
}
POST /v1/identity-assets/bulk

Parâmetros do Corpo

Parâmetro Tipo obrigatório
domains string[] obrigatório

Campos de Resposta

Campo Tipo
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.message string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

Pedido de Exemplo

curl -X POST "https://domscan.net/v1/identity-assets/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domains": [
    "stripe.com",
    "github.com"
  ]
}'

Resposta de Exemplo

{
  "results": [
    {
      "input": "string",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "message": "Invalid domain format",
          "suggestion": "string",
          "details": {},
          "retry_after": 300,
          "docs_url": "/docs#parameters"
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}
GET /v1/identity-resolution

Parâmetros de Consulta

Parâmetro Tipo obrigatório
domain string obrigatório

Campos de Resposta

Campo Tipo
query string
canonical_domain string
website_url string
fetch_state string
organization object
organization.name string | null
organization.description string | null
identities[] object[]
identities[] object
identities[].platform string
identities[].type string
identities[].handle string | null
identities[].url string
identities[].source string
identities[].confidence string
contacts object
contacts.emails[] string[]
contacts.phones[] string[]
confidence number
evidence object
evidence.declared_identity_count integer
evidence.high_confidence_count integer
evidence.medium_confidence_count integer
evidence.sources[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string

Pedido de Exemplo

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/identity-resolution?domain=example.com"

Resposta de Exemplo

{
  "query": "string",
  "canonical_domain": "example.com",
  "website_url": "https://example.com",
  "fetch_state": "ok",
  "organization": {
    "name": "string",
    "description": "198.51.100.10"
  },
  "identities": [
    {
      "platform": "github",
      "type": "social",
      "handle": "example",
      "url": "https://example.com",
      "source": "same_as",
      "confidence": "high"
    }
  ],
  "contacts": {
    "emails": [
      "alerts@example.com"
    ],
    "phones": [
      "string"
    ]
  },
  "confidence": 1,
  "evidence": {
    "declared_identity_count": 1,
    "high_confidence_count": 1,
    "medium_confidence_count": 1,
    "sources": [
      "string"
    ]
  },
  "meta": {
    "checked_at": "2026-04-15T12:00:00Z",
    "cached": true,
    "fetch_transport": "worker"
  }
}
POST /v1/identity-resolution/bulk

Parâmetros do Corpo

Parâmetro Tipo obrigatório
domains string[] obrigatório

Campos de Resposta

Campo Tipo
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.message string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

Pedido de Exemplo

curl -X POST "https://domscan.net/v1/identity-resolution/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domains": [
    "stripe.com",
    "github.com"
  ]
}'

Resposta de Exemplo

{
  "results": [
    {
      "input": "string",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "message": "Invalid domain format",
          "suggestion": "string",
          "details": {},
          "retry_after": 300,
          "docs_url": "/docs#parameters"
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}
GET /v1/url-intelligence

Parâmetros de Consulta

Parâmetro Tipo obrigatório
url string obrigatório

Campos de Resposta

Campo Tipo
requested_url string
final_url string
status integer
fetch_state string
content_type string | null
redirects integer
title string | null
description string | null
canonical_url string | null
language string | null
favicon_url string | null
preview_image_url string | null
manifest_url string | null
theme_color string | null
open_graph object
twitter_card object
structured_data object
structured_data.types[] string[]
structured_data.items integer
structured_data.parse_errors integer
robots object
robots.meta[] string[]
robots.header[] string[]
robots.indexable boolean | null
security_headers object
links object
links.total integer
links.internal integer
links.external integer
social_profiles[] object[]
social_profiles[] object
social_profiles[].platform string
social_profiles[].type string
social_profiles[].handle string | null
social_profiles[].url string
social_profiles[].source string
social_profiles[].confidence string
contacts object
contacts.emails[] string[]
contacts.phones[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string

Pedido de Exemplo

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/url-intelligence?url=https%3A%2F%2Fexample.com"

Resposta de Exemplo

{
  "requested_url": "https://example.com",
  "final_url": "https://example.com",
  "status": 1,
  "fetch_state": "ok",
  "content_type": "string",
  "redirects": 1,
  "title": "string",
  "description": "198.51.100.10",
  "canonical_url": "https://example.com",
  "language": "string",
  "favicon_url": "https://example.com",
  "preview_image_url": "https://example.com",
  "manifest_url": "https://example.com",
  "theme_color": "string",
  "open_graph": {},
  "twitter_card": {},
  "structured_data": {
    "types": [
      "string"
    ],
    "items": 1,
    "parse_errors": 1
  },
  "robots": {
    "meta": [
      "string"
    ],
    "header": [
      "string"
    ],
    "indexable": true
  },
  "security_headers": {},
  "links": {
    "total": 1,
    "internal": 1,
    "external": 1
  },
  "social_profiles": [
    {
      "platform": "github",
      "type": "social",
      "handle": "example",
      "url": "https://example.com",
      "source": "same_as",
      "confidence": "high"
    }
  ],
  "contacts": {
    "emails": [
      "alerts@example.com"
    ],
    "phones": [
      "string"
    ]
  },
  "meta": {
    "checked_at": "2026-04-15T12:00:00Z",
    "cached": true,
    "fetch_transport": "worker"
  }
}
POST /v1/url-intelligence/bulk

Parâmetros do Corpo

Parâmetro Tipo obrigatório
urls string[] obrigatório

Campos de Resposta

Campo Tipo
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.message string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

Pedido de Exemplo

curl -X POST "https://domscan.net/v1/url-intelligence/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "urls": [
    "https://example.com",
    "https://github.com/about"
  ]
}'

Resposta de Exemplo

{
  "results": [
    {
      "input": "string",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "message": "Invalid domain format",
          "suggestion": "string",
          "details": {},
          "retry_after": 300,
          "docs_url": "/docs#parameters"
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}