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

📄

Document (Demande)

Représente une pièce demandée dans un dossier.

<code>documentId</code> — Identifiant unique
<code>documentCode</code> — Code du type de document
<code>documentName</code> — Libellé du document
<code>statusCode</code> — Statut actuel
<code>present</code> — Document fourni ou non

📎

Evidence (Preuve)

La réponse fournie par le tiers ou une source externe.

<code>id</code> — Identifiant de l'evidence
<code>responseId</code> — ID pour les actions
<code>uploadDate</code> — Date de dépôt
<code>expirationDate</code> — Date d'expiration
<code>formdata</code> — Données de formulaire

Types d'evidence

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

Type	Description	Propriétés spécifiques
Fichier uploadé	Document PDF, image ou autre fichier déposé par le tiers	`fileUUID`, `fileName`, `fileSize`
Formulaire rempli	Réponses à un questionnaire structuré	`formdata[]`

PDF généré pour les formulaires

Pour les formulaires remplis, Aprovall génère automatiquement un PDF consolidant toutes les réponses du tiers, téléchargeable via l'API.

Lister les documents d'un dossier

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

GET/api/v1/account/:accountId/dossiers/:dossierId/documents

Liste tous les documents d'un dossier avec 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.

GET/api/v1/account/:accountId/dossiers/:dossierId/documents/:documentId

Retourne les détails d'un document et ses evidences.

Structure d'une evidence

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

Propriété	Type	Description
`id`	number	Identifiant unique de l'evidence
`responseId`	number	ID de la réponse (utilisé pour approve/reject)
`uploadDate`	datetime	Date et heure du dépôt
`fileUUID`	string	UUID du fichier stocké
`fileName`	string	Nom du fichier original
`fileSize`	number	Taille du fichier en octets
`expirationDate`	datetime	Date d'expiration du document
`formdata`	array	Données du formulaire (si applicable)
`issuer`	string	Émetteur (DO = Data Owner)
`transmitter`	string	Transmetteur (FOURNISSEUR, etc.)
`metadata`	object	Métadonnées de vérification (IBAN, etc.)

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

Type	Description
`string`	Texte libre
`date`	Date au format JJ/MM/AAAA
`iban`	Coordonnées bancaires IBAN
`boolean`	Oui / Non
`number`	Valeur numérique

Télécharger un fichier

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

GET/api/v1/account/:accountId/dossiers/:dossierId/documents/:documentId/files/:fileId

Télécharge le fichier en binaire (PDF). Le fileId correspond à l<code>id</code> de levidence.

GET/api/v1/account/:accountId/dossiers/:dossierId/documents/:documentId/files/:fileId/link

Génère une URL signée temporaire pour le téléchargement.

GET/api/v1/account/:accountId/dossiers/:dossierId/files/download

Télécharge tous les fichiers du dossier dans une archive ZIP.

Actions sur un document

guides.conceptPages.document.actions.content

Identifiant responseId

Les actions utilisent le responseId présent dans l'objet evidence, et non le documentId.

Approuver un document

POST/api/v1/account/:accountId/responses/:responseId/approve

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"
  }'

Paramètre	Obligatoire	Description
`comment`	Non	Commentaire optionnel de validation

Rejeter un document

POST/api/v1/account/:accountId/responses/:responseId/reject

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
  }'

Paramètre	Obligatoire	Description
`comment`	Non	Motif du rejet
`shareRejectionReason`	Oui	Si `true`, le tiers est notifié par email du rejet

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).

POST/api/v1/account/:accountId/dossiers/:dossierId/requirements

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"
  }
}