Skip to main content

Guide d'Intégration

Cette documentation détaille l'API NC.CAM.Services.DocumentAnalyzor, qui permet d’analyser un document d’identité (PDF) et d’en extraire des informations à l’aide d’Azure Form Recognizer.

  • Nom : NC.CAM.Services.DocumentAnalyzor
  • Version de l’API : 1.0

Analyser un document PDF​

Cet endpoint permet de soumettre un fichier PDF pour analyse et extraction d’informations.

  • URL : /AnalyzeDocument
  • Méthode : POST

Appel​

Content-Type​

  • multipart/form-data

Paramètres du formulaire​

NomTypeDescription
filestring (binary)Fichier PDF à analyser, envoyé en binaire

Exemple de Requête​

Voici un exemple de requête pour envoyer un fichier à analyser :

curl --location --request POST 'https://localhost:5001/AnalyzeDocument' \
--form 'file=@/chemin/vers/le/fichier.pdf'

Réponses​

  • 200 OK : La requête a été traitée avec succès, la réponse contient les résultats de l’analyse.
  • 400 Bad Request : Si le fichier n’est pas fourni ou si le format n’est pas supporté.
  • 500 Internal Server Error : Erreur serveur lors de l’analyse du fichier.

Exemple de Réponse (200 OK)​

{
  "isSuccess": true,
  "isDocumentValid": true,
  "metaData": { /* Résultat complet de l’analyse retourné par Azure */ },
  "possibleDocumentTypes": [
    {
      "documentType": "idDocument.nationalIdentityCard",
      "fields": [
        {
          "field": "Address",
          "possibleValues": [
            {
              "value": "104 RUE DES FLEURS\n92100 BOULOGNE-BILLANCOURT",
              "confidence": 0.383
            }
          ],
          "mostLikelyValue": {
            "value": "104 RUE DES FLEURS\n92100 BOULOGNE-BILLANCOURT",
            "confidence": 0.383
          }
        }
      ],
      "documentTypeConfidence": 0.96599996
    }
  ],
  "mostLikelyDocumentType": {
    "documentType": "idDocument.nationalIdentityCard"
  },
  "error": null
}

Détail des champs de la réponse​

  • isSuccess : Indique si l’analyse a été réalisée avec succès.
  • isDocumentValid : Indique si le document soumis est valide (confiance > 0.9).
  • metaData : Résultat détaillé de l’analyse retourné par Azure.
  • possibleDocumentTypes : Liste des types de documents détectés avec leurs champs et valeurs.
  • mostLikelyDocumentType : Type de document jugé le plus probable.
  • error : Message d’erreur, ou null si aucune erreur.