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

# Get current integration organization and authorized partners.

> Returns the caller's `IntegrationOrganization` profile, the list of
`TradePartner` entities the caller is authorized to act on behalf of,
and the capability flags that gate feature access. Call once at client
startup.




## OpenAPI

````yaml /openapi-integration-v1.yaml get /me
openapi: 3.1.0
info:
  title: Novatrade24 Integration API
  version: 1.0.0-draft
  summary: Customer-facing integration API for the Novatrade24 compliance platform.
  description: >
    The Novatrade24 Integration API lets marketplaces, dealers, and financial

    partners embed EU VAT-compliant cross-border vehicle transactions into

    their own systems.


    The API is organized around the end-to-end compliance workflow:


    1. **Buyer (KYC)** — create or sync a buyer, run VIES, upload KYC documents,
       optionally trigger NT24-led verification.
    2. **Order** — register a VIN-based transaction linked to a buyer.

    3. **Invoice** — submit preliminary and final invoice data and documents.

    4. **Payment** — submit proof-of-payment and trigger pickup readiness.

    5. **Transport** — confirm pickup and delivery with CMR / declarations.

    6. **Compliance rollup** — poll workflow status or subscribe to webhooks.

    7. **Finalization** — download the generated Export File.


    **Status:** Draft — no production endpoint yet. Specification published for

    integration planning. Hosted mock available at
    `https://mock.api.novatrade24.com`.
  termsOfService: https://novatrade24.com/terms
  contact:
    name: Novatrade24 Integration Support
    email: integration-support@novatrade24.com
    url: https://developers.novatrade24.com
  license:
    name: Proprietary
    url: https://novatrade24.com/terms
servers:
  - url: https://api.novatrade24.com/v1
    description: Production (Phase 1 pilot — restricted access)
  - url: https://api.stage.novatrade24.com/v1
    description: Staging environment
  - url: https://mock.api.novatrade24.com
    description: Hosted mock server (Prism) — spec-driven stub responses
security:
  - oauth2ClientCredentials: []
tags:
  - name: Discovery
    description: Organization + capability discovery.
  - name: Buyers
    description: |
      Manage buyer (trade partner) records and KYC lifecycle.
      Buyers are upserted by `(sellerId, vatNumber)`.
  - name: KYC
    description: KYC documents, VIES checks, Mode B verification, profile.
  - name: Self-service invitations
    description: |
      Orchestrate buyer-facing self-service links for KYC submission
      and prospect onboarding.
  - name: Orders
    description: |
      Register vehicle transactions. Orders may contain one or more VINs;
      Phase 1 Santander pilot uses single-VIN orders.
  - name: Invoice
    description: Buyer's VAT-compliance invoice (preliminary or final).
  - name: Payment
    description: Proof-of-payment data and documents; pickup readiness trigger.
  - name: Transport
    description: Pickup + delivery milestones and documents (CMR, declarations).
  - name: Compliance
    description: End-to-end compliance rollup per order.
  - name: Finalization
    description: Final invoice submission and Export File download.
  - name: Prospects
    description: Public prospect submission flow.
  - name: Documents
    description: Typed document download.
  - name: Webhooks
    description: Webhook endpoint registration, delivery history, test-fire.
paths:
  /me:
    get:
      tags:
        - Discovery
      summary: Get current integration organization and authorized partners.
      description: |
        Returns the caller's `IntegrationOrganization` profile, the list of
        `TradePartner` entities the caller is authorized to act on behalf of,
        and the capability flags that gate feature access. Call once at client
        startup.
      operationId: getMe
      responses:
        '200':
          description: OK
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
              example:
                organizationUuid: 550e8400-e29b-41d4-a716-446655440000
                name: Santander Consumer Bank
                authorizedPartners:
                  - uuid: 11111111-2222-3333-4444-555555555555
                    name: AutoHandel Mustermann GmbH
                    country: DE
                capabilities:
                  rateLimitTier: HIGH_VOLUME
                  allowMarketplaceLedKyc: true
                  allowMultiVinOrders: false
                  allowContactPersonalData: true
                  allowKycDocumentDownload: true
                dpaVersion: 2026-01
                dpaAcceptedAt: '2026-02-15T10:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        4XX:
          $ref: '#/components/responses/Problem'
        5XX:
          $ref: '#/components/responses/Problem'
components:
  headers:
    XRequestId:
      description: Correlation ID. Echoed back if provided on request.
      schema:
        type: string
    XRateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    XRateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    XRateLimitReset:
      description: Unix timestamp when the current window resets.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying (on 429).
      schema:
        type: integer
  schemas:
    Me:
      type: object
      required:
        - organizationUuid
        - name
        - authorizedPartners
        - capabilities
      properties:
        organizationUuid:
          type: string
          format: uuid
        name:
          type: string
        authorizedPartners:
          type: array
          items:
            $ref: '#/components/schemas/PartnerSummary'
        capabilities:
          $ref: '#/components/schemas/Capabilities'
        dpaVersion:
          type: string
        dpaAcceptedAt:
          type: string
          format: date-time
    PartnerSummary:
      type: object
      required:
        - uuid
        - name
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        country:
          type: string
          example: DE
    Capabilities:
      type: object
      properties:
        rateLimitTier:
          type: string
          enum:
            - STANDARD
            - HIGH_VOLUME
            - ENTERPRISE
        allowMarketplaceLedKyc:
          type: boolean
        allowMultiVinOrders:
          type: boolean
        allowContactPersonalData:
          type: boolean
        allowKycDocumentDownload:
          type: boolean
    Problem:
      type: object
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        traceId:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid access token.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >
        Authenticated but not authorized (wrong partner scope, missing
        capability,

        or DPA not accepted).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    TooManyRequests:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    InternalServerError:
      description: Unexpected error.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Problem:
      description: |
        RFC 7807 problem detail. Default fallback for any status not explicitly
        enumerated on the operation. Concrete status is in `status` field.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      description: |
        OAuth 2.0 client_credentials grant via Keycloak service account.
        Clients are provisioned per `IntegrationOrganization` in the
        `nt24-idp` realm.
      flows:
        clientCredentials:
          tokenUrl: >-
            https://auth.novatrade24.com/realms/nt24-idp/protocol/openid-connect/token
          scopes: {}

````