Lisez des documents clients, vérifiez un profil, évaluez le risque et lancez des contrôles eID avec une seule API REST. Testez en sandbox avec votre clé, puis passez le champ environment à production.
En production en 4 étapes
De la demande d'accès à votre premier appel. L'API partenaire est activée par espace de travail.
Demander l'accès
Demandez un accès sandbox. Nous activons l'API partenaire sur votre espace de travail.
Créer une clé API
Dans la console, créez une clé avec les scopes dont vous avez besoin : kyc:extract, kyc:verify, kyc:eid.
Appeler en sandbox
Envoyez environment=sandbox avec des données de test. Il n'y a pas d'hôte sandbox séparé.
Passer en production
Envoyez environment=production avec le même type de requête quand votre espace de travail est prêt.
URL de base
Un seul hôte pour tous les appels. Le champ environment de chaque requête choisit les données de test ou réelles : sandbox par défaut, production pour le réel.
https://app.sahlfinancial.com/apiCe que l'API couvre aujourd'hui
Quatre capacités sont ouvertes aux clés API partenaire. Le reste de la plateforme se trouve dans la console.
| Capacité | Ce qu'elle fait | Endpoints | Scope |
|---|---|---|---|
| Lecture de documents | Lit 1 à 5 fichiers par appel (JPEG, PNG, WebP, TIFF ou PDF, 30 Mo maximum chacun) en champs structurés. | POST /v1/kyc/extract | kyc:extract |
| Vérification | Contrôle un profil client et ses documents et renvoie un verdict avec les contrôles qui le fondent. | POST /v1/kyc/verify | kyc:verify |
| Évaluation du risque | Même corps de requête que la vérification, avec en plus une évaluation du risque construite sur le verdict. | POST /v1/kyc/assess | kyc:verify |
| eID | Lance un contrôle eID, indique où il en est et télécharge le rapport. | POST /v1/kyc/eid, GET /v1/kyc/eid/{key}, GET /v1/kyc/eid/{key}/report | kyc:eid |
| Dans la console | Connexions bancaires, dossiers, politiques de scoring. Non disponibles avec les clés API partenaire. | Console uniquement | |
Lire un document, puis le vérifier
Deux vrais appels. Définissez SAHL_API_KEY avec une clé sandbox et pointez le fichier vers un document de test.
# 1. Read a document (multipart). environment defaults to sandbox.
curl -X POST https://app.sahlfinancial.com/api/v1/kyc/extract \
-H "Authorization: Bearer $SAHL_API_KEY" \
-F "files=@passport-test.jpg" \
-F "doc_type=passport" \
-F "reference=client-0001" \
-F "environment=sandbox"
# 2. Verify the profile (send back the documents the first call returned).
curl -X POST https://app.sahlfinancial.com/api/v1/kyc/verify \
-H "Authorization: Bearer $SAHL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"reference":"client-0001","environment":"sandbox","subject":"Test Client","kind":"individual","values":{"first_name":"Test","last_name":"Client"},"documents":[]}'Endpoints
Six endpoints sur un seul hôte. Les schémas complets de requête et de réponse sont dans le fichier OpenAPI et la documentation.
Authentification
Envoyez votre clé API comme jeton Bearer. Les clés sont créées dans la console avec les scopes kyc:extract, kyc:verify et kyc:eid. Une clé sans le scope d'un appel reçoit un 403. Gardez les clés côté serveur, jamais dans un navigateur ou une application mobile.
Authorization: Bearer <API key>| Méthode | Chemin | Ce qu'elle fait | Scope |
|---|---|---|---|
| POST | /v1/kyc/extract | Lire des documents (multipart : files, doc_type, reference, environment) | kyc:extract |
| POST | /v1/kyc/verify | Vérifier un profil | kyc:verify |
| POST | /v1/kyc/assess | Vérifier et évaluer le risque | kyc:verify |
| POST | /v1/kyc/eid | Lancer un contrôle eID | kyc:eid |
| GET | /v1/kyc/eid/{key} | Consulter un contrôle eID | kyc:eid |
| GET | /v1/kyc/eid/{key}/report | Télécharger un rapport eID | kyc:eid |
Clés à scopes
Chaque clé ne porte que les scopes que vous lui donnez : lecture de documents, vérification, eID.
Un hôte, deux environnements
Sandbox et production partagent le même hôte et se distinguent par le champ environment.
Classé pour vous
Envoyez une reference : le dossier, ses documents et le verdict sont classés dans votre espace de travail, où vos équipes les consultent.
Commencez à construire aujourd'hui
Demandez un accès sandbox et faites votre premier appel.