Documentation API

Référence complète de l'API Aprovall EDGE. Explorez tous les endpoints disponibles.

Authenticate

POST/auth/realms/eat_realm/protocol/openid-connect/token
Authenticate+

Account information

Informations about your e-Attestations Account and statistics like the number of thirdparties you monitore on e-Attestations

GET/api/v1/account
Account(s)+
GET/api/v1/account/{{account_id}}
Account statistics+
GET/api/v1/account/{{account_id}}/dossierTypes
Account dossier types list+
GET/api/v1/account/{{account_id}}/attributes
Account attributes+

Requirements

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.

GET/api/v1/account/{{account_id}}/requirements
Requirements for the account+
GET/api/v1/account/{{account_id}}/dossiers/{{dossierId}}/requirements
Requirements of one dossier+

Thirdparties

Account's thirdparties list and details.

POST/api/v1/account/{{account_id}}/thirdparties/search
Search for new thirdparty+
POST/api/v1/account/{{account_id}}/thirdparties
Append a new third party in my portfolio+
POST/api/v1/account/{{account_id}}/thirdparties
Append a new unmanaged third party in my portfolio+
PUT/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}
Update a thirdparty code+
POST/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes
Add or update a thirdparty attribute+
POST/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/contacts
Add un new thirdparty contact+
POST/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/stop
Archive a third party+
GET/api/v1/account/{{account_id}}/thirdparties
Account thirdparties+
GET/api/v1/account/{{account_id}}/thirdparties
Search for my account thirdparties by criterias+
GET/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}
Account thirdparthy details+
GET/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes
Account thirdparthy attributes+
GET/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/calculated-attributes
Account thirdparthy calculated attributes+
GET/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/indicators
Account thirdparthy indicators+
GET/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/scores
Account thirdparthy scores+
GET/api/v1/account/{{account_id}}/legalstatus
Account thirdparties legal informations+
GET/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/history
Account thirdparties location history+

Dossiers

All account's dossiers.

The 'dossier' resource is the materialization of the client / third party relationship.

In the response :

  • monitored : active / inactive dossier
  • state : true for an active and complete dossier
  • thirdpartyState : true for a registered user
  • stateLastChangeDate : complete / incomplete date for an active dossier (null for an inative dossier)
GET/api/v1/account/{{account_id}}/dossiers/all
Dossiers ALL+
GET/api/v1/account/{{account_id}}/dossiers
Dossiers+
GET/api/v1/account/{{account_id}}/dossiers
Dossiers by criterias+
GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}
Dossier details+
GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributes
Dossier attributes+

Dossiers 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>

POST/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/dossiers
Create new dossier (sync)+
POST/api/v1/account/{{account_id}}/dossiers
Deprecated - Create new dossier with third party identifier (async)+
GET/api/v1/account/{{account_id}}/dossiers/process/8af2b4a592fc4d0701930b248bc20000
Dossier creation : get process by id+
GET/api/v1/account/{{account_id}}/dossiers/processes
Dossier creation : get processes+

Dossiers updates

POST/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/stop
Stop one dossier+
POST/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/reactivate
Activate one dossier+
POST/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}
Update details of one dossier+
POST/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/requirements
Update requirements of one dossier+
POST/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributes
Add or update a dossier attribute+

Dossier's notes

Add notes on your dossier. They will be visible when you do a GET on a dossier.

POST/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/note
Create a note+
DELETE/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/note/{{note_id}}
Delete a note by id+

Dossier's documents

GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents
Documents+
GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}
Document details+
GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}
Document refused+

Dossier's Evidences & Files

get all evidences :

  • a form filled
  • a document fetched
  • a document uploaded

Each evidence is a file ( binary file + informations).

GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files
Evidences+
GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/{{file_id}}
File download (binary format)+
GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/{{file_id}}/link
File download Copy (auto signed URL)+
GET/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/files/download
File download all files for this dossier+

Documents

GET/api/v1/account/{{account_id}}/documents/search
Get documents informations+

Documents actions

POST/api/v1/account/{{account_id}}/responses/{{responseId}}/approve
Approve a document+
POST/api/v1/account/{{account_id}}/responses/{{responseId}}/reject
Refuse a document+

Errors codes

Here are the HTTP Status Codes and Error Codes used by our API:

HTTP Status CodeDescription
200 OKSuccessful.
400 Bad RequestIn the API response, field which is missing or invalid will be emphasized.
401 UnauthorizedThe client passed in the invalid Auth token. Client should refresh the token and then try again.
403 ForbiddenAccess to this resource is forbidden in this context.
404 Not FoundThe ressource is missing.
500 Internal Server ErrorServers 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 codeError description
E001Missing parameter
E002Unknown parameter
E003Empty parameter
E010Wrong format
E011Maximum size exceeded
E021Expiration date is in the past
E022Date in future
E030Invalid E-mail domain
E100No company matching your search
E101Error qualifying the company
E102Company does not exist
E103Company is closed
E104Too many companies for this criteria
E105Company ID has change to
E111Thirdparty code (supplierCode) is different regarding the existing one
E112Thirdparty code (supplierCode) is already used for another thirdparty
E113Thirdparty account disabled
E122Impossible to import an international company. 'The international' option is not activated.
E200No dossier matching your search
E201Dossier disabled
E202Reference exists for third party
E203No dossier with this reference
E204Dossier already enabled
E205Dossier is reactivated with a date in the past. You should modify the date.
E206Dossier type not found
E207Updating documents is forbidden on a typed dossier
E301Requirement disabled
E302Requirement not allowed
E303Requirement disabled from the dossier type
E304Requirement not allowed from the dossier type
E401Unauthorised to make request on your DnB account.
E402You have reach the request limit of your DnB account.
E1000Error during id encryption
E1001Error during id decryption
E1002SIREN or SIRET type must be used with FR countryCode
E1005Invalid value
E1006Service temporarily unavailable