Créer un intake

Requête exemple

{
  "name": "Dépôt KYC clients 2026",
  "allowed_origins": [
    "https://cabinet.exemple.fr"
  ],
  "metadata_policy": "strip",
  "reference_required": true
}

Réponse exemple

{
  "id": "int_4f2a9c1b",
  "name": "Dépôt KYC clients 2026",
  "object": "intake",
  "enabled": true,
  "warning": "Cette clé ne sera plus jamais affichée. Copiez-la maintenant.",
  "created_at": "2026-06-11T14:23:00Z",
  "allowed_origins": [
    "https://cabinet.exemple.fr"
  ],
  "metadata_policy": "strip",
  "publishable_key": "cip_live_a1b2c3d4e5f6...",
  "reference_required": true
}

Cet endpoint crée un <b>intake</b>, le point d'entrée d'une drop box sécurisée que vos clients utiliseront pour vous transmettre des fichiers chiffrés de bout en bout. Vous recevez en retour l'objet intake complet et, pour la première et unique fois, une <b>publishable_key</b> (préfixe <code>cip_</code>) à intégrer dans votre site ou votre application. Cette clé publique sert à initialiser le widget de dépôt côté navigateur, sans jamais exposer votre clé secrète serveur.

Authentification et scope

Cet endpoint requiert une clé secrète serveur (<code>cof_live_</code>, <code>cof_test_</code> ou <code>cof_sandbox_</code>) transmise via l'en-tête <code>Authorization: Bearer</code>. Le scope <code>intake_write</code> doit être attribué à la clé. Nous recommandons fortement de transmettre un en-tête <code>Idempotency-Key</code> (8 à 255 caractères) pour rendre la création rejouable sans risque de doublon en cas de coupure réseau.

Paramètres du corps

Seul le champ <code>name</code> est obligatoire. Les autres paramètres affinent le comportement du widget, la politique de métadonnées et les origines autorisées à monter le formulaire.

Exemple de requête

L'exemple ci-dessous crée un intake nommé « Dépôt clients » restreint au domaine du cabinet, avec une référence de dossier obligatoire et une politique de métadonnées stricte.

curl -X POST https://api.coffrify.com/v1/intakes \
  -H "Authorization: Bearer cof_live_VotreCleSecreteServeur" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: intake-cabinet-martin-2026-06" \
  -d '{
    "name": "Dépôt clients",
    "slug": "depot-clients",
    "allowed_origins": ["https://cabinet-martin.fr"],
    "metadata_policy": "strip",
    "reference_required": true
  }'

Exemple de réponse

La réponse contient l'objet intake et le champ <code>publishable_key</code>. Stockez cette clé dans un coffre, elle ne sera jamais réaffichée par l'API.

{
  "id": "intk_01HXYZ8K9M4N2P7QRSTUVWXYZ",
  "object": "intake",
  "name": "Dépôt clients",
  "slug": "depot-clients",
  "allowed_origins": ["https://cabinet-martin.fr"],
  "metadata_policy": "strip",
  "reference_required": true,
  "enabled": true,
  "encrypted": true,
  "created_at": "2026-06-11T09:42:17Z",
  "publishable_key": "cip_live_8fQ2vR7nL3kY1xWmH5jB6cD4aZ"
}

Codes de statut

Exemple d'erreur 422

Toutes les erreurs suivent la même structure JSON, avec un <code>code</code> machine, un <code>message</code> lisible et un <code>request_id</code> à fournir au support en cas de besoin.

{
  "error": {
    "code": "validation_error",
    "message": "Le champ 'metadata_policy' doit valoir 'allow' ou 'strip'.",
    "request_id": "req_01HXYZ9P3R8T6V2WXY4Z5ABCDE"
  }
}

Étapes suivantes

Une fois l'intake créé, deux chemins s'offrent à vous. En no-code, ajoutez la balise script Coffrify à votre site et appelez <code>Coffrify.mountIntake</code> avec la <code>publishable_key</code>. En headless, instanciez <code>new Coffrify.Intake({ publishableKey })</code> côté navigateur puis appelez <code>intake.upload(files, options)</code> pour piloter le dépôt depuis votre propre interface. Côté serveur, listez les dépôts via <code>GET /v1/intakes/{id}/documents</code>.