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

# Créer ou mettre à jour une vente

> Crée ou met à jour une vente (estimation / mandat vendeur) avec déduplication automatique du contact et de la transaction.

Déduplication : recherche d'un contact existant par téléphone ou email dans le groupe d'agences (mise à jour si trouvé, création sinon), puis recherche d'une vente active à la même adresse pour ce contact. Allocation automatique d'un utilisateur / agence selon les règles configurées (forçable via `settings.allocation`). Étape calculée automatiquement selon le projet (forçable via `settings.step` sur une nouvelle vente ; sur une vente retrouvée, l'étape ne change pas).

`appointment` est disponible pour les ventes et les locations, et crée une activité « meeting » liée à la transaction, sans renseigner les dates d'estimation de la fiche. Avec `settings.step: RDV` dans la même requête, la vente est créée à l'étape RDV avec son rendez-vous à venir. `note` crée une activité « note ». En cas d'erreur sur ces créations, la transaction est quand même créée. `parsingCustomId` est enregistré et renvoyé en lecture ; il ne sert pas à la déduplication.

`settings.allocation.agencyGroupId` doit être le groupe de votre clé, et `agencyId`, s'il est fourni, une agence de GET Agencies. Sinon `400`, aucun lead créé (`LeadGenerationExternalSale : Agency group is not in the authorized scope of this LinkedAPI`, `LeadGenerationExternalSale : Agency is not in the authorized scope of this LinkedAPI`). Sans `agencyId`, l'attribution est automatique, parmi les agences du groupe. Les identifiants de l'exemple sont ceux de l'exemple de GET Agencies : remplacez-les par ceux que GET Agencies renvoie pour votre clé, et `userId` par un collaborateur de cette agence (GET Users liste ceux du groupe).



## OpenAPI

````yaml /openapi.yaml post /external-integration/sale
openapi: 3.1.0
info:
  title: Avest External Integration API
  version: 1.0.0
  description: >-
    API d'intégration externe Avest. Permet de rechercher des contacts et des
    collaborateurs, de récupérer des transactions (ventes, acquisitions,
    locations) et de créer/mettre à jour des transactions avec déduplication
    automatique.


    Tous les endpoints requièrent un token LinkedAPI (scope
    `externalIntegration`) dont la clé doit avoir un `agencyGroup` configuré.
    Les données sont strictement limitées au périmètre autorisé du token :
    aucune fiche hors `agencyGroup` n'est jamais retournée.
servers:
  - url: https://api.avest.fr/v1
    description: API de production Avest
security:
  - linkedApiToken: []
tags:
  - name: Contacts
    description: Recherche et récupération de contacts.
  - name: Users
    description: Récupération des collaborateurs (annuaire).
  - name: Transactions
    description: Récupération et recherche de ventes, acquisitions et locations.
  - name: Lead generation
    description: Création / mise à jour de transactions (ventes, acquisitions, locations).
  - name: Matches
    description: Récupération et recherche de rapprochements (matches vente / acquisition).
  - name: Activities
    description: Récupération et création des activités liées à un document.
  - name: Ads
    description: Récupération et recherche d'annonces (listings publiques).
  - name: Key
    description: Type de la clé API et méthodes qu'elle autorise.
  - name: Agencies
    description: Découverte des agences accessibles par la clé.
  - name: Shift planning
    description: >-
      Planning de permanence d'une agence, semaine par semaine. Écriture
      réservée aux clés autorisées en écriture.
paths:
  /external-integration/sale:
    post:
      tags:
        - Lead generation
      summary: Créer ou mettre à jour une vente
      description: >-
        Crée ou met à jour une vente (estimation / mandat vendeur) avec
        déduplication automatique du contact et de la transaction.


        Déduplication : recherche d'un contact existant par téléphone ou email
        dans le groupe d'agences (mise à jour si trouvé, création sinon), puis
        recherche d'une vente active à la même adresse pour ce contact.
        Allocation automatique d'un utilisateur / agence selon les règles
        configurées (forçable via `settings.allocation`). Étape calculée
        automatiquement selon le projet (forçable via `settings.step` sur une
        nouvelle vente ; sur une vente retrouvée, l'étape ne change pas).


        `appointment` est disponible pour les ventes et les locations, et crée
        une activité « meeting » liée à la transaction, sans renseigner les
        dates d'estimation de la fiche. Avec `settings.step: RDV` dans la même
        requête, la vente est créée à l'étape RDV avec son rendez-vous à venir.
        `note` crée une activité « note ». En cas d'erreur sur ces créations, la
        transaction est quand même créée. `parsingCustomId` est enregistré et
        renvoyé en lecture ; il ne sert pas à la déduplication.


        `settings.allocation.agencyGroupId` doit être le groupe de votre clé, et
        `agencyId`, s'il est fourni, une agence de GET Agencies. Sinon `400`,
        aucun lead créé (`LeadGenerationExternalSale : Agency group is not in
        the authorized scope of this LinkedAPI`, `LeadGenerationExternalSale :
        Agency is not in the authorized scope of this LinkedAPI`). Sans
        `agencyId`, l'attribution est automatique, parmi les agences du groupe.
        Les identifiants de l'exemple sont ceux de l'exemple de GET Agencies :
        remplacez-les par ceux que GET Agencies renvoie pour votre clé, et
        `userId` par un collaborateur de cette agence (GET Users liste ceux du
        groupe).
      operationId: postSale
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSaleBody'
            example:
              settings:
                allocation:
                  agencyGroupId: 66cc8a8e75c9fac35c6ecd73
                  agencyId: 66cc91d475c9fac35c86ed80
                  userId: 66cc91f05f84c9b212d9ec24
                  disableDeduplication: false
                step: QUL
              appointment:
                date: '2025-01-20T00:00:00.000Z'
                startAt: '2025-01-20T10:00:00.000Z'
                endAt: '2025-01-20T11:00:00.000Z'
                note: Rendez-vous estimation
              note:
                title: Rappel client
                content: Client très intéressé
              transactionType: sale
              contact:
                firstName: Jean
                lastName: Dupont
                email: jean.dupont@email.com
                phone: '+33612345678'
              address: 11 rue de Paris, 75001 Paris, France
              transaction:
                project: B
                property:
                  mainType: apartment
                  size: 85
                  rooms: 4
                  bedrooms: 3
                  hasElevator: true
                  floor: 3
                  DPEEnergyTag: D
                  DPEGESTag: C
                fieldValue:
                  low: 220000
                  high: 260000
                mandate:
                  sellPrice: 250000
                  agencyCommission: 12500
                  feeResponsibility: buyer
                  type: exclusive
                parsingCustomId: EXT-2025-001
      responses:
        '200':
          description: >-
            Vente créée ou mise à jour. Peut aussi retourner `{ success: true,
            message: "BILLING_STANDBY" }` lorsque le compte est en standby de
            facturation.
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTransactionResponse'
              examples:
                cree:
                  summary: Vente créée
                  value:
                    success: true
                    avestId: V-2025-001
                    user:
                      id: 66cc91f05f84c9b212d9ec24
                      firstName: Marie
                      lastName: Martin
                      jobTitle: Agent immobilier
                      email: marie.martin@agence.com
                      phone: '+33601020304'
                    contact:
                      id: 618a35a36d932054e195ca0a
                      firstName: Jean
                      lastName: Dupont
                    transaction:
                      id: 619b46b47e043165f206db1b
                      customId: V-2025-001
                      step: QUL
                      project: B
                      property:
                        addressData:
                          streetNumber: '11'
                          route: Rue de Paris
                          postalCode: '75001'
                          city: Paris
                          country: France
                          countryCode: FR
                          formattedAddress: 11 Rue de Paris, 75001 Paris, France
                        addresses:
                          - streetNumber: '11'
                            route: Rue de Paris
                            postalCode: '75001'
                            city: Paris
                            country: France
                            countryCode: FR
                            formattedAddress: 11 Rue de Paris, 75001 Paris, France
                billingStandby:
                  summary: Standby de facturation
                  value:
                    success: true
                    message: BILLING_STANDBY
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    PostSaleBody:
      type: object
      required:
        - settings
        - transactionType
        - address
        - transaction
      properties:
        settings:
          $ref: '#/components/schemas/SettingsBase'
        appointment:
          allOf:
            - $ref: '#/components/schemas/Appointment'
          description: >-
            Crée un RDV (titre auto « Rendez-vous estimation »), sans renseigner
            les dates d'estimation de la fiche. Avec `settings.step: RDV`, la
            vente est créée à l'étape RDV avec ce rendez-vous à venir.
        note:
          $ref: '#/components/schemas/Note'
        transactionType:
          type: string
          const: sale
        contact:
          $ref: '#/components/schemas/ContactInput'
        address:
          type: string
          description: >-
            Adresse complète du bien (ex: "11 rue de Paris, 75001 Paris,
            France"), située par Google. Si Google ne situe que la ville, la
            vente est enregistrée sans numéro ni rue et la réponse reste un
            succès : contrôlez `transaction.property.addressData` dans la
            réponse, ou `property.addressData` avec GET Sale.
        transaction:
          $ref: '#/components/schemas/TransactionSale'
    PostTransactionResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        avestId:
          type: string
          description: Identifiant métier de la transaction créée / mise à jour.
        user:
          $ref: '#/components/schemas/PostUserSummary'
        contact:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/ObjectId'
            firstName:
              type: string
            lastName:
              type: string
        transaction:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/ObjectId'
            customId:
              type: string
            step:
              type: string
            project:
              type: string
            property:
              type: object
              description: >-
                Pour une vente ou une location, porte l'adresse reconnue et
                enregistrée, au format de GET Sale et GET Rental : comparez-la à
                l'`address` envoyée pour repérer une adresse mal reconnue. Elle
                n'est pas renvoyée si la fiche est attribuée à une agence que
                votre clé ne couvre pas, comme sur GET.
              properties:
                addressData:
                  $ref: '#/components/schemas/AddressData'
                addresses:
                  type: array
                  items:
                    $ref: '#/components/schemas/AddressData'
        message:
          type: string
          description: >-
            Présent lorsque le compte est en standby de facturation
            (`BILLING_STANDBY`).
    SettingsBase:
      type: object
      required:
        - allocation
      properties:
        allocation:
          $ref: '#/components/schemas/Allocation'
        step:
          type: string
          description: Force l'étape (sinon calculée automatiquement).
        disableAlerts:
          type: boolean
          default: false
          description: >-
            Si `true`, l'email d'alerte nouveau lead n'est pas envoyé. Seul cet
            email est coupé : la notification Slack de l'agence part quand même.
    Appointment:
      type: object
      required:
        - date
      properties:
        date:
          type: string
          description: Date ISO du RDV (ne peut pas être dans le passé).
        startAt:
          type: string
          description: Heure de début (ISO 8601).
        endAt:
          type: string
          description: Heure de fin (ISO 8601).
        note:
          type: string
    Note:
      type: object
      required:
        - title
      properties:
        title:
          type: string
        content:
          type: string
    ContactInput:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        isEmailVerified:
          type: boolean
        phone:
          type: string
          description: Téléphone au format international.
        isPhoneVerified:
          type: boolean
    TransactionSale:
      type: object
      required:
        - property
      properties:
        project:
          type: string
          description: >-
            Type de projet : `B` (acheteur), `B&S`, `S&B`, `O!S`, `S|L`, `S|O`,
            `S|S`, `APT` (demande de rendez-vous).
        parsingCustomId:
          type: string
          description: >-
            Votre identifiant externe, enregistré tel quel. Ne sert pas à la
            déduplication.
        property:
          $ref: '#/components/schemas/PropertyInput'
        fieldValue:
          $ref: '#/components/schemas/Range'
        onlineValue:
          $ref: '#/components/schemas/Range'
        mandate:
          $ref: '#/components/schemas/SaleMandateInput'
        offer:
          $ref: '#/components/schemas/SaleOfferInput'
        timeline:
          $ref: '#/components/schemas/SaleTimelineInput'
    PostUserSummary:
      type: object
      description: Utilisateur alloué à la transaction.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        firstName:
          type: string
        lastName:
          type: string
        jobTitle:
          type: string
        email:
          type: string
        phone:
          type: string
    ObjectId:
      type: string
      description: Identifiant Mongo (24 caractères hexadécimaux).
      pattern: ^[a-fA-F0-9]{24}$
      example: 618a35a36d932054e195ca0a
    AddressData:
      type: object
      description: Adresse splittée.
      properties:
        streetNumber:
          type: string
        route:
          type: string
        city:
          type: string
        postalCode:
          type: string
        country:
          type: string
        countryCode:
          type: string
          description: Code pays ISO 3166-1 alpha-2.
        formattedAddress:
          type: string
        department:
          type: string
        region:
          type: string
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        errorCode:
          type: string
          description: >-
            Code stable, présent sur certaines erreurs seulement (par exemple
            `VISIT_DATE_REQUIRED`, `CONTACT_DELETED`). À préférer à `message`
            pour reconnaître une erreur.
        message:
          type: string
    RateLimitErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
          example: Rate limit exceeded
        retryAfter:
          type: integer
          description: Secondes avant de pouvoir réessayer.
    Allocation:
      type: object
      required:
        - agencyGroupId
      properties:
        agencyGroupId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: >-
            Groupe d'agences de votre clé (`agencyGroup.id` de GET Agencies). Un
            autre groupe est refusé (`400`).
        agencyId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: >-
            Agence à qui attribuer le lead (force l'allocation). Doit être une
            agence de GET Agencies : une agence que votre clé ne couvre pas, ou
            désactivée, est refusée (`400`). Sans `agencyId`, l'attribution est
            automatique, parmi les agences du groupe.
        userId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: ID de l'utilisateur (force l'allocation, requiert `agencyId`).
        disableDeduplication:
          type: boolean
          default: false
          description: Désactive la déduplication de transaction.
    PropertyInput:
      type: object
      description: >-
        Bien immobilier (entrée). Tous les champs sont optionnels. Champs
        communs sale / rental.
      properties:
        mainType:
          type: string
          enum:
            - house
            - apartment
            - building
            - field
            - parking
            - cellar
            - office
            - shop
            - industry
            - business_assets
            - lease_transfer
        developmentType:
          type: string
          enum:
            - old
            - new
        generalCondition:
          type: string
          enum:
            - toRenovate
            - standard
            - renovated
        size:
          type: number
        carrezSurface:
          type: number
        livingSurface:
          type: number
        usefulSurface:
          type: number
        floorSurface:
          type: number
        landSurface:
          type: number
        fieldSurface:
          type: number
        isSemiDetached:
          type: boolean
        lotsNumbers:
          type: string
        buildingYear:
          type: integer
        renovationYear:
          type: integer
        floor:
          type: integer
        totalFloors:
          type: integer
        lastFloor:
          type: integer
        isConstructible:
          type: boolean
        isServiced:
          type: boolean
        rooms:
          type: integer
        bedrooms:
          type: integer
        bathrooms:
          type: integer
        showerRooms:
          type: integer
        toilets:
          type: integer
        isToiletIndependent:
          type: boolean
        kitchenType:
          type: string
          enum:
            - open
            - independent
        isKitchenEquipped:
          type: boolean
        balconyAmount:
          type: integer
        balconySurface:
          type: number
        loggiaAmount:
          type: integer
          minimum: 0
          description: Nombre de loggias.
        loggiaSurface:
          type: number
          minimum: 0
          description: Surface des loggias, en m².
        terraceAmount:
          type: integer
        terraceSurface:
          type: number
        gardenAmount:
          type: integer
        gardenSurface:
          type: number
        cellarAmount:
          type: integer
        cellarSurface:
          type: number
        atticAmount:
          type: integer
        atticSurface:
          type: number
        parkingType:
          type: string
          enum:
            - outdoor
            - covered
            - garage
        parkingAmount:
          type: integer
        parkingSurface:
          type: number
        hasDisabledAccess:
          type: boolean
        hasElevator:
          type: boolean
        hasPool:
          type: boolean
        hasOpticalFiber:
          type: boolean
        hasFireplace:
          type: boolean
        hasStove:
          type: boolean
        hasArmoredDoor:
          type: boolean
        hasVMC:
          type: boolean
        propertyTax:
          type: number
        propertyTaxResponsibility:
          type: string
          enum:
            - owner
            - tenant
          description: >-
            Taxe foncière à la charge du bailleur (`owner`) ou du preneur
            (`tenant`). Bien professionnel.
        vatRegime:
          type: string
          enum:
            - subject
            - exempt
          description: Bien professionnel soumis (`subject`) ou non (`exempt`) à la TVA.
        isCollectiveOwnership:
          type: boolean
        collectiveMonthlyCost:
          type: number
        numberOfLots:
          type: integer
        isProcedure:
          type: boolean
        hasBuildingManager:
          type: boolean
        managedResidenceType:
          type: string
        heatingType:
          type: string
          enum:
            - individual
            - community
        heatingEnergyType:
          type: string
          enum:
            - electric
            - gas
            - fuel
            - heat_pump
            - wood
            - pellets
            - air_conditioning
            - district_heating
            - solar
            - geothermal
            - other
        waterDistributionType:
          type: string
          enum:
            - collective
            - individual_electric
            - individual_gas
            - individual_fuel
            - individual_solar
            - individual_heat_pump
            - individual_wood
            - individual_other
        isAirConditioning:
          type: boolean
        glazingType:
          type: string
          enum:
            - simple
            - double
            - triple
        DPENumber:
          type: string
        DPEEnergyValue:
          type: number
        DPEEnergyTag:
          $ref: '#/components/schemas/DPETag'
        DPEGESValue:
          type: number
        DPEGESTag:
          $ref: '#/components/schemas/DPETag'
        DPEDate:
          type: string
        DPEDate3Years:
          type: array
          items:
            type: integer
        minimumEnergyCost:
          type: number
        maximumEnergyCost:
          type: number
        energyCostDate:
          type: string
        hasBeautifulView:
          type: boolean
        availabilityDate:
          type: string
        hasRoofTop:
          type: boolean
        isDuplex:
          type: boolean
        occupancyStatus:
          type: string
          enum:
            - free
            - rented
        sanitationType:
          type: string
          enum:
            - mainsDrainage
            - septicTankCompliant
            - septicTankNonCompliant
        isPoolBuildable:
          type: boolean
        roomDetails:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    Range:
      type: object
      description: Fourchette de valeurs.
      properties:
        low:
          type: number
        high:
          type: number
    SaleMandateInput:
      type: object
      description: >-
        Montants en euros. `sellPrice` est le net vendeur. Le prix affiché
        honoraires inclus (`price`) est calculé : net vendeur + honoraires. Pour
        saisir les honoraires en pourcentage, envoyez `commissionType:
        percentage` et `commissionPercentage` : le montant des honoraires est
        alors calculé.
      properties:
        sellPrice:
          type: number
          description: >-
            Net vendeur, en euros. N'envoyez pas le prix honoraires inclus :
            `price` est calculé et n'est pas modifiable.
        agencyCommission:
          type: number
          description: >-
            Montant des honoraires, en euros (`12500` pour 12 500 €). En mode
            `percentage`, il est recalculé à partir de `commissionPercentage`.
        commissionType:
          type: string
          enum:
            - value
            - percentage
          description: >-
            `value` : vous envoyez le montant (`agencyCommission`). `percentage`
            : vous envoyez le pourcentage (`commissionPercentage`). Sans
            `commissionType`, `agencyCommission` est lu comme un montant.
        commissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Pourcentage d'honoraires, lu quand `commissionType` vaut
            `percentage`. Sa base dépend de `feeResponsibility` : à charge
            vendeur, le prix honoraires inclus ; à charge acquéreur, le net
            vendeur. Sur PATCH Sale, hors du mode `value`, une valeur hors de
            cette plage est refusée (`400`), sauf à renvoyer la valeur déjà
            enregistrée. En mode `value`, elle est ignorée : Avest la calcule
            depuis les montants.
        type:
          type: string
          enum:
            - exclusive
            - semiExclusive
            - notExclusive
        expirationDate:
          type: string
        mandateDuration:
          type: integer
        maxMandateDuration:
          type: integer
        referenceNumber:
          type: string
        feeResponsibility:
          type: string
          enum:
            - seller
            - buyer
            - both
        sellerAgencyCommission:
          type: number
          minimum: 0
          description: >-
            Part vendeur des honoraires, en charge `both` seulement. Négative,
            non numérique ou supérieure à `agencyCommission` : `400`.
        sellerAgencyCommissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Part vendeur en %, lue en mode `percentage`, en charge `both`
            seulement.
    SaleOfferInput:
      type: object
      description: >-
        Mêmes règles que le mandat : montants en euros, `sellPrice` net vendeur,
        honoraires en pourcentage avec `commissionType: percentage` (montants
        arrondis à l'euro, pourcentage inférieur à 100). L'offre n'est
        enregistrée que sur une vente à `MND` ou au-delà ; un changement d'étape
        vers une autre étape que `OFR`, `AGT`, `MTG` ou `SLD` l'efface.
      properties:
        sellPrice:
          type: number
          description: Net vendeur de l'offre, en euros.
        agencyCommission:
          type: number
          description: >-
            Montant des honoraires, en euros. En mode `percentage`, il est
            recalculé à partir de `commissionPercentage`.
        commissionType:
          type: string
          enum:
            - value
            - percentage
          description: >-
            `value` : vous envoyez le montant. `percentage` : vous envoyez le
            pourcentage (`commissionPercentage`).
        commissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Pourcentage d'honoraires, lu quand `commissionType` vaut
            `percentage`. Montants arrondis à l'euro.
        feeResponsibility:
          type: string
          enum:
            - seller
            - buyer
            - both
        sellerAgencyCommission:
          type: number
          minimum: 0
          description: >-
            Part vendeur des honoraires, en charge `both` seulement. Négative,
            non numérique ou supérieure à `agencyCommission` : `400`.
        sellerAgencyCommissionPercentage:
          type: number
          minimum: 0
          exclusiveMaximum: 100
          description: >-
            Part vendeur en %, lue en mode `percentage`, en charge `both`
            seulement.
        financing:
          type: string
          enum:
            - loan
            - cash
    SaleTimelineInput:
      type: object
      properties:
        estimationDate:
          type: string
        estimationStartAt:
          type: string
        estimationEndAt:
          type: string
        offerDate:
          type: string
        agreementDate:
          type: string
        mortgageDeadline:
          type: string
        closingDate:
          type: string
        mandateSignatureDate:
          type: string
        agreementExpirationDate:
          type: string
    DPETag:
      type: string
      enum:
        - A
        - B
        - C
        - D
        - E
        - F
        - G
  headers:
    RateLimit-Limit:
      description: Nombre de requêtes autorisées dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Remaining:
      description: Requêtes restantes dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Reset:
      description: Secondes avant la réinitialisation de la fenêtre.
      schema:
        type: integer
    Retry-After:
      description: Secondes à attendre avant de réessayer (présent sur les réponses `429`).
      schema:
        type: integer
  responses:
    BadRequest:
      description: >-
        Requête invalide. Le champ `message` précise la cause (paramètre
        manquant, invalide, mutuellement exclusif, clé de query inconnue,
        `LinkedAPI agencyGroup is required`, etc.).


        Les exemples ci-dessous sont **illustratifs et non exhaustifs** : les
        messages réellement renvoyés dépendent de la route. En particulier, le
        rejet des clés de query inconnues n'est appliqué que par `/contact`,
        `/contacts`, `/user`, `/users` et `/{transaction}/search`.


        La plupart des messages de validation sont préfixés par le contexte qui
        les émet, sous la forme `"<Contexte> : <message>"`. **Ne faites jamais
        de correspondance exacte sur `message`** : basez-vous sur le code HTTP
        et traitez `message` comme du texte destiné au diagnostic.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unParametreRequis:
              value:
                success: false
                message: One of phone, email, or search is required
            exclusif:
              value:
                success: false
                message: Provide exactly one of phone, email, or search
            queryInconnue:
              value:
                success: false
                message: 'Unsupported query parameter: foo'
            telephoneInvalide:
              value:
                success: false
                message: Invalid phone number
            emailInvalide:
              value:
                success: false
                message: Invalid email
            searchTropCourt:
              value:
                success: false
                message: search must be at least 3 characters
            pageHorsLimites:
              value:
                success: false
                message: page must be <= 100
            agencyGroupManquant:
              value:
                success: false
                message: LinkedAPI agencyGroup is required
    Unauthorized:
      description: >-
        Token invalide. Renvoyé quand le header `Authorization: Bearer` est
        présent mais que sa valeur n'est pas un token exploitable (malformé,
        signature invalide, valeur vide) — `message` vaut alors `Invalid bearer
        token`.


        Un token bien formé mais qui ne correspond plus à aucune clé (révoquée
        ou régénérée) donne aussi un `401`, avec le message `Not authorized to
        access this resource`.


        L'absence du header, une clé en lecture seule et une IP non autorisée
        renvoient un `403`, pas un `401`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            tokenInvalide:
              value:
                success: false
                message: Invalid bearer token
            cleInconnue:
              value:
                success: false
                message: Not authorized to access this resource
    Forbidden:
      description: >-
        Accès refusé. Trois causes donnent **exactement la même réponse** (même
        code, même `message`) :


        1. le header `Authorization` est absent ;

        2. la clé est en **lecture seule** et la requête est un `POST` ou un
        `PATCH` (voir le guide Authentification) ;

        3. la clé est en mode **sécurisé** et l'IP d'appel, lue dans
        `X-Real-IP`, n'est pas celle autorisée.


        Sur les routes d'écriture, un document lié hors du périmètre de la clé
        renvoie également ce `403`.


        Un `403` sur vos seules écritures alors que vos lectures passent = clé
        en lecture seule.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Not authorized to access this resource
    TooManyRequests:
      description: >-
        Limite de débit dépassée : limite de la route (par groupe d'agences et
        par chemin) ou limite globale (200 requêtes / 10 s par clé, `message`
        `Too many requests, please try again later`).
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
            retryAfter: 27
  securitySchemes:
    linkedApiToken:
      type: http
      scheme: bearer
      description: >-
        Token LinkedAPI avec scope `externalIntegration`. La clé doit avoir un
        `agencyGroup` configuré (sinon `400 LinkedAPI agencyGroup is required`).
        Fourni via l'en-tête `Authorization: Bearer {linkedAPI_token}`. Si la
        clé a `secure === true`, l'IP appelante doit être whitelistée (en-tête
        `X-Real-IP`), sinon `403 Not authorized to access this resource`.


        La clé porte aussi un **niveau d'accès** : en lecture seule, elle
        n'autorise que les `GET` ; un `POST` ou un `PATCH` renvoie alors `403
        Not authorized to access this resource`, soit la même réponse qu'une
        requête sans en-tête `Authorization`. Voir le guide Authentification.

````

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