Status

Quick Start

Create your first third-party and launch an evaluation in minutes.

Prerequisites

Before you begin, make sure you have:

Step 1: Add a Third-Party

Import a third-party into your portfolio using its legal identifier.

POST/api/v1/account/:accountId/thirdparties
curl -X POST https://edge.aprovall.com/api/v1/account/123/thirdparties \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "companyIdType": "CIT001",
    "companyIdValue": "50382936800010"
  }'

Identifier Types

companyIdTypeDescriptionExample
CIT001SIRET (French companies, 14 digits)50382936800010
CIT002EU VAT numberFR69503829368
CIT003DUNS number (9 digits)260004250

The response contains the created thirdpartyId, required for the following steps.

Step 2: Create an Evaluation Dossier

Launch an evaluation by creating a dossier for this third-party.

POST/api/v1/account/:accountId/thirdparties/:thirdpartyId/dossiers
curl -X POST https://edge.aprovall.com/api/v1/account/123/thirdparties/456/dossiers \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dossierTypeCode": "VIGILANCE"
  }'

The dossierTypeCode corresponds to a predefined dossier type: a set of documents to collect as part of the evaluation (report, form, professional qualification, etc.).

Step 3: Retrieve Dossier Information

Check the dossier status and document collection progress.

GET/api/v1/account/:accountId/dossiers/:dossierId
curl -X GET https://edge.aprovall.com/api/v1/account/123/dossiers/456 \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
Evaluation DossierAction Required
Third-partyAprovall
Creation Date15/01/2025
Collective ProcedureNo
Required Documents
Registration certificate
Compliant
Professional liability insurance certificate
Action Required
List of foreign employees
Compliant
Social compliance
Compliant

Next Steps