> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sahlfinancial.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Référence de l'API

> Six endpoints sous /v1/kyc, une clé bearer, un hôte, un playground sur chaque page.

URL de base : `https://app.sahlfinancial.com/api`. Chaque appel envoie `Authorization: Bearer <API key>`.

| Endpoint | Scope | Guide |
| - | - | - |
| `POST /v1/kyc/extract` | `kyc:extract` | [Lire des documents](/fr/guides/ocr-documents) |
| `POST /v1/kyc/verify` | `kyc:verify` | [Vérifier un profil](/fr/guides/verification) |
| `POST /v1/kyc/assess` | `kyc:verify` | [Évaluation du risque](/fr/guides/risk-assessment) |
| `POST /v1/kyc/eid` | `kyc:eid` | [Contrôle eID](/fr/guides/eid) |
| `GET /v1/kyc/eid/{key}` | `kyc:eid` | [Contrôle eID](/fr/guides/eid) |
| `GET /v1/kyc/eid/{key}/report` | `kyc:eid` | [Contrôle eID](/fr/guides/eid) |

Les pages suivantes sont générées à partir de `openapi.json`. Chacune a un panneau **Try it** qui exécute la requête depuis votre navigateur avec votre propre clé. Collez uniquement la clé, sans `Bearer`. Ne collez pas une clé que vous utilisez en production. Le pas à pas se trouve sur [Tester dans le sandbox](/fr/test-in-sandbox).

<Note>
  Ceci est l'**API Partenaire** : les routes qu'une clé d'API partenaire peut appeler. Les routes que la console appelle avec une session de connexion sont dans la référence distincte de l'[API de la console](/fr/console-api/overview). Elles ne sont pas accessibles avec une clé d'API.
</Note>

Pourquoi six : ce sont toutes les routes qu'une clé peut appeler dans le code le plus récent de l'API Sahl (vérifié le 2026-10-07). La console fait davantage, avec une session au lieu d'une clé : voir [Fonctionnalités de la console](/fr/console-features) et [Couverture](/fr/coverage).

## Conventions

| Élément | Règle |
| - | - |
| Format | JSON en entrée et en sortie. `/extract` prend `multipart/form-data`. Le rapport PDF est en `application/pdf`. |
| Dates | `YYYY-MM-DD`. Les heures sont en ISO 8601. |
| Chaînes | Les valeurs de champs lues dans les documents sont des chaînes. |
| `environment` | `sandbox` (par défaut) ou `production`. |
| `reference` | Votre identifiant du client, de 1 à 64 caractères parmi `A-Z a-z 0-9 _ . : -`. |
| Identifiant de requête | Chaque réponse contient `X-Request-ID`. Envoyez le vôtre pour corréler. |
| Erreurs | Trois formes de corps. Voir [Erreurs](/fr/errors). |
| Versionnage | La version figure dans le fichier OpenAPI (`0.2.0`). Le chemin n'a pas de préfixe de version au-delà de `/v1`. |

## Téléchargements

Le fichier OpenAPI est à l'adresse [/openapi.json](/openapi.json). Une collection et un environnement Postman générés à partir de ce fichier sont décrits sur [Postman](/fr/postman).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.