companies.use.x402atlas.com

{
  "properties": {
    "companies": {
      "description": "Matching companies; empty when nothing matched (still HTTP 200)",
      "items": {
        "properties": {
          "activities": {
            "description": "Up to 5 registered activities, main activity first when the registry marks one; empty when none are published",
            "items": {
              "properties": {
                "code": {
                  "description": "Registry activity code (NACE, NAF or SIC, as the registry publishes it)",
                  "type": "string"
                },
                "description": {
                  "description": "Activity description; null when the registry supplies only the code",
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "code",
                "description"
              ],
              "type": "object"
            },
            "maxItems": 5,
            "type": "array"
          },
          "address": {
            "description": "Registered (head-office) address; each part is null when the registry does not supply it",
            "properties": {
              "city": {
                "description": "City or post town",
                "type": [
                  "string",
                  "null"
                ]
              },
              "country_code": {
                "description": "ISO 3166-1 alpha-2 country code of the address",
                "type": [
                  "string",
                  "null"
                ]
              },
              "postal_code": {
                "description": "Postal code",
                "type": [
                  "string",
                  "null"
                ]
              },
              "street": {
                "description": "Street and house number",
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "street",
              "postal_code",
              "city",
              "country_code"
            ],
            "type": "object"
          },
          "founded": {
            "description": "Founding / registration date (YYYY-MM-DD)",
            "format": "date",
            "type": [
              "string",
              "null"
            ]
          },
          "legal_form": {
            "description": "Legal form as the registry names it, or the registry's legal-form code when it publishes no name",
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "description": "Current legal name",
            "type": "string"
          },
          "registration_number": {
            "description": "Canonical national registration number (BE enterprise number, FR SIREN, GB company number, NO organisasjonsnummer, FI business ID, CZ ICO, SK ICO, DE register type and number)",
            "type": "string"
          },
          "status": {
            "description": "Normalized registry status: active, inactive (ceased, dissolved, bankrupt or being wound up) or unknown",
            "enum": [
              "active",
              "inactive",
              "unknown"
            ],
            "type": "string"
          },
          "website": {
            "description": "Company website as registered; may lack a URL scheme",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "name",
          "registration_number",
          "status",
          "legal_form",
          "founded",
          "address",
          "activities",
          "website"
        ],
        "type": "object"
      },
      "maxItems": 5,
      "type": "array"
    },
    "count": {
      "description": "Number of entries in companies",
      "type": "integer"
    },
    "country": {
      "description": "ISO 3166-1 alpha-2 code of the route's country",
      "type": "string"
    },
    "matched_by": {
      "description": "number: the query was read as a registration number (exact lookup, 0 or 1 company; a German number without its court can match up to 5); name: company-name search (up to 5 companies)",
      "enum": [
        "number",
        "name"
      ],
      "type": "string"
    },
    "note": {
      "description": "Hint present only on the sample response (empty/omitted query) and on a zero-match response",
      "type": "string"
    },
    "query": {
      "description": "Echoed query (trimmed)",
      "type": "string"
    },
    "registry": {
      "description": "Official registry the result comes from",
      "type": "string"
    }
  },
  "required": [
    "country",
    "registry",
    "query",
    "matched_by",
    "count",
    "companies"
  ],
  "type": "object"
}