Documentation API

Intégrez e-KYC en quelques jours

APIs REST simples, documentation complète, et environnement sandbox pour tester votre intégration.

Démarrage rapide

Suivez ces étapes pour intégrer e-KYC dans votre application

1

Obtenez vos clés API

Créez un compte et générez vos clés API depuis le portail client.

Demander un accès
2

Testez en sandbox

Utilisez l'environnement sandbox pour tester votre intégration sans risque.

sandbox.api.ekyc.cortixia.com
3

Passez en production

Une fois les tests validés, basculez vers l'environnement de production.

api.ekyc.cortixia.com
# Créer une session KYC
curl -X POST https://api.ekyc.cortixia.com/v1/kyc/sessions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "callback_url": "https://your-app.com/webhook/kyc",
    "doc_type": "passport",
    "level": "full",
    "redirect_url": "https://your-app.com/kyc-complete"
  }'

# Réponse
{
  "session_id": "kyc_01H...",
  "status": "created",
  "deeplink": "ekyc://session/kyc_01H...",
  "qr_payload": "https://app.ekyc.cortixia.com/s/kyc_01H...",
  "expires_at": "2026-01-07T15:30:00Z"
}

Référence API

Endpoints disponibles pour l'intégration e-KYC et Signature

KYC

Méthode Endpoint Description
POST /v1/kyc/sessions Créer une session KYC
GET /v1/kyc/sessions/{id} Obtenir le statut et résultat
GET /v1/kyc/sessions/{id}/evidence Télécharger le dossier de preuves

OTP

Méthode Endpoint Description
POST /v1/otp/send Envoyer un OTP (SMS/Email)
POST /v1/otp/verify Vérifier un code OTP

Signature

Méthode Endpoint Description
GET /v1/sign/tokens/balance Consulter le solde de jetons
POST /v1/sign/requests Créer une demande de signature
GET /v1/sign/requests/{id} Statut de la demande
GET /v1/sign/requests/{id}/document Télécharger le document signé
GET /v1/verify/{document_id} Vérification publique

Authentification

Deux méthodes d'authentification sont disponibles pour sécuriser vos appels API.

API Key

Simple et rapide

Passez votre clé API dans le header Authorization avec le préfixe Bearer.

Authorization: Bearer YOUR_API_KEY

OAuth2

Recommandé

Utilisez le flow client_credentials pour obtenir un access token JWT.

POST /oauth/token
grant_type=client_credentials

Bonnes pratiques

Gardez vos clés secrètes

Ne partagez jamais vos clés API et ne les committez pas dans votre code.

Utilisez des variables d'environnement

Stockez vos credentials dans des variables d'environnement.

Rotation régulière

Changez vos clés API régulièrement pour renforcer la sécurité.

Idempotency-Key

Utilisez des clés d'idempotence pour les requêtes POST critiques.

Webhooks

Recevez des notifications en temps réel lorsque des événements se produisent

Événements disponibles

kyc.created

Session KYC créée

kyc.step.completed

Étape du parcours complétée

kyc.completed

Session KYC terminée (PASS/FAIL)

sign.created

Demande de signature créée

sign.completed

Document signé avec succès

sign.failed

Échec de la signature

Exemple de payload

{
  "event": "kyc.completed",
  "tenant_id": "tnt_123",
  "session_id": "kyc_01H...",
  "decision": "PASS",
  "scores": {
    "liveness": 0.93,
    "face_match": 0.88,
    "document": 0.90
  },
  "identity": {
    "full_name": "Mohamed BENALI",
    "document_number": "ABC123456",
    "birth_date": "1990-03-15"
  },
  "evidence_ref": "evd_01H...",
  "created_at": "2026-01-07T12:34:56Z"
}

Sécurité des webhooks

Tous les webhooks sont signés avec HMAC-SHA256. Vérifiez toujours la signature avant de traiter le payload.

Testez gratuitement en sandbox

Accédez à l'environnement sandbox pour tester votre intégration avec des données de test, sans frais.

Demander un accès sandbox