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

# Get detailed metadata for a specific license by SPDX identifier.

> Provides comprehensive license information including SPDX registry data,
OSADL compliance metadata, license type classification, and official references.



## OpenAPI

````yaml /api-reference/licenses-openapi.json get /v2/licenses/details
openapi: 3.0.0
info:
  title: SCANOSS License Service
  description: License service provides license intelligence for software components.
  version: '2.0'
  contact:
    name: scanoss-licenses
    url: https://github.com/scanoss/licenses
    email: support@scanoss.com
servers:
  - url: http://api.scanoss.com
  - url: https://api.scanoss.com
security: []
tags:
  - name: License
paths:
  /v2/licenses/details:
    get:
      tags:
        - License
      summary: Get detailed metadata for a specific license by SPDX identifier.
      description: >-
        Provides comprehensive license information including SPDX registry data,

        OSADL compliance metadata, license type classification, and official
        references.
      operationId: License_GetDetails
      parameters:
        - name: id
          description: >-
            SPDX identifier or licenseRef (e.g., "MIT",
            "licenseRef-GitLab-Enterprise")
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2LicenseDetailsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
components:
  schemas:
    v2LicenseDetailsResponse:
      type: object
      properties:
        license:
          $ref: '#/components/schemas/v2LicenseDetails'
        status:
          $ref: '#/components/schemas/v2StatusResponse'
      description: >-
        Response message for GetDetails method.


        Provides comprehensive license metadata including SPDX registry
        information,

        OSADL compliance data, license type classification, and official
        references.
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    v2LicenseDetails:
      type: object
      properties:
        full_name:
          type: string
          title: >-
            Best human-readable license name (normalized when possible)

            - For SPDX licenses: Official SPDX name (e.g., "MIT License", "GNU
            General Public License v2.0 only")

            - For non SPDX licenses: Best normalized name from SCANOSS database
            or original statement
        type:
          $ref: '#/components/schemas/v2LicenseType'
        spdx:
          $ref: '#/components/schemas/v2SPDX'
        osadl:
          $ref: '#/components/schemas/v2OSADL'
      description: >-
        Comprehensive license metadata container.


        Provides detailed information about a specific license including SPDX
        registry data,

        OSADL compliance metadata, license type classification, and official
        references.
    v2StatusResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/v2StatusCode'
        message:
          type: string
          title: Status message
        db:
          $ref: '#/components/schemas/StatusResponseDB'
        server:
          $ref: '#/components/schemas/StatusResponseServer'
      description: Detailed response details.
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
    v2LicenseType:
      type: string
      enum:
        - UNKNOWN
        - PERMISSIVE
        - COPYLEFT
        - COMMERCIAL
        - PROPRIETARY
        - PUBLIC_DOMAIN
      default: UNKNOWN
      description: >-
        Classification of license types based on their usage restrictions and
        obligations.


        Used to categorize licenses by their general characteristics and
        compliance requirements.

         - UNKNOWN: License type could not be determined or classified
         - PERMISSIVE: Allows liberal use with minimal restrictions (e.g., MIT, BSD, Apache)
         - COPYLEFT: Requires derivative works to be distributed under the same license (e.g., GPL, LGPL)
         - COMMERCIAL: Requires payment or commercial licensing agreement
         - PROPRIETARY: Proprietary license with restricted usage rights
         - PUBLIC_DOMAIN: No copyright restrictions, dedicated to public domain (e.g., CC0, Unlicense)
    v2SPDX:
      type: object
      properties:
        id:
          type: string
          title: SPDX license identifier, "GPL-2.0-only", "MIT"
        full_name:
          type: string
          title: Official SPDX registry name (empty if license not in SPDX registry)
        details_url:
          type: string
          title: JSON API URL for full details
        reference_url:
          type: string
          title: HTML page URL
        is_deprecated:
          type: boolean
          title: Whether this license is deprecated by the SPDX License List
        is_fsf_libre:
          type: boolean
          title: >-
            Whether the Free Software Foundation considers this license
            libre/free
        is_osi_approved:
          type: boolean
          title: Whether this license is approved by the Open Source Initiative (OSI)
        see_also:
          type: array
          items:
            type: string
          title: Related URLs
        cross_refs:
          type: array
          items:
            $ref: '#/components/schemas/SPDXSPDXCrossRef'
          title: Structured cross-references with validation info
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/SPDXSPDXException'
          title: SPDX exceptions applied to this license (empty if none)
      description: SPDX license registry metadata.
    v2OSADL:
      type: object
      properties:
        copyleft_clause:
          type: boolean
          title: >-
            Indicates whether the license contains copyleft obligations
            requiring derivative works to use the same license
        patent_hints:
          type: boolean
          title: >-
            Indicates whether the license contains patent-related clauses or
            considerations
        compatibility:
          type: array
          items:
            type: string
          title: >-
            List of licenses that are compatible for combination with this
            license
        depending_compatibility:
          type: array
          items:
            type: string
          title: >-
            List of licenses that are compatible when depending on components
            with this license
        incompatibility:
          type: array
          items:
            type: string
          title: >-
            List of licenses that are incompatible and cannot be combined with
            this license
        use_cases:
          type: array
          items:
            $ref: '#/components/schemas/OSADLOSADLUseCase'
          title: >-
            Structured use cases with specific obligations for different
            distribution scenarios
      description: >-
        OSADL compliance metadata providing license analysis and compatibility
        information.
    v2StatusCode:
      type: string
      enum:
        - UNSPECIFIED
        - SUCCESS
        - SUCCEEDED_WITH_WARNINGS
        - WARNING
        - FAILED
      default: UNSPECIFIED
      description: Status code Enum.
    StatusResponseDB:
      type: object
      properties:
        schema_version:
          type: string
          title: Semantic schema version (e.g., 'v1.0.0')
        created_at:
          type: string
          title: When this DB was built (ISO 8601 format)
      description: Database version information.
    StatusResponseServer:
      type: object
      properties:
        version:
          type: string
          title: Semantic version (e.g., 'v1.0.0')
      description: Server information.
    SPDXSPDXCrossRef:
      type: object
      properties:
        url:
          type: string
          title: Reference URL to the license text
        is_valid:
          type: boolean
          description: >-
            Indicates if SPDX considers this URL an authoritative/trustworthy
            source for the license.
        is_live:
          type: boolean
          title: Whether the URL is currently accessible via HTTP request
        timestamp:
          type: string
          title: ISO 8601 timestamp when the validation was last performed
        is_wayback_link:
          type: boolean
          title: Whether this URL points to an archived/Wayback Machine version
        order:
          type: integer
          format: int32
          title: Display order/priority for multiple references (0-based)
        match:
          type: string
          title: >-
            SPDX License Matching Guidelines compliance result:

            "true" - URL content matches SPDX template patterns (suitable for
            automated validation)

            "false" - URL content doesn't match patterns, often due to
            additional text beyond original license

            "N/A" - Matching validation not applicable

            See:
            https://spdx.github.io/spdx-spec/v2.3/license-matching-guidelines-and-templates/
      description: >-
        Cross-reference information for SPDX license URLs.


        Contains metadata about license reference URLs and their compliance with
        SPDX 

        License Matching Guidelines.

        See:
        https://spdx.github.io/spdx-spec/v2.3/license-matching-guidelines-and-templates/
    SPDXSPDXException:
      type: object
      properties:
        id:
          type: string
          title: SPDX exception identifier, "Classpath-exception-2.0"
        full_name:
          type: string
          title: SPDX exception registry name, "Classpath exception 2.0"
        details_url:
          type: string
          title: SPDX exception JSON URL
        see_also:
          type: array
          items:
            type: string
          title: Reference URLs
        is_deprecated:
          type: boolean
          title: Whether this SPDX exception is deprecated by the SPDX License List
      description: |-
        SPDX exception grant an exception to a license condition or additional
        permissions beyond those granted in a license.
        NOTE: this is not a stand-alone license.
    OSADLOSADLUseCase:
      type: object
      properties:
        name:
          type: string
          title: '"Binary delivery", "Network service", "Source code delivery"'
        obligation_text:
          type: string
          title: Human-readable obligation text
        obligation_json:
          type: string
          title: >-
            Machine-readable structured obligations with Language/Action/Term
            breakdown
      description: OSADL use case with structured obligations.

````