Skip to main content
POST
Analyser un document

Authorizations

Authorization
string
header
required

Clé API créée dans Administration → Entreprise → Clés API (licence Groupe).

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 toléré). Identité : image JPEG, PNG ou WebP — le recto. Administratif : image ou PDF, 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
includeCertificate
boolean
default:false

Joint le certificat PDF (base64) à la réponse.

Response

Le résultat de l'analyse — même forme que la lecture, plus le certificat si demandé.

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 technique de l'analyse — immuable.

Available options:
conforme,
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 includeCertificate est vrai.

certificateUrl
string

Adresse de retéléchargement du certificat.