Lister les documents reçus

Réponse exemple

{
  "data": [
    {
      "id": "sub_8c1e2d",
      "source": "widget",
      "status": "received",
      "metadata": {},
      "encrypted": true,
      "intake_id": "int_4f2a9c1b",
      "created_at": "2026-06-11T14:25:00Z",
      "files_count": 3,
      "client_reference": "dossier-2026-0042",
      "total_size_bytes": 524288
    }
  ],
  "limit": 25,
  "object": "list",
  "has_more": false,
  "next_cursor": null
}

Cet endpoint vous permet de récupérer la liste des dépôts reçus sur un intake donné, sous forme de page paginée par curseur. Vous obtenez uniquement les <b>métadonnées</b> des dépôts : Coffrify ne déchiffre jamais le contenu des fichiers et ne renvoie aucune donnée en clair issue du document. Utilisez cet endpoint pour afficher la file d'attente côté cabinet, déclencher un traitement automatique ou retrouver les dépôts associés à un dossier précis via le champ <code>client_reference</code>.

L'identifiant <code>{id}</code> dans l'URL correspond à un intake que vous avez créé au préalable. Vous pouvez utiliser cet endpoint indifféremment avec une clé live, test ou sandbox : chaque environnement retourne ses propres dépôts. Les résultats sont triés du plus récent au plus ancien (<code>created_at</code> décroissant).

Paramètres

Tous les paramètres ci-dessous se passent en <i>query string</i>. Aucun corps de requête n'est attendu. Le filtre <code>reference</code> est particulièrement utile pour retrouver tous les dépôts d'un dossier client à partir du numéro interne que vous lui avez assigné.

Champs renvoyés

Chaque entrée de <code>data</code> représente un dépôt unique reçu sur l'intake. Le champ <code>metadata</code> n'est rempli en clair que si la <code>metadata_policy</code> de l'intake vaut <code>allow</code> ; sinon il vaut <code>null</code>. Le champ <code>encrypted</code> indique toujours <code>true</code> pour les dépôts collectés via le widget ou l'API publique : le chiffrement de bout en bout est appliqué par défaut, la clé reste chez vous.

Codes de statut

Exemple de requête

Authentifiez la requête avec votre clé serveur (<code>cof_live_</code>, <code>cof_test_</code> ou <code>cof_sandbox_</code>). Les clés navigateur <code>cip_</code> ne peuvent pas appeler cet endpoint. L'en-tête <code>Idempotency-Key</code> n'est pas requis ici puisqu'il s'agit d'une lecture.

curl -G https://api.coffrify.com/v1/intakes/in_01HZX4Y2KQRS9V8B/documents \
  -H "Authorization: Bearer $COFFRIFY_API_KEY" \
  --data-urlencode "reference=DOSSIER-2026-0418" \
  --data-urlencode "status=received" \
  --data-urlencode "limit=20"

Exemple de réponse

La réponse suit l'enveloppe standard de pagination par curseur. Le champ <code>has_more</code> indique s'il reste des dépôts à charger ; le cas échéant, repassez le <code>next_cursor</code> dans le paramètre <code>cursor</code> de l'appel suivant. Notez que <code>metadata</code> contient ici des champs en clair parce que l'intake a été créé avec <code>metadata_policy: "allow"</code>.

{
  "object": "list",
  "data": [
    {
      "id": "doc_01HZX5C8N2PR7TQM",
      "intake_id": "in_01HZX4Y2KQRS9V8B",
      "client_reference": "DOSSIER-2026-0418",
      "metadata": {
        "deposant_label": "Acquereur",
        "canal": "site_cabinet"
      },
      "status": "received",
      "files_count": 3,
      "total_size_bytes": 4521308,
      "encrypted": true,
      "source": "widget",
      "created_at": "2026-06-11T08:42:17Z"
    },
    {
      "id": "doc_01HZX59FJ4KZ1ABC",
      "intake_id": "in_01HZX4Y2KQRS9V8B",
      "client_reference": "DOSSIER-2026-0418",
      "metadata": {
        "deposant_label": "Vendeur",
        "canal": "api"
      },
      "status": "received",
      "files_count": 1,
      "total_size_bytes": 1208734,
      "encrypted": true,
      "source": "api",
      "created_at": "2026-06-10T17:09:54Z"
    }
  ],
  "has_more": true,
  "next_cursor": "cur_01HZX59FJ4KZ1ABC"
}

Pagination

La pagination est purement curseur : il n'y a pas de numéro de page ni de compteur total. Pour parcourir l'ensemble des dépôts d'un intake, bouclez tant que <code>has_more</code> vaut <code>true</code> en réinjectant <code>next_cursor</code>. Les curseurs sont stables : un dépôt nouvellement reçu pendant votre parcours apparaîtra en tête lors d'une prochaine boucle, pas au milieu de la page courante.

Pour récupérer les blobs chiffrés et l'enveloppe de déchiffrement d'un dépôt précis, enchaînez avec un appel à <code>GET /v1/intakes/{id}/documents/{docId}</code>. Le déchiffrement a lieu côté client par le détenteur de la clé privée : Coffrify n'y a pas accès, même momentané.