> ## Documentation Index
> Fetch the complete documentation index at: https://developer.kyberis.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get entity

## Scope and credits

| Requirement     | Value                |
| --------------- | -------------------- |
| Required scopes | `read:resolution`    |
| Credits         | 1 credit per request |


## OpenAPI

````yaml GET /v2/entities/{canonical_id}
openapi: 3.1.0
info:
  description: Deterministic, evidence-backed threat assessment API for machine consumers.
  title: Threat Investigator API v2
  version: 0.1.0
servers: []
security: []
paths:
  /v2/entities/{canonical_id}:
    get:
      tags:
        - Resolution
      summary: Hydrate a canonical entity identifier
      operationId: entity_lookup_v2_entities__canonical_id__get
      parameters:
        - in: path
          name: canonical_id
          required: true
          schema:
            title: Canonical Id
            type: string
        - in: query
          name: include_aliases
          required: false
          schema:
            default: true
            title: Include Aliases
            type: boolean
        - in: query
          name: include_metadata
          required: false
          schema:
            default: true
            title: Include Metadata
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityLookupResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - ApiKeyAuth: []
components:
  schemas:
    EntityLookupResponse:
      properties:
        aliases:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Aliases
        canonical_id:
          title: Canonical Id
          type: string
        canonical_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Canonical Name
        entity_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Type
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
        status:
          enum:
            - found
            - not_found
          title: Status
          type: string
      required:
        - status
        - canonical_id
      title: EntityLookupResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: ApiKey <key_id>:<secret>
      in: header
      name: Authorization
      type: apiKey

````