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

# Suivre un lot

> Statut du lot, compteurs, et le détail document par document.



## OpenAPI

````yaml /openapi.json get /api/v1/batches/{id}
openapi: 3.1.0
info:
  title: API Resocom
  version: 1.0.0
  description: >-
    Créer des vérifications d'identité, analyser directement les documents que
    vous détenez déjà, et relire les résultats depuis votre système
    d'information.
servers:
  - url: https://pro.resocom.com
security:
  - cleApi: []
paths:
  /api/v1/batches/{id}:
    get:
      summary: Suivre un lot
      description: Statut du lot, compteurs, et le détail document par document.
      operationId: detailLot
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Le lot et ses documents.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Lot'
                  - type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/DocumentDeLot'
        '404':
          description: Lot inconnu — ou d'une autre entreprise (indistinct).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erreur'
components:
  schemas:
    Lot:
      type: object
      description: Lot d'analyses différées.
      properties:
        id:
          type: string
          example: BAT-1CBEA150-E475
        status:
          type: string
          enum:
            - open
            - in_progress
            - ended
            - canceled
          description: >-
            open : en cours de remplissage · in_progress : clôturé, en
            traitement · ended : terminé · canceled : annulé.
        externalRef:
          type:
            - string
            - 'null'
          description: Votre référence de lot.
        counts:
          type: object
          description: Compteurs par état de document.
          properties:
            total:
              type: integer
            pending:
              type: integer
              description: En attente ou en cours.
            succeeded:
              type: integer
              description: Analysés — les seuls actes comptés.
            errored:
              type: integer
            canceled:
              type: integer
            expired:
              type: integer
        submittedAt:
          type:
            - string
            - 'null'
          format: date-time
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Fin de la fenêtre de complétion : les résultats sont rendus avant
            cette date.
        endedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    DocumentDeLot:
      type: object
      description: Document d'un lot et son état.
      properties:
        id:
          type: string
          example: BTI-9090CF63-EB38
        position:
          type: integer
          description: Ordre de dépôt (1..n).
        documentCategory:
          type: string
          enum:
            - identite
            - administratif
        externalRef:
          type:
            - string
            - 'null'
          description: Votre référence de dossier.
        status:
          type: string
          enum:
            - pending
            - processing
            - succeeded
            - errored
            - canceled
            - expired
          description: Seuls les documents `succeeded` sont des actes comptés.
        consultationId:
          type:
            - string
            - 'null'
          description: Résultat à relire sur /api/v1/consultations/{id} quand `succeeded`.
        error:
          type:
            - string
            - 'null'
          description: Code d'erreur machine quand `errored`.
    Erreur:
      type: object
      properties:
        error:
          type: string
          description: Code d'erreur machine.
          example: invalid_api_key
  securitySchemes:
    cleApi:
      type: http
      scheme: bearer
      bearerFormat: rsk_live_…
      description: >-
        Clé API créée dans Administration → Entreprise → Clés API (licence
        Groupe).

````