Referência da API

API de Resolução de identidade na Internet

Associe um domínio empresarial às identidades públicas declaradas explicitamente pelo respetivo site. Use esta referência para escolher uma operação e integrar seu contrato de resposta documentado.

Operações

GET /v1/identity-resolution Ver referência da API
POST /v1/identity-resolution/bulk Ver referência da API

GET /v1/identity-resolution

Operação: resolveInternetIdentity Créditos e autenticação: 2 Autenticação obrigatória
GET /v1/identity-resolution

Parâmetros de Consulta

Parâmetro Tipo obrigatório
domain string obrigatório
skip_cache string
Valores permitidos 1
opcional

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&skip_cache=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": [
      "[email protected]"
    ],
    "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

Operação: bulkResolveInternetIdentity Créditos e autenticação: 2 Autenticação obrigatória
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
  }
}

Recursos de referência