Skip to main content
POST
Analyser un document

Authorizations

Authorization
string
header
required

Clé API créée dans Administration → Développeurs → Clés API (licence Groupe). Une clé en lecture seule ne peut appeler que les opérations GET.

Headers

Idempotency-Key
string

Même clé dans les 24 h → même résultat, pas de second acte.

Maximum string length: 255

Body

application/json
documentCategory
enum<string>
required

Nature du document transmis.

Available options:
identite,
administratif
document
string
required

Le document en base64 (préfixe data URL et retours à la ligne tolérés). Identité : image JPEG, PNG ou WebP (le recto). Administratif : PDF, JPEG, PNG, WebP ou TIFF d'une seule page, fichier unique. 10 Mo maximum.

documentVerso
string

Verso de la pièce d'identité (base64, optionnel). Refusé pour un document administratif.

externalRef
string

Votre référence de dossier — renvoyée dans le résultat et filtrable en lecture.

Maximum string length: 255
agencyPostalCode
string

Code postal de la commune de l'agence qui contrôle (optionnel, France). Pour une pièce d'identité, il place son passage sur la carte du parcours du document, au centre de la commune ; un code partagé par plusieurs communes désigne la plus peuplée. Un code qu'aucune commune ne porte (CEDEX, faute de frappe) est refusé en 400 invalid_request, avant toute analyse.

Pattern: ^\d{5}$
includeCertificate
boolean
default:false

Demande le certificat PDF dans la réponse. Si sa génération est temporairement saturée, le résultat reste créé et certificateUrl permet de le retélécharger.

Response

Le résultat de l'analyse — même forme que la lecture. Si le certificat demandé ne peut pas être généré immédiatement, certificateUrl reste présent et certificate est omis.

Résultat d'une vérification.

id
string

Identifiant unique du résultat.

Example:

"CSL-20260717-3F2A91"

externalRef
string | null

Votre référence de dossier, renvoyée telle quelle.

Example:

"DOSSIER-88412"

workflowId
string | null

Workflow qui a évalué le document.

Example:

"WFL-20260706-BEF798"

documentCategory
enum<string>

Catégorie du document contrôlé.

Available options:
identite,
administratif
documentType
string | null

Type de document détecté.

Example:

"CNI"

documentCountry
string | null

Pays émetteur (ISO 3166-1 alpha-3).

Example:

"FRA"

verdict
enum<string>

Constat de l'analyse du document, que la revue ne modifie jamais. Les règles de votre workflow n'y touchent pas : leur résultat est dans decision (un document conforme peut être refusé pour l'âge du porteur ou sa connexion). sans_anomalie ne concerne que les pièces administratives : émetteur confirmé dans un registre officiel, rien de relevé, sans cachet 2D-Doc vérifié.

Available options:
conforme,
sans_anomalie,
non_conforme,
suspect,
analyse_impossible
decision
enum<string> | null

Décision du workflow selon vos règles.

Available options:
conforme,
a_verifier,
refuse,
null
reviewStatus
enum<string> | null

Décision de traitement de votre équipe (revue humaine).

Available options:
pending,
accepted,
rejected,
null
anomalyCount
integer

Nombre de points d'attention relevés.

hasRejectAnomaly
boolean

Au moins un point d'attention bloquant.

anomalies
object[]

Points d'attention relevés par l'analyse.

twoDDoc
object | null

Cachet électronique 2D-Doc du document (null si aucun 2D-Doc et rien à signaler).

analyzedAt
string<date-time>

Date de l'analyse.

createdAt
string<date-time>

Date d'enregistrement.

certificate
string

Certificat PDF en base64 — présent si demandé et générable immédiatement.

certificateUrl
string

Adresse de téléchargement du certificat — présente dès qu'il est demandé.