Firmaradar API

openapi: 3.1.0
info:
  title: Firmaradar API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 8 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Firmaradar has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 5
    pages-with-code: 3
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://apidocs.firmaradar.no/api/openapi.yaml
  - https://apidocs.firmaradar.no/api/openapi.json
  - https://apidocs.firmaradar.no/agentisk-flyt
  - https://api-docs.firmaradar.no/agentisk-flyt
  - https://api-docs.firmaradar.no/api/openapi.yaml
  - https://api-docs.firmaradar.no/api/openapi.json
  - https://apidocs.firmaradar.no/agentisk-flyt?lang=no
servers:
- url: https://firmaradar.no
paths:
  /api/v1/aml/report/{reportId}:
    get:
      operationId: get_api_v1_aml_report_reportId
      tags:
      - Api
      summary: Get AML report status
      x-source: https://apidocs.firmaradar.no/api/openapi.json
      parameters:
      - name: reportId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1AmlReportReportidResponse'
      x-evidence:
        kind: documentation
  /api/v1/nace/subscriptions:
    get:
      operationId: get_api_v1_nace_subscriptions
      tags:
      - Api
      summary: GET /api/v1/nace/subscriptions
      x-source: https://apidocs.firmaradar.no/agentisk-flyt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "X-API-Key: $FIRMARADAR_API_KEY"  "https://firmaradar.no/api/v1/nace/subscriptions" '
    post:
      operationId: post_api_v1_nace_subscriptions
      tags:
      - Api
      summary: Agentisk flyt | Firmaradar.no
      description: Opprett NACE-abonnement (overvåk seksjon A i Oslo fylke).
      x-source: https://apidocs.firmaradar.no/agentisk-flyt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1NaceSubscriptionsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/nace/subscriptions/{subscriptionid}:
    patch:
      operationId: patch_api_v1_nace_subscriptions_subscriptionid
      tags:
      - Api
      summary: PATCH /api/v1/nace/subscriptions/{subscriptionId}
      x-source: https://apidocs.firmaradar.no/agentisk-flyt
      parameters:
      - name: subscriptionid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiV1NaceSubscriptionsSubscriptionidRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PATCH -H \"X-API-Key: $FIRMARADAR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{\"aktivert\": false}'  \"https://firmaradar.no/api/v1/nace/subscriptions/42\"\
          \ \n Webhook-leveranse \n Firmaradar POSTer JSON til din url med\n Content-Type: application/json \n Valgfri signering (NACE): når abonnementet\
          \ har en signing_secret, signeres hver leveranse med\n X-Firmaradar-Signature (HMAC-SHA256\n over d"
  /api/v1/risikoscoring/confirm-disclaimer:
    post:
      operationId: post_api_v1_risikoscoring_confirm_disclaimer
      tags:
      - Api
      summary: Confirm the pre-screening disclaimer through the API
      description: Confirms the same pre‑screening disclaimer as the portal modal through an authenticated API call.
      x-source: https://apidocs.firmaradar.no/api/openapi.yaml
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1RisikoscoringConfirmDisclaimerRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1RisikoscoringConfirmDisclaimerResponse'
      x-evidence:
        kind: documentation
  /api/v1/risikoscoring/disclaimer:
    get:
      operationId: get_api_v1_risikoscoring_disclaimer
      tags:
      - Api
      summary: Get the pre-screening disclaimer and confirmation status
      description: Returns the current risk‑scoring pre‑screening disclaimer text, version and whether the company has confirmed it.
      x-source: https://apidocs.firmaradar.no/api/openapi.yaml
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1RisikoscoringDisclaimerResponse'
      x-evidence:
        kind: documentation
  /company/{orgnr}:
    get:
      operationId: get_company_orgnr
      tags:
      - Company
      summary: Get enriched company data
      x-source: https://apidocs.firmaradar.no/api/openapi.json
      parameters:
      - name: orgnr
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCompanyOrgnrResponse'
      x-evidence:
        kind: documentation
  /firmaradar-webhook:
    post:
      operationId: post_firmaradar_webhook
      tags:
      - Firmaradar Webhook
      summary: POST /firmaradar-webhook
      x-source: https://apidocs.firmaradar.no/agentisk-flyt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostFirmaradarWebhookRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST -H \"X-API-Key: $FIRMARADAR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{\n \"nace_code\": \"A\",\n \"\
          fylke_filter\": [\"03\"],\n \"aggregation_mode\": \"real_time\",\n \"url\": \"https://din-server.no/firmaradar-webhook\"\n }'  \"https://firmaradar.no/api/v1/nace/subscriptions\"\
          \ "
components:
  schemas:
    GetApiV1AmlReportReportidResponse:
      type: object
      properties:
        '200':
          type: string
          description: Report status and details when the report is ready or still processing.
        default:
          type: string
          description: Error response following the generic Error schema.
    PostApiV1NaceSubscriptionsRequest:
      type: object
      properties:
        nace_code:
          type: string
        fylke_filter:
          type: array
        aggregation_mode:
          type: string
        url:
          type: string
      required:
      - nace_code
      - url
    PatchApiV1NaceSubscriptionsSubscriptionidRequest:
      type: object
      properties:
        aktivert:
          type: boolean
    PostApiV1RisikoscoringConfirmDisclaimerRequest:
      type: object
      properties:
        version:
          type: string
          description: Must match the current disclaimer version.
        confirmation:
          type: string
          description: Exact full disclaimer text from the GET endpoint; it must match.
      required:
      - version
      - confirmation
    PostApiV1RisikoscoringConfirmDisclaimerResponse:
      type: object
      properties:
        confirmed:
          type: boolean
        version:
          type: string
        confirmed_at:
          type: string
    GetApiV1RisikoscoringDisclaimerResponse:
      type: object
      properties:
        status:
          type: string
        extension_id:
          type: string
        disclaimer_version:
          type: string
        disclaimer_text:
          type: string
          description: Full disclaimer text that must be shown and echoed at confirmation.
        disclaimer_text_hash:
          type: string
          description: SHA-256 of the disclaimer text, used as an audit reference.
        confirmed:
          type: boolean
          description: True if the company has already confirmed the current version.
    GetCompanyOrgnrResponse:
      type: object
      properties:
        '200':
          type: string
          description: Enriched company information following the Company schema.
        default:
          type: string
          description: Error response following the generic Error schema.
    PostFirmaradarWebhookRequest:
      type: object
      properties:
        nace_code:
          type: string
        fylke_filter:
          type: array
          items:
            type: string
        aggregation_mode:
          type: string
        url:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
security:
- apiKey: []
tags:
- name: Api
- name: Company
- name: Firmaradar Webhook