entity_lookup_request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/elhub/main/json-schema/elhub-entity-lookup-request-schema.json",
  "title": "entity_lookup_request",
  "description": "Request schema for entity lookup operations",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/elhub-openapi-api-base-openapi.yml#/components/schemas/entity_lookup_request",
  "summary": "Entity lookup",
  "type": "object",
  "properties": {
    "business_id": {
      "description": "The business identifier of the entity. Email address or organisation number, according to `business_id_type`.",
      "format": "text",
      "type": "string"
    },
    "business_id_type": {
      "description": "The type of business identifier. For persons, `email`. For organisations, `org` (organisation number, 9 digits).",
      "format": "text",
      "type": "string",
      "enum": [
        "email",
        "org"
      ]
    },
    "name": {
      "description": "Name of the entity.",
      "format": "text",
      "type": "string"
    },
    "type": {
      "description": "The type of the entity.",
      "format": "text",
      "type": "string",
      "enum": [
        "person",
        "organisation"
      ]
    }
  },
  "required": [
    "business_id",
    "business_id_type",
    "name",
    "type"
  ]
}