> ## 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. # Declared licenses for one component (papi License service) > Resolves the declared licenses of a single component from the `purl_licenses` knowledge base, walking the configured source priority and falling back from the exact version to the nearest mined version and then the unversioned entry. `info_code` reports `REQUIREMENT_NOT_MET` / `VERSION_NOT_FOUND` / `NO_INFO`. Mirrors papi `GetComponentLicenses`. ## OpenAPI ````yaml /api-reference/developer-tools/v3-openapi.yaml get /v3/licenses openapi: 3.0.3 info: title: SCANOSS Services API version: 0.28.1 description: | Consolidated HTTP API for the SCANOSS knowledge base. Exposes the following domains under a single `/v3/*` prefix: * **licenses** — attribution files + per-file license evidence * **copyright** — copyright evidence + holders (stubbed pending data) * **components** — free-form search, versions and lifecycle status * **crypto** — algorithms, hints and version ranges per purl, plus ruleset tarball downloads * **crypto reachability** — stitched cryptographic findings, call chains, entry points, supporting and forward calls per component or frozen dependency tree * **dependencies** — declared dependencies (with composite-license resolution) and bounded transitive walks * **geo** — contributor declared/curated locations and timezone-based origin distribution * **vulnerabilities** (path `/vuln/*`) — CVE detection by merging the local NVD KB with osv.dev, enriched with EPSS * **scan** — direct SCANOSS engine scans (WFP upload, MD5 / urlhash / snippet lookups) * **contents** — raw notice / source-code content from the mz store Every batch endpoint encodes per-item failures as `info_code` / `info_message` so the call as a whole returns 200 with a `status.status` ∈ {SUCCESS, PARTIAL_SUCCESS, ERROR}. Single-purl GETs derive the same status from the item's `info_code`. servers: - url: https://api.scanoss.com description: Production security: [] tags: - name: licenses description: License attribution files and per-file license evidence - name: copyright description: Copyright evidence and holders (stubbed pending KB data) - name: components description: Component search, versions and lifecycle status - name: cryptography description: Cryptographic algorithms, hints, version ranges and ruleset downloads - name: cryptography-reachability description: > Crypto reachability over mining results: stitched findings, call chains, crypto entry points, supporting calls and bounded forward calls, for one component (with its mined dependency closure) or a caller-supplied frozen dependency tree. Registered only when reachability_db.dsn is configured. - name: dependencies description: Declared dependencies (per component) and transitive walks - name: geoprovenance description: Contributor locations (declared + curated) and origin distribution - name: vulnerabilities description: CVE detection (local KB + OSV) and CPE lookup - name: scan description: > Direct SCANOSS engine scans (passthrough), plus MD5 / urlhash / snippet lookups, and the dual-mode batch endpoint (synchronous single-shot WFP and chunked-async upload over the batchScanner pipeline). Registered only when scan.engine_path is configured. - name: contents description: Raw notice / source-code content from the mz store paths: /v3/licenses: get: tags: - licenses summary: Declared licenses for one component (papi License service) description: | Resolves the declared licenses of a single component from the `purl_licenses` knowledge base, walking the configured source priority and falling back from the exact version to the nearest mined version and then the unversioned entry. `info_code` reports `REQUIREMENT_NOT_MET` / `VERSION_NOT_FOUND` / `NO_INFO`. Mirrors papi `GetComponentLicenses`. operationId: getLicensesComponent parameters: - $ref: '#/components/parameters/PurlQuery' - $ref: '#/components/parameters/RequirementQuery' - $ref: '#/components/parameters/SearchMaxResults' - $ref: '#/components/parameters/SearchShowRelated' - $ref: '#/components/parameters/SearchShowURL' - $ref: '#/components/parameters/SearchOnVersionNotFound' - $ref: '#/components/parameters/SearchEncoded' responses: '200': description: Licenses resolved for the component. content: application/json: schema: $ref: '#/components/schemas/ComponentLicenseResponse' '400': $ref: '#/components/responses/BadRequest' '500': $ref: '#/components/responses/InternalError' components: parameters: PurlQuery: in: query name: purl required: true schema: type: string description: Package URL (e.g. `pkg:github/scanoss/engine`) example: pkg:github/scanoss/engine RequirementQuery: in: query name: requirement required: false schema: type: string description: Optional version requirement (e.g. `v5.4.5`) example: v5.4.5 SearchMaxResults: in: query name: max_results_per_purl required: false schema: type: integer minimum: 0 description: Caps the per-purl result array. 0/absent = no limit. SearchShowRelated: in: query name: show_related_results required: false schema: type: boolean default: false description: Enable the source-purl fallback lookup. SearchShowURL: in: query name: show_url required: false schema: type: boolean default: false description: Include a `url` in results (placeholder — data source TBD). SearchOnVersionNotFound: in: query name: on_version_not_found required: false schema: type: string default: strict enum: - strict - show_latest - show_closest_lt - show_closest_gt - show_any description: Version fallback strategy (not applied to range endpoints). SearchEncoded: in: query name: encoded required: false schema: type: string default: none enum: - none - url_encoded - base64_encoded description: >- Output encoding for content string values (`none` default, `url_encoded`, `base64_encoded`); control fields and object keys are never encoded. schemas: ComponentLicenseResponse: type: object properties: component: $ref: '#/components/schemas/ComponentLicenseInfo' status: $ref: '#/components/schemas/LookupStatusResponse' ComponentLicenseInfo: type: object description: > Per-component license result. `info_code` is one of `REQUIREMENT_NOT_MET`, `VERSION_NOT_FOUND`, `NO_INFO` (absent on an exact match). properties: purl: type: string requirement: type: string version: type: string statement: type: string description: License IDs joined with " AND ". example: GPL-2.0-only AND MIT licenses: type: array items: $ref: '#/components/schemas/LicenseInfo' url: type: string info_message: type: string info_code: type: string LookupStatusResponse: type: object description: Outcome of a licenses-service call (papi common StatusResponse). properties: status: type: string enum: - SUCCESS - SUCCEEDED_WITH_WARNINGS - FAILED message: type: string ErrorBody: type: object required: - status - error - timestamp properties: status: type: string enum: - error error: type: object required: - code - message properties: code: type: string description: | Stable machine-readable error identifier. Possible values: - INVALID_BODY, INVALID_QUERY, INVALID_FILE_HASH, INVALID_RANGE - EMPTY_BATCH - INVALID_PURL, COMPONENT_NOT_FOUND, VERSION_NOT_FOUND - NOTICE_NOT_FOUND, FILE_NOT_FOUND, MZ_READ_FAILED - TIMEOUT, INTERNAL_ERROR message: type: string timestamp: type: string format: date-time LicenseInfo: type: object description: One resolved license of a component. properties: id: type: string example: GPL-2.0-only full_name: type: string example: GNU General Public License v2.0 only is_spdx_approved: type: boolean url: type: string example: https://spdx.org/licenses/GPL-2.0-only.html responses: BadRequest: description: Invalid request parameters or body content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: status: error error: code: INVALID_QUERY message: purl query parameter is required timestamp: '2026-05-19T11:39:56Z' InternalError: description: Unexpected server error content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: status: error error: code: INTERNAL_ERROR message: ... timestamp: '2026-05-19T11:39:56Z' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.