GET/v1/intakes/{id}

Récupérer un intake

Renvoie les détails d'un intake existant identifié par son id, sans exposer la publishable_key.

Réponse exemple

{
  "id": "int_4f2a9c1b",
  "name": "Dépôt KYC clients 2026",
  "object": "intake",
  "enabled": true,
  "created_at": "2026-06-11T14:23:00Z",
  "allowed_origins": [
    "https://cabinet.exemple.fr"
  ],
  "metadata_policy": "strip",
  "reference_required": true
}

Cet endpoint vous permet de récupérer la configuration complète d'un intake à partir de son identifiant. Vous l'utilisez pour vérifier l'état d'un point de dépôt, contrôler ses origines autorisées avant d'embarquer le widget sur un nouveau site, ou simplement afficher ses paramètres dans une interface d'administration interne. La <code>publishable_key</code> n'est <b>jamais</b> renvoyée par cet endpoint : elle n'apparaît qu'une seule fois, au moment de la création via <code>POST /v1/intakes</code>. Si vous l'avez perdue, vous devez créer un nouvel intake ou en régénérer une via les outils dédiés.

GET/v1/intakes/{id}Récupère un intake par son identifiant. Scope requis : intake_read.

Authentification

L'appel s'effectue depuis votre serveur avec une clé secrète préfixée <code>cof_live_</code>, <code>cof_test_</code> ou <code>cof_sandbox_</code>, transmise dans l'en-tête <code>Authorization</code> sous la forme <code>Bearer</code>. Le scope <code>intake_read</code> suffit ici puisqu'il s'agit d'une lecture. Ne déclenchez jamais cet endpoint depuis un navigateur : une clé serveur ne doit jamais transiter par du code côté client.

Paramètres

Le seul paramètre est l'identifiant de l'intake, passé dans le chemin d'URL. Aucun paramètre de requête n'est accepté.

Paramètre	Emplacement	Type	Obligatoire	Description
id	Path	string	Oui	Identifiant de l'intake à récupérer, préfixé in_.
Authorization	Header	string	Oui	Clé secrète sous la forme Bearer cof_live_...
Coffrify-Version	Header	string	Non	Version d'API ciblée. Par défaut : 2026-06-01.

Champs renvoyés

La réponse contient l'objet intake complet, à l'exception de la <code>publishable_key</code>. Vous y retrouvez la configuration courante (nom, slug, origines autorisées, politique sur les métadonnées, exigence de référence), son état d'activation et les horodatages de création et de mise à jour.

Champ	Type	Description
id	string	Identifiant unique de l'intake (in_...).
object	string	Toujours intake.
name	string	Nom interne lisible de l'intake.
slug	string	Slug public utilisé dans les URLs de dépôt.
allowed_origins	string[]	Origines navigateur autorisées à monter le widget.
metadata_policy	string	allow conserve les métadonnées en clair, strip les retire.
reference_required	boolean	Indique si une client_reference est exigée à chaque dépôt.
enabled	boolean	false si l'intake est désactivé et n'accepte plus de dépôts.
created_at	string	Date de création au format ISO 8601.
updated_at	string	Date de la dernière modification.

Codes de statut

Code	Signification	Cause typique
200	OK	L'intake a été trouvé et renvoyé.
401	Unauthorized	Clé manquante, invalide ou révoquée.
403	Forbidden	Clé valide mais sans le scope intake_read.
404	Not Found	Aucun intake ne correspond à cet id pour le compte appelant.
429	Too Many Requests	Limite de requêtes atteinte, consultez Retry-After.
500	Internal Server Error	Erreur interne, le request_id permet de nous solliciter.

Exemple de requête

Voici un appel minimal vers l'endpoint. Remplacez <code>in_8fK3jH9aZpQw</code> par l'identifiant de votre intake et utilisez votre propre clé secrète. En environnement de test, préférez une clé <code>cof_test_</code> qui pointe vers des données isolées de la production.

curl https://api.coffrify.com/v1/intakes/in_8fK3jH9aZpQw \
  -H "Authorization: Bearer $COFFRIFY_API_KEY" \
  -H "Coffrify-Version: 2026-06-01"

Exemple de réponse

Un appel réussi renvoie un statut 200 et le corps JSON suivant. Notez l'absence de la <code>publishable_key</code> : seuls les champs de configuration et d'état sont exposés.

{
  "id": "in_8fK3jH9aZpQw",
  "object": "intake",
  "name": "Dépôts dossiers clients",
  "slug": "depots-dossiers-clients",
  "allowed_origins": [
    "https://etude-martin.fr",
    "https://espace.etude-martin.fr"
  ],
  "metadata_policy": "allow",
  "reference_required": true,
  "enabled": true,
  "created_at": "2026-05-14T09:21:08Z",
  "updated_at": "2026-06-02T16:47:33Z"
}

Erreurs

Toutes les erreurs renvoient un corps JSON contenant un <code>code</code> machine, un <code>message</code> humain et un <code>request_id</code> à nous communiquer en cas de besoin. La forme la plus courante est le 404 lorsque l'identifiant est mal recopié.

{
  "error": {
    "code": "intake_not_found",
    "message": "Aucun intake ne correspond à l'identifiant in_8fK3jH9aZpQw.",
    "request_id": "req_01HZX9YT2PQ4M6N7VC8K3R0BFA"
  }
}