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

# Synthèse RCCI

> Agrège les covenants en tension, les documents manquants et les opérations à risque de l'entité.

**Scope requis :** `portfolio:read`. [Scopes et délégation](/scopes-and-delegation).



## OpenAPI

````yaml /openapi.json get /rcci/summary
openapi: 3.1.0
info:
  title: MARKO External Partner API
  version: v1
  description: >-
    Stable external API contract for the live environment.


    Authentication flow for partner integrations:

    1. Generate an API key from the MARKO entity admin API section.

    2. Keep the raw API secret server-side and use it only to sign `POST
    /v1/auth/token`.

    3. Build the canonical message
    `MARKO-EXTERNAL-API-TOKEN-V1\n{key_id}\n{timestamp}\n{nonce}`.

    4. Sign that message with HMAC-SHA256 and send the hex signature with
    `key_id`, `timestamp` and `nonce`.

    5. Use the returned short-lived bearer on business endpoints as
    `Authorization: Bearer <access_token>`.

    The raw API secret must never be sent on business endpoints.


    This public contract intentionally excludes beta endpoints.


    Référence enrichie pour les développeurs et les assistants IA. Exemples
    synthétiques; les champs sont extraits des modèles et sérialiseurs de la
    version indiquée dans x-documentation-provenance.
servers:
  - url: https://partner-api.marko.fr/v1
security:
  - BearerAuth: []
tags:
  - name: auth
    x-group: Authentification
  - name: entity
    x-group: Entité
  - name: portfolio
    x-group: Portefeuille
  - name: deals
    x-group: Deals
  - name: fonds
    x-group: Fonds
  - name: spvs
    x-group: SPV
  - name: operations
    x-group: Opérations
  - name: taxonomies
    x-group: Taxonomies
  - name: import-jobs
    x-group: Imports par lot
  - name: comments
    x-group: Commentaires
  - name: documents
    x-group: Documents
  - name: users
    x-group: Utilisateurs
  - name: settings
    x-group: Paramètres
  - name: rcci
    x-group: Conformité RCCI
  - name: field-definitions
    x-group: Champs métier
  - name: search
    x-group: Recherche
  - name: operateurs
    x-group: Opérateurs
  - name: alerts
    x-group: Alertes
  - name: notifications
    x-group: Notifications
  - name: calendar
    x-group: Calendrier
  - name: enrichment
    x-group: Enrichissement SIREN
  - name: reports
    x-group: Exports
  - name: reporting
    x-group: Templates de reporting
  - name: workflows
    x-group: Workflows et extraction IA
  - name: tasks
    x-group: Tâches
externalDocs:
  description: Download the matching Postman collection.
  url: /v1/postman.json
paths:
  /rcci/summary:
    get:
      tags:
        - rcci
      summary: Synthèse RCCI
      description: >-
        Agrège les covenants en tension, les documents manquants et les
        opérations à risque de l'entité.


        **Scope requis :** `portfolio:read`. [Scopes et
        délégation](/scopes-and-delegation).
      operationId: rcci_summary
      parameters:
        - in: query
          name: risk_threshold
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 0
            description: Seuil de score de risque
            default: 40
            title: Risk Threshold
          example: 40
          description: Seuil de score de risque
        - in: header
          name: X-Request-ID
          required: false
          description: >-
            Partner-generated correlation identifier echoed in logs and error
            payloads.
          schema:
            type: string
          example: marko-rcci-summary
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RCCISummaryResponse'
              example:
                covenants_breach_count: 2
                covenants_warning_count: 3
                documents_missing_count: 4
                operations_at_risk_count: 1
                covenants: []
                documents: []
                risk_operations: []
        '401':
          description: Authentication required
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: A valid bearer token is required.
                request_id: req_example_partner_call
        '403':
          description: Scope, route or IP restriction
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The API key does not allow this operation.
                request_id: req_example_partner_call
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unprocessable Content
                status: 422
                detail: The request payload or parameters are invalid.
                request_id: req_example_partner_call
        '429':
          description: Rate limit or progressive ban
          headers:
            Retry-After:
              description: Cooldown in seconds before retrying the request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request rate limit was exceeded.
                request_id: req_example_partner_call
        '500':
          description: Unexpected server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Internal Server Error
                status: 500
                detail: An unexpected server error occurred.
                request_id: req_example_partner_call
      deprecated: false
      security:
        - BearerAuth: []
components:
  schemas:
    RCCISummaryResponse:
      properties:
        covenants_breach_count:
          type: integer
          title: Covenants Breach Count
          default: 0
          description: Nombre de covenants en dépassement de seuil.
        covenants_warning_count:
          type: integer
          title: Covenants Warning Count
          default: 0
          description: Nombre de covenants en zone d'avertissement.
        documents_missing_count:
          type: integer
          title: Documents Missing Count
          default: 0
          description: Nombre de pièces documentaires manquantes dans la synthèse RCCI.
        operations_at_risk_count:
          type: integer
          title: Operations At Risk Count
          default: 0
          description: Nombre d'opérations signalées à risque dans la synthèse RCCI.
        covenants:
          items:
            $ref: '#/components/schemas/RCCICovenantItem'
          type: array
          title: Covenants
          default: []
          description: Covenants à surveiller dans la synthèse RCCI.
        documents:
          items:
            $ref: '#/components/schemas/RCCIDocumentItem'
          type: array
          title: Documents
          default: []
          description: Pièces documentaires prises en compte dans la synthèse RCCI.
        risk_operations:
          items:
            $ref: '#/components/schemas/RCCIRiskItem'
          type: array
          title: Risk Operations
          default: []
          description: Opérations à risque incluses dans la synthèse RCCI.
      type: object
      title: RCCISummaryResponse
      description: Aggregated RCCI compliance dashboard response.
    ProblemDetails:
      type: object
      required:
        - title
        - status
        - detail
      properties:
        type:
          type: string
          default: about:blank
          description: >-
            URI identifiant le type de problème; about:blank lorsque seul le
            statut HTTP le caractérise.
        title:
          type: string
          description: Titre affiché pour l'événement ou le problème.
        status:
          type: integer
          description: Statut HTTP de la réponse d'erreur.
        detail:
          type: string
          description: Informations détaillées sur le problème ou le dossier.
        request_id:
          type: string
          description: Identifiant de corrélation pour le diagnostic de la requête.
        scope:
          type: string
          description: Scope concerné par le refus d'accès, lorsqu'il est renseigné.
        route_id:
          type: string
          description: Identifiant de la route concernée par le problème.
        reason_code:
          type: string
          description: >-
            Code structuré du motif de refus; préférable au texte du message
            pour le diagnostic.
    RCCICovenantItem:
      properties:
        operation_id:
          type: string
          format: uuid
          title: Operation Id
          description: UUID MARKO de l'opération.
        operation_name:
          type: string
          title: Operation Name
          description: Nom de l'opération concernée.
        covenant_id:
          type: string
          format: uuid
          title: Covenant Id
          description: Identifiant du covenant contrôlé.
        covenant_type:
          type: string
          title: Covenant Type
          description: Type d'engagement contractuel contrôlé.
        valeur_actuelle:
          anyOf:
            - type: number
            - type: 'null'
          title: Valeur Actuelle
          description: Valeur du dernier calcul du covenant.
        seuil_contractuel:
          anyOf:
            - type: number
            - type: 'null'
          title: Seuil Contractuel
          description: Seuil défini dans le contrat pour ce covenant.
        marge_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Marge Pct
          description: Marge calculée par rapport au seuil contractuel du covenant.
        severity:
          type: string
          title: Severity
          description: >-
            Niveau de gravité de l'événement, distinct de son statut de
            traitement.
        date_dernier_calcul:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Date Dernier Calcul
          description: Date du dernier calcul du covenant.
      type: object
      required:
        - operation_id
        - operation_name
        - covenant_id
        - covenant_type
        - severity
      title: RCCICovenantItem
      description: A covenant in breach or near-breach for the RCCI dashboard.
    RCCIDocumentItem:
      properties:
        operation_id:
          type: string
          format: uuid
          title: Operation Id
          description: UUID MARKO de l'opération.
        operation_name:
          type: string
          title: Operation Name
          description: Nom de l'opération concernée.
        document_type:
          type: string
          title: Document Type
          description: Type métier du document; distinct de son type MIME.
        status:
          type: string
          title: Status
          description: État de disponibilité ou de conformité de la pièce requise.
        deadline:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Deadline
          description: Date limite attendue pour la pièce documentaire.
      type: object
      required:
        - operation_id
        - operation_name
        - document_type
        - status
      title: RCCIDocumentItem
      description: A missing or overdue document for the RCCI dashboard.
    RCCIRiskItem:
      properties:
        operation_id:
          type: string
          format: uuid
          title: Operation Id
          description: UUID MARKO de l'opération.
        operation_name:
          type: string
          title: Operation Name
          description: Nom de l'opération concernée.
        risk_score:
          type: number
          title: Risk Score
          description: Score de risque calculé pour la ressource.
        risk_grade:
          anyOf:
            - type: string
            - type: 'null'
          title: Risk Grade
          description: Classe de risque attribuée à l'opération.
        risk_level:
          anyOf:
            - type: string
            - type: 'null'
          title: Risk Level
          description: Niveau de risque de l'opération.
        spv_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Spv Name
          description: Nom de la SPV associée à la ressource.
      type: object
      required:
        - operation_id
        - operation_name
        - risk_score
      title: RCCIRiskItem
      description: An operation with risk score below threshold.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: MARKO short-lived bearer
      description: >-
        Use the `access_token` returned by `POST /v1/auth/token`. Do not send
        the raw API secret on business endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.