Documentation API
Référence complète de l'API Aprovall EDGE. Explorez tous les endpoints disponibles.
Authenticate
/auth/realms/eat_realm/protocol/openid-connect/tokenAccount information
Informations about your e-Attestations Account and statistics like the number of thirdparties you monitore on e-Attestations
/api/v1/account/api/v1/account/{{account_id}}/api/v1/account/{{account_id}}/dossierTypes/api/v1/account/{{account_id}}/attributesRequirements
Account's requirements are the documents you are allowed to ask to your thirdpartis in your dossiers.
It depends on your e-Attestations configuration that you've designed with the help of you key account manager or automaticaly with your e-attestations subscription.
/api/v1/account/{{account_id}}/requirements/api/v1/account/{{account_id}}/dossiers/{{dossierId}}/requirementsThirdparties
Account's thirdparties list and details.
/api/v1/account/{{account_id}}/thirdparties/search/api/v1/account/{{account_id}}/thirdparties/api/v1/account/{{account_id}}/thirdparties/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/contacts/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/stop/api/v1/account/{{account_id}}/thirdparties/api/v1/account/{{account_id}}/thirdparties/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/calculated-attributes/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/indicators/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/scores/api/v1/account/{{account_id}}/legalstatus/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/historyDossiers
All account's dossiers.
The 'dossier' resource is the materialization of the client / third party relationship.
In the response :
monitored: active / inactive dossierstate: true for an active and complete dossierthirdpartyState: true for a registered userstateLastChangeDate: complete / incomplete date for an active dossier (null for an inative dossier)
/api/v1/account/{{account_id}}/dossiers/all/api/v1/account/{{account_id}}/dossiers/api/v1/account/{{account_id}}/dossiers/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributesDossiers creation & Processes
Dossier creation is an asynchronous process, you can find more details <a href="https://e-attestations.io/docs/t-1-create-dossier">here</a>
/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/dossiers/api/v1/account/{{account_id}}/dossiers/api/v1/account/{{account_id}}/dossiers/process/8af2b4a592fc4d0701930b248bc20000/api/v1/account/{{account_id}}/dossiers/processesDossiers updates
/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/stop/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/reactivate/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/requirements/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributesDossier's notes
Add notes on your dossier. They will be visible when you do a GET on a dossier.
/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/note/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/note/{{note_id}}Dossier's documents
/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}Dossier's Evidences & Files
get all evidences :
- a form filled
- a document fetched
- a document uploaded
Each evidence is a file ( binary file + informations).
/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/{{file_id}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/{{file_id}}/link/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/files/downloadDocuments
/api/v1/account/{{account_id}}/documents/searchDocuments actions
/api/v1/account/{{account_id}}/responses/{{responseId}}/approve/api/v1/account/{{account_id}}/responses/{{responseId}}/rejectAdvanced search
🔍 Advanced Search Endpoints
These three endpoints (thirdparties, dossiers, and documents advanced-search) allow you to perform complex multi-criteria searches with flexible filtering logic.
Filter Logic:
-
Within a single criteria object: All fields are combined with AND logic
- A result must match ALL specified criteria
-
Between multiple criteria objects: Results are combined with OR logic
- A result must match ANY of the criteria objects
Example:
{
"filter": {
"dossiers": [
{
"dossierType": "SUPPLY_CONTRACT",
"status": "VALID"
},
{
"dossierType": "PARTNERSHIP",
"status": "IN_PROGRESS"
}
]
}
}
This searches for:
-
Dossiers that are (type = SUPPLY_CONTRACT AND status = VALID)
-
OR
-
Dossiers that are (type = PARTNERSHIP AND status = IN_PROGRESS)
This flexible approach allows you to build complex queries that match your specific business needs.
/api/v1/account/{{account_id}}/thirdparties/advanced-search/api/v1/account/{{account_id}}/dossiers/advanced-search/api/v1/account/{{account_id}}/documents/advanced-searchErrors codes
Here are the HTTP Status Codes and Error Codes used by our API:
| HTTP Status Code | Description |
|---|---|
200 OK | Successful. |
400 Bad Request | In the API response, field which is missing or invalid will be emphasized. |
401 Unauthorized | The client passed in the invalid Auth token. Client should refresh the token and then try again. |
403 Forbidden | Access to this resource is forbidden in this context. |
404 Not Found | The ressource is missing. |
500 Internal Server Error | Servers are not working as expected. The request is probably valid but needs to be requested again later. |
In case you receive a 400 ou 500 Http Status Code, you will find in the response a custom error code which give more information on the error cause:
| Error code | Error description |
|---|---|
| E001 | Missing parameter |
| E002 | Unknown parameter |
| E003 | Empty parameter |
| E010 | Wrong format |
| E011 | Maximum size exceeded |
| E021 | Expiration date is in the past |
| E022 | Date in future |
| E030 | Invalid E-mail domain |
| E100 | No company matching your search |
| E101 | Error qualifying the company |
| E102 | Company does not exist |
| E103 | Company is closed |
| E104 | Too many companies for this criteria |
| E105 | Company ID has change to |
| E111 | Thirdparty code (supplierCode) is different regarding the existing one |
| E112 | Thirdparty code (supplierCode) is already used for another thirdparty |
| E113 | Thirdparty account disabled |
| E122 | Impossible to import an international company. 'The international' option is not activated. |
| E200 | No dossier matching your search |
| E201 | Dossier disabled |
| E202 | Reference exists for third party |
| E203 | No dossier with this reference |
| E204 | Dossier already enabled |
| E205 | Dossier is reactivated with a date in the past. You should modify the date. |
| E206 | Dossier type not found |
| E207 | Updating documents is forbidden on a typed dossier |
| E301 | Requirement disabled |
| E302 | Requirement not allowed |
| E303 | Requirement disabled from the dossier type |
| E304 | Requirement not allowed from the dossier type |
| E401 | Unauthorised to make request on your DnB account. |
| E402 | You have reach the request limit of your DnB account. |
| E1000 | Error during id encryption |
| E1001 | Error during id decryption |
| E1002 | SIREN or SIRET type must be used with FR countryCode |
| E1005 | Invalid value |
| E1006 | Service temporarily unavailable |