Passer au contenu principal

​
Prerequis

Avant de commencer, vous aurez besoin de :
  • Un compte TXCloud (inscrivez-vous ici)
  • Une cle API depuis votre tableau de bord
  • Node.js 18+ (pour le SDK JavaScript) ou Python 3.8+ (pour le SDK Python)

​
Etape 1 : Obtenez Votre Cle API

1

Creez un Compte

Allez sur dashboard.txcloud.io et inscrivez-vous pour un compte gratuit.
2

Accedez aux Cles API

Dans votre tableau de bord, allez dans Parametres puis Cles API.
3

Creez une Nouvelle Cle

Cliquez sur Creer une Cle API, donnez-lui un nom et selectionnez les permissions dont vous avez besoin.
Conservez votre cle API en securite. Elle ne sera affichee qu’une seule fois !
Votre cle API ressemblera a ceci : 
txc_live_a1b2c3d4e5f6g7h8i9j0...

​
Etape 2 : Installez le SDK

npm install @txcloud/sdk
# ou
yarn add @txcloud/sdk
# ou
pnpm add @txcloud/sdk

​
Etape 3 : Initialisez le Client

import TXCloud from '@txcloud/sdk';

const txcloud = new TXCloud({
  apiKey: process.env.TXCLOUD_API_KEY,
  // Optionnel : utilisez sandbox pour les tests
  environment: 'sandbox' // ou 'production'
});

​
Etape 4 : Verifiez Votre Premiere Identite

Verifions un document d’identite d’utilisateur : 
// Verifier un document d'identite
const verification = await txcloud.identity.verify({
  document_front: fs.readFileSync('id_front.jpg', 'base64'),
  document_back: fs.readFileSync('id_back.jpg', 'base64'),
  selfie: fs.readFileSync('selfie.jpg', 'base64'),
  country: 'MA',
  document_type: 'national_id',
  checks: ['ocr', 'face_match', 'liveness', 'fraud']
});

console.log('Statut:', verification.status);
console.log('Nom:', verification.extracted_data.full_name);
console.log('Correspondance Faciale:', verification.checks.face_match.match);

​
Reponse

{
  "id": "ver_a1b2c3d4e5f6",
  "status": "verified",
  "created_at": "2025-01-15T10:30:00Z",

  "extracted_data": {
    "full_name": "Mohammed El Amrani",
    "date_of_birth": "1990-05-15",
    "document_number": "AE123456",
    "nationality": "Marocain",
    "expiry_date": "2028-05-14"
  },

  "checks": {
    "ocr": { "status": "passed", "confidence": 0.95 },
    "face_match": { "status": "passed", "similarity": 0.92 },
    "liveness": { "status": "passed", "confidence": 0.98 },
    "fraud": { "status": "passed", "risk_score": 120 }
  }
}
Felicitations ! Vous avez verifie avec succes votre premiere identite avec TXCloud.

​
Etape 5 : Configurez les Webhooks (Optionnel)

Pour les workflows asynchrones, configurez des webhooks pour recevoir des mises a jour en temps reel : 
// Creer un endpoint webhook
const webhook = await txcloud.developers.webhooks.create({
  url: 'https://votreapp.com/webhooks/txcloud',
  events: [
    'identity.verification.completed',
    'identity.verification.failed',
    'fraud.signal.detected'
  ],
  secret: 'whsec_votre_secret_ici'
});

En Savoir Plus sur les Webhooks

Configurez et securisez vos endpoints webhook

​
Prochaines Etapes

Maintenant que vous avez fait votre premier appel API, explorez plus de fonctionnalites :

Detection de Fraude

Ajoutez l’intelligence des appareils et les signaux de fraude

Scoring de Transactions

Scorez les transactions en temps reel

Evaluation de Credit

Verifiez les revenus et evaluez la solvabilite

Reference API

Explorez tous les endpoints disponibles

​
Sandbox vs Production

TXCloud fournit un environnement sandbox pour les tests. Les requetes sandbox n’affectent pas les donnees reelles et utilisent des identifiants de test.
EnvironnementURL de BasePrefixe Cle API
Sandboxhttps://sandbox.api.txcloud.io/v1txc_test_...
Productionhttps://api.txcloud.io/v1txc_live_...
Utilisez toujours le sandbox pour le developpement et les tests. Les appels API de production peuvent entrainer des frais.

​
Besoin d’Aide ?

Discord

Rejoignez notre communaute

Page de Statut

Verifiez le statut de l’API