Document & Evidence

Un document est une demande de pièce justificative. Une evidence est la preuve fournie en réponse par le tiers ou une source externe.

Définitions

Types d'evidence

Une evidence peut prendre deux formes selon le type de document demandé :

Lister les documents d'un dossier

Récupérez tous les documents demandés dans un dossier avec leur statut et leurs evidences.

Exemple de réponse

{
  "content": [
    {
      "documentId": 11078435,
      "dossierId": 1324073,
      "documentCode": "ATT_URSSAF",
      "documentName": "Attestation de vigilance URSSAF",
      "requestDate": "2025-01-15T10:00:00.000",
      "present": true,
      "statusCode": "VALID",
      "evidences": [
        {
          "id": 6876412,
          "responseId": 2238768,
          "uploadDate": "2025-01-20T14:30:00.000",
          "fileUUID": "a4d8acd5-8254-477c-9019-fa85aef8d224",
          "fileName": "attestation_urssaf.pdf",
          "fileSize": 128790,
          "expirationDate": "2025-07-20T23:59:59.999",
          "format": "ORIGINALNUMERIQUE",
          "issuer": "DO",
          "transmitter": "FOURNISSEUR"
        }
      ]
    },
    {
      "documentId": 11031065,
      "dossierId": 1324073,
      "documentCode": "KBIS",
      "documentName": "Extrait Kbis",
      "requestDate": "2025-01-15T10:00:00.000",
      "present": false,
      "statusCode": "MISSING",
      "evidences": []
    }
  ]
}

Détails d'un document

Récupérez les informations détaillées d'un document spécifique.

Structure d'une evidence

Chaque evidence contient des métadonnées sur la preuve fournie :

Les données extraites d'un document

Certaines pièces justificatives sont lues automatiquement par la plateforme, qui en retire les champs utiles — les informations portées par une attestation d'assurance, par exemple. Ces valeurs sont exposées sur le justificatif dans aprovallCheck.extractedData, sous forme de liste d'entrées.

La structure d'une entrée

Chaque entrée décrit un champ lu sur le document. Le libellé est destiné à l'affichage ; c'est name qui identifie le champ de façon stable.

Exemple de réponse

{
  "id": 90124,
  "statusCode": "ACTION_REQUIRED",
  "aprovallCheck": {
    "extractedData": [
      {
        "name": "document_type",
        "type": "TEXT",
        "label": "Type de document",
        "value": "DECLARATION_NON_CONCERNE"
      },
      {
        "name": "is_insured",
        "type": "BOOLEAN",
        "label": "Entreprise assurée",
        "value": false
      },
      {
        "name": "edition_date",
        "type": "DATE",
        "label": "Date d'édition",
        "value": "2026-04-10"
      },
      {
        "name": "expiration_date",
        "type": "DATE",
        "label": "Date de fin de validité",
        "value": ""
      },
      {
        "name": "company_name",
        "type": "TEXT",
        "label": "Nom de l'entreprise assurée",
        "value": "ACME BTP"
      },
      {
        "name": "identifier",
        "type": "TEXT",
        "label": "SIRET/SIREN",
        "value": "12345678900017"
      },
      {
        "name": "Plafond",
        "type": "NUMERIC",
        "label": "Plafond de garantie par sinistre",
        "value": null
      },
      {
        "name": "platform_generated",
        "type": "BOOLEAN",
        "label": "Document généré par la plateforme",
        "value": true
      }
    ]
  }
}

Où l'utiliser

Le paramètre est accepté sur les cinq endpoints qui renvoient des justificatifs :

Formulaires : structure formdata

Pour les documents de type formulaire, le tableau formdata contient les réponses structurées :

{
  "formdata": [
    {
      "type": "string",
      "key": "f_158_nmr_0",
      "title": "Nom ou référence de l'opération",
      "order": 0,
      "value": "Projet Alpha"
    },
    {
      "type": "date",
      "key": "f_158_dtd_2",
      "title": "Date de réalisation",
      "order": 2,
      "value": "15/01/2025"
    },
    {
      "type": "iban",
      "key": "f_49_bn_0",
      "title": "IBAN",
      "order": 0,
      "value": "FR76 0000 0000 0000 0000 0000 000"
    }
  ]
}

Types de champs

Télécharger un fichier

Plusieurs méthodes pour récupérer les fichiers des evidences :

Actions sur un document

Lorsqu'un document est en statut ACTION_REQUIRED, vous pouvez l'approuver ou le rejeter via l'API.

Approuver un document

curl -X POST https://edge.aprovall.com/api/v1/account/123/responses/2238768/approve \
  -H "Authorization: Bearer VOTRE_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Document conforme"
  }'

Rejeter un document

curl -X POST https://edge.aprovall.com/api/v1/account/123/responses/2238768/reject \
  -H "Authorization: Bearer VOTRE_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Document expiré",
    "shareRejectionReason": true
  }'

Ajouter un document requis

Vous pouvez ajouter des documents supplémentaires à un dossier existant (sauf pour les dossiers typés où la liste est fixée).

curl -X POST https://edge.aprovall.com/api/v1/account/123/dossiers/456/requirements \
  -H "Authorization: Bearer VOTRE_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "newRequiredDocuments": ["JUSTIF_IMM", "ATT_FISC"]
  }'

Vérifications automatiques

Certains documents font l'objet de vérifications automatiques par Aprovall. Les résultats sont disponibles dans le champ metadata de l'evidence.

Exemple : vérification IBAN

Pour les documents IBAN, la vérification peut inclure des données SEPAmail ou Trustpair :

{
  "metadata": {
    "verified": "true",
    "bank_data_bank": "CREDIT DU NORD",
    "bank_data_bic": "NORDXXXX",
    "bank_data_country": "FRANCE",
    "sepa_data_sct": "YES",
    "sepa_data_sdd": "YES",
    "date_verification": "15/01/2025"
  }
}

Prochaines étapes

• Concepts : Statuts — Comprendre le workflow des statuts
• Concepts : Dossier — Gestion des dossiers d'évaluation
• Concepts : Indicateurs — Les scores SmartPilot