Document & Evidence

A document is a request for supporting documentation. An evidence is the proof provided in response by the third party or an external source.

Definitions

Evidence Types

An evidence can take two forms depending on the type of document requested:

List Documents in a Dossier

Retrieve all requested documents in a dossier with their status and evidence.

Response Example

{
  "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": []
    }
  ]
}

Document Details

Retrieve detailed information about a specific document.

Evidence Structure

Each evidence contains metadata about the provided proof:

Data extracted from a document

Some supporting documents are read automatically by the platform, which pulls out the useful fields — the information carried by an insurance certificate, for instance. Those values are exposed on the evidence under aprovallCheck.extractedData, as a list of entries.

The structure of an entry

Each entry describes one field read from the document. The label is meant for display; name is what identifies the field reliably.

Sample response

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

Where to use it

The parameter is accepted on the five endpoints that return evidences:

Forms: formdata Structure

For form-type documents, the formdata array contains structured responses:

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

Field Types

Download a File

Multiple methods to retrieve evidence files:

Document Actions

When a document is in ACTION_REQUIRED status, you can approve or reject it via the API.

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

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

Add a Required Document

You can add additional documents to an existing dossier (except for typed dossiers where the list is fixed).

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

Automatic Verifications

Some documents undergo automatic verifications by Aprovall. Results are available in the evidence metadata field.

Example: IBAN Verification

For IBAN documents, verification may include SEPAmail or Trustpair data:

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

Next Steps

• Concepts: Status — Understanding status workflow
• Concepts: Dossier — Managing evaluation dossiers
• Concepts: Indicators — SmartPilot scores