Envoyez des fichiers depuis votre code.
Le même moteur que l’application : chaque fichier est analysé (logiciels malveillants, contenu) avant l’envoi, des liens à vos couleurs sur notre domaine et une preuve signée dans les deux sens.
L’API développeur est disponible à partir de l’offre Pro. Créez des clés dans votre compte : affichées une seule fois, elles ne sont conservées que sous forme d’empreinte. Portées : send, read, events. Jusqu’à 5 clés actives (10 dans un espace d’équipe) ; les clés créées depuis un espace d’équipe enverront au nom de l’équipe.
Mode test : un envoi effectué avec une clé ivst_test_ est adressé à l’e-mail de votre compte : vous le voyez réellement arriver dans votre boîte de réception, et personne d’autre ne peut être contacté. Les envois de test portent clairement la mention testMode. Une clé live (ivst_live_) envoie pour de vrai, aux destinataires que vous indiquez.
User-Agent : envoyez un en-tête User-Agent qui nomme votre application, par ex. User-Agent: YourApp/1.0. La plupart des clients HTTP en envoient déjà un (curl, Python, Node, Go, Java) ; le HttpClient de .NET ne le fait que si vous le définissez. Une requête sans cet en-tête peut être refusée avec 403.
Des envois, pas des imports
L’unité de base est l’envoi : fichiers + destinataires + protections, qui passe par draft → scanning → ready. Vous ne gérez jamais le stockage : vous décrivez un envoi et suivez son parcours.
Une clé, et un jeton par envoi
Votre clé d’API crée et lit des envois. Chaque nouvel envoi renvoie aussi un manageToken qui n’autorise qu’une seule chose : importer les fichiers de cet envoi. Le jeton que vous placez près de l’import ne peut donc toucher à rien d’autre. S’il fuite, vous perdez un envoi, jamais votre compte.
La garantie d’analyse
Entre finalize et ready, chaque fichier passe une analyse antimalware, et les médias passent des contrôles de contenu. Aucun scope, aucune offre ni aucun flag ne permet d’y échapper.
Mode test
Les clés ivst_test_ exécutent tout le pipeline (analyses, événements, certificat), mais n’envoient qu’à l’adresse e-mail de votre propre compte et ajoutent testMode à tout ce qu’elles touchent.
Événements et webhooks
Interrogez GET /v1/events avec un curseur, ou enregistrez un webhook et nous envoyons chaque événement à votre URL : signé, renvoyé en cas d’échec, désactivé automatiquement si votre point de terminaison reste hors service. Le même flux « exactement une fois » dans les deux cas : vous ne verrez jamais de delivery.sent en double.
Vous déclarez les tailles ; nous les vérifions
Indiquez la taille exacte de chaque fichier en octets lorsque vous créez un envoi. Elle détermine l’import et est décomptée de votre offre. Une fois le fichier arrivé, nous vérifions sa taille réelle : l’envoi affiche toujours les vrais chiffres, et un fichier qui dépasse la limite de votre offre est refusé et supprimé.
La preuve, un objet à part entière
Les expéditeurs peuvent obtenir un reçu signé indiquant qui a ouvert et téléchargé quoi ; chaque envoi génère un certificat que le destinataire peut vérifier. Les deux se vérifient hors ligne grâce à notre clé publiée.
Créer un envoi
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_test_..." \
-H "Content-Type: application/json" \
-d '{
"files": [{ "name": "final-cut.mp4", "size": 734003200 }],
"recipients": ["client@example.com"],
"message": "The final cut — enjoy."
}'{
"id": "d23583b7-05f1-4d7f-a6bd-a1e28af4e3b1",
"status": "draft",
"mode": "test",
"shortCode": "SSyNuWN",
"uploads": [{
"fileId": "a512b334-…",
"mode": "multipart", // or "single" under 100 MB, with a ready url
"uploadId": "…", "partSize": 16777216, "partCount": 44
}],
"manageToken": "b_mKzpcj…" // shown once — X-Transfer-Token from here on
}Donnez à chaque fichier un nom et sa taille exacte en octets : la taille détermine le mode d’import (un seul PUT sous 100 Mo, multipart au-delà). Elle est vérifiée par rapport à votre offre, puis rapprochée des octets réels lors de la finalisation. Avec une clé de test, vous pouvez omettre recipients entièrement : chaque envoi de test part vers l’e-mail de votre compte.
Importez les octets
# single mode (files under 100 MB): one PUT
curl -X PUT "<uploads[0].url>" \
-H "x-amz-content-sha256: UNSIGNED-PAYLOAD" \
--data-binary @final-cut.mp4
# multipart (larger): fetch part URLs in batches, PUT each part,
# then complete with the ETags
curl -X POST https://api.ivesentit.com/v1/transfers/<id>/files/<fileId>/parts \
-H "X-Transfer-Token: <manageToken>" \
-d '{ "partNumbers": [1, 2, 3] }'Chaque URL d’import est signée, à usage unique et à durée limitée. Elle est hébergée sur notre domaine, jamais sur un nom d’hôte cloud brut.
Finalisez, ou laissez le dernier import s’en charger
curl -X POST https://api.ivesentit.com/v1/transfers/<id>/finalize \
-H "X-Transfer-Token: <manageToken>"L’analyse démarre. Terminer le dernier fichier finalise déjà l’envoi pour vous, donc cet appel est une confirmation sans risque : il renvoie le statut actuel et ne lance jamais rien deux fois. L’e-mail de l’envoi part lorsque tout est sain et empaqueté, avec un certificat d’envoi signé que votre destinataire peut vérifier.
Suivre le parcours
curl https://api.ivesentit.com/v1/deliveries/<id> \
-H "Authorization: Bearer ivst_live_..."
curl "https://api.ivesentit.com/v1/events?after=<last-id>" \
-H "Authorization: Bearer ivst_live_..."{
"id": "d23583b7-…", "status": "ready", "testMode": true,
"certificateId": "DLV-D23583B7-TLPJLB", // every delivery carries signed proof
"files": [{ "name": "final-cut.mp4", "uploaded": true, "scan": "clean" }],
"recipients": [{ "to": "client@example.com", "opens": 2, "downloads": 1 }]
}
{ "events": [
{ "type": "delivery.created", "data": { "transferId": "d23583b7-…" } },
{ "type": "delivery.sent", "data": { "certificateId": "DLV-…" } },
{ "type": "delivery.opened", "data": { "recipient": "client@…", "country": "GB" } },
{ "type": "delivery.downloaded", "data": { "bytes": 734003200 } }
], "nextAfter": null }Le statut indique l’état d’analyse de chaque fichier et les ouvertures et téléchargements par destinataire. Événements paginés par curseur, plus anciens d’abord, conservés 30 jours.
Tout ce qu’un envoi peut contenir se place dans le seul corps POST /v1/deliveries. Tout est facultatif : un envoi minimal se suffit à lui-même ; les blocs réservés à certaines offres renvoient 403 UPGRADE_REQUIRED si votre offre ne les inclut pas. Chaque bloc ci-dessous montre l’appel exact qui l’active.
Mot de passe
ProLes destinataires doivent saisir le mot de passe avant toute ouverture. Communiquez-le par un autre canal que l’e-mail d’envoi.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "accounts-2026.xlsx", "size": 48210 }],
"recipients": ["fd@client.com"],
"password": "correct-horse-battery"
}'Le mot de passe n’est jamais stocké en clair et n’apparaît dans aucun e-mail.
GeoWall
ProIndiquez les pays depuis lesquels l’envoi peut être récupéré : il est refusé partout ailleurs, dès la bordure du réseau.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "master-audio.wav", "size": 812349440 }],
"recipients": ["label@partner.co.uk"],
"allowedCountries": ["GB", "IE"]
}'Codes ISO à deux lettres. Toute tentative hors du périmètre est refusée avant le moindre octet transféré.
Téléchargements max
ProDéfinissez le nombre total de téléchargements autorisés avant que l’envoi ne se verrouille.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "press-kit.pdf", "size": 9210331 }],
"recipients": ["press@outlet.com"],
"downloadCap": 3
}'La limite compte les téléchargements terminés, tous destinataires confondus. Elle ne peut pas être combinée avec viewOnce (les deux options se contredisent, et l’API vous le signale).
Vue unique
ProL’envoi s’autodétruit après sa première récupération : un coup d’œil, puis plus rien.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "credentials.pdf", "size": 102400 }],
"recipients": ["new-hire@company.com"],
"viewOnce": true
}'Après la première récupération réussie, l’envoi est scellé pour tout le monde, expéditeur compris.
Ouverture programmée
ProL’e-mail d’envoi part immédiatement ; les fichiers restent scellés jusqu’à la levée de l’embargo.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "earnings-q3.pdf", "size": 421889 }],
"recipients": ["press@wire.com"],
"releaseAtTime": 1790244000
}'Secondes Unix. Les destinataires voient un compte à rebours, et non les fichiers, jusqu’à l’heure prévue.
Filigrane par destinataire
TeamChaque destinataire reçoit sa propre copie marquée de chaque PDF et image : si un scénario de projection fuite, il mène à une seule personne.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "episode-1-screening-script.pdf", "size": 4821337 }],
"recipients": ["critic-a@outlet.com", "critic-b@paper.co"],
"watermark": true,
"watermarkLabel": "CONFIDENTIAL SCREENER"
}'Nécessite au moins un destinataire nommé (le marquage est individuel). Marque les PDF et les images (PNG, JPEG, WebP, jusqu’à 256 Mo chacune) ; les vidéos, fichiers audio, archives et autres fichiers sont envoyés sans marquage. watermarkLabel ajoute un texte facultatif à côté de l’identité du destinataire.
Envoi avec identité vérifiée
TeamLes fichiers restent verrouillés jusqu’à ce que le destinataire réussisse une vérification d’identité. Ajoutez le mode confirmation et vous libérez à la main chaque personne vérifiée.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "settlement-agreement.pdf", "size": 220144 }],
"recipients": ["counterparty@firm.law"],
"idVerify": true,
"idVerifyConfirm": true
}'Nécessite des destinataires nommés. Avec idVerifyConfirm, l’expéditeur examine chaque vérification et libère les fichiers personne par personne ; sans cette option, une vérification réussie déverrouille les fichiers automatiquement.
Payer pour télécharger
ProFixez un prix. Votre client paie par carte, les fichiers se déverrouillent et l’argent arrive sur votre propre compte Stripe : nous prenons 0 %.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "wedding-highlights.mp4", "size": 5368709120 }],
"recipients": ["couple@example.com"],
"priceCents": 45000,
"priceCurrency": "gbp"
}'Les versements Stripe doivent d’abord être configurés sur votre compte (Compte → Être payé), avec au moins un destinataire nommé : chaque lien personnel correspond à un achat.
Lien seul et alertes d’ouverture
Deux petits interrupteurs : linkOnly crée un envoi sans destinataires (vous partagez le lien vous-même) ; notifyOnOpen vous prévient par e-mail à la première ouverture.
curl -X POST https://api.ivesentit.com/v1/deliveries \
-H "Authorization: Bearer ivst_live_..." -H "Content-Type: application/json" \
-d '{
"files": [{ "name": "portfolio.pdf", "size": 18320441 }],
"linkOnly": true,
"notifyOnOpen": true
}'Un envoi sans destinataire doit indiquer explicitement linkOnly: true. Perdre des destinataires sans le signaler ne doit jamais passer pour un succès.
Aide-mémoire : toutes les options en un coup d’œil.
| option | type | ce qu’elle ajoute | offre |
|---|---|---|---|
recipients | string[] | Adresses e-mail ou @identifiants. À omettre avec linkOnly: true pour partager le lien vous-même. Sans effet avec une clé de test (l’envoi se fait vers votre propre e-mail). | |
message | string | Une note qui accompagne l’envoi. | |
password | string | Les destinataires doivent le saisir avant d’ouvrir quoi que ce soit. | Pro |
allowedCountries | string[] | GeoWall : codes pays à deux lettres ; ailleurs, l’envoi ne peut pas être récupéré. | Pro |
downloadCap | integer | Nombre total de téléchargements autorisés avant que l’envoi ne se verrouille. | Pro |
viewOnce | boolean | Détruit après la première récupération. | Pro |
releaseAtTime | secondes Unix | Diffusion programmée : les fichiers restent scellés jusqu’à la levée de l’embargo. | Pro |
retentionSeconds | integer | Durée de vie de l’envoi (plafonnée au maximum de votre offre). | |
region | "eu" | "us" | Où les fichiers sont physiquement stockés. | Équipe pour us |
watermark (+ watermarkLabel) | boolean | Filigrane par destinataire : chaque destinataire reçoit sa propre copie marquée de chaque PDF et de chaque image ; les autres types de fichiers sont envoyés sans marquage. | Team |
idVerify (+ idVerifyConfirm) | boolean | Envoi avec vérification d’identité : les fichiers se débloquent après un contrôle d’identité ; le mode confirmation permet à l’expéditeur de valider à la main chaque personne vérifiée. | Team |
priceCents (+ priceCurrency) | integer | Téléchargement payant : les fichiers se débloquent après paiement par carte, directement sur votre compte Stripe. 0 % de commission. | Pro |
notifyOnOpen | boolean | E-mail à l’expéditeur à la première ouverture. | |
idempotencyKey | string | Gardez la même clé d’une tentative à l’autre : une expiration ambiguë ne pourra jamais créer un second envoi. |
/v1/deliveriesClé API · sendCréer un envoi : déclarez les fichiers (nom + taille exacte en octets) et les destinataires, obtenez des cibles d’import à notre nom et un manageToken. Avec une clé de test, recipients est facultatif et ignoré : l’envoi part vers l’e-mail de votre compte. Prend en charge message, password, region (eu/us), retentionSeconds, allowedCountries, downloadCap, viewOnce, releaseAtTime et une idempotencyKey conservée entre les tentatives.
/v1/deliveries/:idClé API · readL’état actuel de l’envoi : statut (draft → scanning → ready), verdicts d’analyse par fichier, ouvertures et téléchargements par destinataire, id du certificat d’envoi, testMode.
/v1/transfers/:id/files/:fileId/partsX-Transfer-TokenURL des parties multipart, jusqu’à 1 000 par requête : paginez pour les fichiers de plusieurs téraoctets.
/v1/transfers/:id/files/:fileId/completeX-Transfer-TokenMarquer un fichier comme importé (multipart : incluez les ETags des parties).
/v1/transfers/:id/finalizeX-Transfer-TokenTous les fichiers sont là : lance l’analyse (le complete du dernier fichier le fait déjà ; un nouvel appel est sans risque). La suite est automatique.
/v1/eventsClé API · eventsLe flux d’événements de votre espace de travail : delivery.created, .sent, .opened, .downloaded, .receipt_issued. Pagination par curseur avec after=ID ; limit ≤ 100.
/v1/webhooksClé API · eventsEnregistrer une URL https qui recevra chaque nouvel événement en POST, signé. Renvoie un secret de signature (affiché une seule fois). Préférez cette méthode au polling pour une intégration permanente.
/v1/webhooksClé API · eventsLister vos endpoints avec leur statut, le nombre d’échecs et le dernier code de réponse. Ne renvoie jamais le secret.
/v1/webhooks/:idClé API · eventsSupprimer un endpoint.
/v1/certificates/:idaucuneVérifier un certificat d’envoi : la preuve d’origine côté destinataire. Le SHA-256 complet donne accès à la liste des fichiers et au PDF signé.
/v1/receipts/:idaucuneVérifier un reçu de preuve de remise auprès du registre public.
/v1/receipts/keysaucuneLa clé de signature publique : vérifiez les reçus et les certificats entièrement hors ligne.
Enregistrez une URL https et nous y envoyons chaque événement en POST dès qu’il se produit, sans boucle d’interrogation. Chaque requête porte un en-tête X-Ive-Signature que vous vérifiez avec le secret de signature que nous vous remettons une seule fois à l’enregistrement :
// verify an incoming webhook (Node)
import { createHmac, timingSafeEqual } from 'node:crypto';
function verify(secret, header, rawBody) {
const { t, v1 } = Object.fromEntries(header.split(',').map(p => p.split('=')));
if (Math.abs(Date.now() / 1000 - Number(t)) > 300) return false; // too old
const expected = createHmac('sha256', secret).update(t + '.' + rawBody).digest();
const given = Buffer.from(v1 ?? '', 'hex');
// constant-time compare — never === on signatures
return given.length === expected.length && timingSafeEqual(expected, given);
}La signature est un HMAC-SHA256 calculé sur <timestamp>.<raw body>, au format t=<ts>,v1=<hmac>. Rejetez tout ce qui date de plus de cinq minutes et comparez les signatures en temps constant (comme le fait l’extrait), jamais avec ==. Nous retentons les envois échoués avec un délai croissant et désactivons automatiquement un point de terminaison qui reste injoignable : réactivez-le depuis le tableau de bord ou via POST /v1/webhooks/:id/enable. L’envoi a lieu au moins une fois : dédoublonnez à l’aide de l’id de l’événement.
Chaque erreur est un JSON comportant un reason stable et une phrase lisible par un humain. Décidez selon le motif, affichez le message.
401 API_KEY_INVALID- Clé absente ou inconnue : envoyez Authorization: Bearer ivst_…
401 API_KEY_REVOKED- La clé a été révoquée depuis le tableau de bord.
403 API_KEY_SCOPE- La clé n’a pas la portée requise (send / read / events).
403 UPGRADE_REQUIRED- Cette option exige une offre supérieure, avec les mêmes restrictions que l’app.
404 DELIVERY_NOT_FOUND- Cet envoi n’appartient pas à cette clé (propriété par espace de travail).
429 RATE_LIMITED- Budgets de débit par espace de travail : 120 créations/heure, 600 lectures/heure.
429 QUOTA_EXCEEDED- Un garde-fou quotidien contre les emballements, pas une limite d’offre. Contactez-nous et nous le relèverons. Les plafonds Entreprise sont entièrement personnalisables.
Idempotence : gardez la même valeur idempotencyKey entre les tentatives de création. Une expiration ambiguë ne peut jamais créer un second envoi. Les imports se relancent sans risque par partie ; redemandez les URL si elles expirent.
- Rien ne part sans contrôle. Chaque fichier est analysé contre les malwares ; les médias passent un contrôle de contenu. Aucun scope de clé, aucune offre, aucun flag ne le contourne.
- Notre nom sur chaque URL. Imports sur
in.ivesentit.com, téléchargements surfiles.ivesentit.com: ajoutez*.ivesentit.comà votre liste d’autorisation, et c’est tout. - Une preuve dans les deux sens. Les expéditeurs reçoivent un reçu signé indiquant qui a ouvert quoi ; chaque envoi comporte un certificat que le destinataire peut vérifier. Les points de terminaison sont publics et sans clé.
- Vos destinataires voient un envoi, pas un tas de liens : les mêmes pages à vos couleurs que celles de l’application, sur votre domaine si vous en avez un.