Signlift

Organisation

Ce que l'organisation derrière votre clé API peut faire avec elle — plan, fonctionnalités et limites effectives.

GET /api/v1/organization

Décrit l'organisation à laquelle appartient la clé API appelante : son plan, les fonctionnalités dont elle dispose et ses limites effectives, forçages du back-office compris.

L'objet est renvoyé tel quel, sans enveloppe data. Pour savoir comment s'en servir avant d'envoyer, voir Connaître les capacités de sa clé.

Exemple

curl https://app.signlift.eu/api/v1/organization \
  -H "X-Api-Key: $SIGNLIFT_API_KEY"

Réponse 200

{
  "id": 12,
  "name": "Capsens",
  "plan": "pro",
  "environment": "sandbox",
  "features": {
    "sms_otp": true,
    "initials": true,
    "branding_profiles": true,
    "transactional_sms": false
  },
  "limits": {
    "documents_per_request": 10,
    "branding_profiles": 2,
    "transactional_sms_per_month": 10000,
    "rate_limit": { "per_minute": 120, "per_hour": 3000 }
  }
}

Les valeurs ci-dessus illustrent la forme de la réponse : lisez toujours celles que renvoie l'API, qui dépendent de votre plan et de votre organisation.

Champs

ChampTypeDescription
idintegerIdentifiant de l'organisation.
namestringNom de l'organisation.
planstringfree, simple, pro ou enterprise.
environmentstringsandbox ou production : l'environnement de la clé appelante, pas de l'organisation.
featuresobjectFonctionnalités que le plan ouvre à l'organisation.
limitsobjectLimites effectives, forçages du back-office compris.

features

ChampTypeDescription
sms_otpbooleanLes signataires peuvent être authentifiés par code SMS. Aucun SMS n'est envoyé en sandbox.
initialsbooleanLes paraphes sont disponibles (initials_required).
branding_profilesbooleanLes chartes graphiques sont disponibles. Un forçage peut l'ouvrir sur un plan qui ne l'inclut pas.
transactional_smsbooleanL'API SMS transactionnels est activée et utilisable. Sans rapport avec sms_otp.

limits

ChampTypeDescription
documents_per_requestinteger ou nullNombre maximal de documents dans une demande de signature. null : illimité.
branding_profilesinteger ou nullNombre maximal de chartes graphiques. null : illimité.
transactional_sms_per_monthintegerPlafond mensuel de SMS transactionnels créés en production, renvoyé même si le service n'est pas activé.
rate_limit.per_minuteinteger ou nullAppels par minute pour l'environnement de la clé. null : illimité.
rate_limit.per_hourinteger ou nullAppels par heure pour l'environnement de la clé. null : illimité.

Erreurs

HTTPCodeQuand
401invalid_api_keyClé absente, mal formée ou révoquée.
402payment_requiredClé de production sur une organisation sans accès payant.
429rate_limitedPlafond d'appels dépassé. Cet appel est compté comme les autres.

L'appel porte les en-têtes X-RateLimit-* comme toute réponse authentifiée : voir Limites et rate-limits.

On this page