{"info":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","description":"

Aprovall 'EDGE' API, the restful API

https://developers.aprovall.com/

The REST / Json e-Attestations API is used to interface a client information system with the e-Attestations platform following the HTTP protocol.

Our APIs contain predictable resource-oriented URLs, accept request bodies encoded in [JSON] format , return encoded responses [JSON] and uses standard HTTP response codes, authentication and verbs.

'Client' applications using the Aprovall REST API enrich the Client Information System with the catalog of Aprovall data and services in a secure and very flexible manner.

The API can also be used by integrators, software publishers, SAAS solutions or connectors.

Postman collection

This collection of Postman scripts can ease testing phase.

Requests and Scenarios

We provide you with a set of requests for very common scenario you will find with the use of Aprovall EDGE API.

Of course they are quite simple examples.

For each endpoint, there are one or more examples, you can see theme on the right panel :

\n\n

More document evidences examples can be found in the Dossier's Evidences & Files Evidences section in this documentation : SIS-ID, Trustpair etc.
Indeed, automatic processing provides additional information :

\n\n

Feel free to contact us for more advanced questions.

Postman environment and variables

All requests will fetch a new access_token automatically based on variables in your Postman environment.

This collection use a script that will automatic fetches for you :

access_token : the JWT access token needed for each request
\n
account_id : the first account found in account_ids from the JWT
\n

This 2 variables are mandatory and generated automatically for each request.

You can swicth from environment to another and load values for the following variables.

username : your username
\n
password : your password
\n
ea_auth_serv : the url for e-Attestations authorizer
\n
ea_api_serv : the url for API services
\n

This credentials are provided by e-Attestations. Please contact us : https://developers.aprovall.com/contact

Quick start

Download this Postman collection :

\n\n

Select the Aprovall environment (EA-Production) and fill your username and password in the environment variables section :

\n\n

You can test your integration by using a test environment ( contact e-Attestations API Manager by email if you need it). To do so, you have to configure a new Postman environement :

\n\n

ea_auth_serv : https://auth.e-attestations.com to https://auth.test-e-attestations.com
ea_api_serv : https://edge.e-attestations.com to https://edge.test-e-attestations.com
username and password for the demo environement ( provided by Aprovall)

\n\n

Now, you can test all endpoints and switch from one environment to another

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Aprovall 'EDGE' API, the restful API","slug":"aprovall-edge-api-the-restful-api"}],"owner":"2727694","collectionId":"09c3026f-15d2-437f-98f1-db710241baa9","publishedId":"Tz5ndeyb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-19T17:54:22.000Z"},"item":[{"name":"Authenticate","item":[{"name":"Authenticate","event":[{"listen":"test","script":{"id":"c34f886a-68ed-4697-80cb-4987e0b36885","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"token\", jsonData.access_token);","pm.environment.set(\"processId\", \"\");","pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.response.to.not.be.error;","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7f6bbdbd-c406-4c06-a14d-be0bd52807eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"ea-api-edge","type":"text"},{"key":"username","value":"{{username}}","type":"text"},{"key":"password","value":"{{password}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}]},"url":"{{ea_auth_serv}}/auth/realms/eat_realm/protocol/openid-connect/token","description":"

Authenticate to the API

To use our API, you must first authenticate via OAuth 2.0 using the Resource Owner Password Credentials (ROPC) grant.

Upon successful authentication, the server returns a JWT (JSON Web Token) that must be included in all subsequent API requests.

Security

The JWT is signed using RSA256 (asymmetric key), allowing the server to verify token authenticity
\n
Tokens have a limited lifetime, indicated by the expires_in field (in seconds)
\n
Use the refresh_token to obtain a new access token without re-entering credentials
\n

Get a JWT access token

Send a POST request with your credentials to the authentication server:

POST https://auth.e-attestations.com/auth/realms/eat_realm/protocol/openid-connect/token\nContent-Type: application/x-www-form-urlencoded\ngrant_type=password\nclient_id=ea-api-edge\nusername=<your-username>\npassword=<your-password>\n\n

The server returns a JWT access token along with a refresh token.

Use the token

Include the access token in the Authorization header for all API requests:

Authorization: Bearer <access_token>\n\n

Refresh the token

To obtain a new access token using the refresh token:

POST https://auth.e-attestations.com/auth/realms/eat_realm/protocol/openid-connect/token\nContent-Type: application/x-www-form-urlencoded\ngrant_type=refresh_token\nclient_id=ea-api-edge\nrefresh_token=<your-refresh-token>\n\n

GET a request for the default account

\n","urlObject":{"path":["api","v1","account"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"0bb38faf-b054-4824-9e87-5899a853d2e9","name":"Account(s)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 23 Sep 2020 14:21:08 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 119631,\n \"creation\": \"2015-04-02T10:56:07.736\",\n \"account\": \"CPTDO2E2FFC774EDD6637F\",\n \"name\": \"Compte Test\",\n \"company\": \"Compte Test\",\n \"maxDossiers\": 10,\n \"subscriptionDate\": \"2019-05-24T13:01:31.514\",\n \"subscriptionStatus\": \"ACTIVE\",\n \"subscriptions\": [\n {\n \"accountId\": 119631,\n \"key\": \"APIEDGE\",\n \"endSubscriptionDate\": null,\n \"startSubscriptionDate\": \"2019-05-24T13:01:31.514\",\n \"status\": \"ACTIVE\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"02305e9f-2eba-479f-92bd-023442fd9b43"},{"name":"Account statistics","event":[{"listen":"test","script":{"id":"67e1a59c-1790-4d2b-ae36-78101b13c218","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"3654919c-7148-4d29-8940-6408a5820adf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}","description":"

Requests one account's detailed statistics and indicators.\nIndicator \"I001\" correspond to dossiers related to undeclared work reglementation.

\n","urlObject":{"path":["api","v1","account","{{account_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"16d5d99c-6fdd-46b1-a07d-aa6fb6dcc571","name":"Account statistics","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 23 Sep 2020 14:22:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"accountId\": 119631,\n \"numberOfThirdparties\": 22,\n \"numberOfCompleteDossiers\": 7,\n \"numberOfCompleteThirdparties\": 9,\n \"numberOfDossiers\": 41,\n \"numberOfSubscribedThirdparties\": 14,\n \"listIndicatorsStatistics\": [\n {\n \"indicatorCode\": \"I001\",\n \"numberOfDossiers\": 11,\n \"numberOfSubscribedThirdparties\": 7,\n \"numberOfCompleteDossiers\": 5,\n \"numberOfCompleteThirdparties\": 1,\n \"numberOfThirdparties\": 7\n }\n ]\n }\n}"}],"_postman_id":"3654919c-7148-4d29-8940-6408a5820adf"},{"name":"Account dossier types list","event":[{"listen":"test","script":{"id":"67e1a59c-1790-4d2b-ae36-78101b13c218","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"999a5558-0dd9-4556-993e-f3a3cf86376e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossierTypes","description":"

Requests one account's dossier types.

A dossier type is a defined set of documents that you can attach to a dossier to manage your requirements more easily.

To create and manage your dossier types, please contact your key account manager.

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossierTypes"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"9708270d-aa01-4038-93bf-26d12d5311a0","name":"Reponse","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossierTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 23 Sep 2020 14:22:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 1,\n \"code\": \"TESTRIB\",\n \"libelle\": \"TEST RIB\",\n \"requirements\": [\n {\n \"documentId\": 49,\n \"accountId\": 119631,\n \"code\": \"RIB_IBAN\",\n \"name\": \"InternationalBankAccountNumberIBAN\",\n \"descriptionCategoryFr\": \"COORDONNEES BANCAIRES\",\n \"descriptionCategoryEn\": \"BANK ACCOUNT\",\n \"descriptionFr\": \"Coordonnées bancaires\",\n \"descriptionEn\": \"International Bank Account Number (IBAN)\"\n }\n ]\n },\n {\n \"id\": 2,\n \"code\": \"TEST LSE\",\n \"libelle\": \"TESTLSE\",\n \"requirements\": [\n {\n \"documentId\": 5,\n \"accountId\": 119631,\n \"code\": \"LST_SAL_ETR\",\n \"name\": \"Autorisationsdetravail\",\n \"descriptionCategoryFr\": \"TRAVAIL DISSIMULE\",\n \"descriptionCategoryEn\": \"ILLEGAL WORK\",\n \"descriptionFr\": \"Liste nominative des salariés étrangers soumis à autorisation de travail\",\n \"descriptionEn\": \"List of names of posted workers subjected to work permit\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"999a5558-0dd9-4556-993e-f3a3cf86376e"},{"name":"Account attributes","id":"b011dc9e-f940-4dab-9a40-a19a231cab58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/attributes?bondType=thirdparty","description":"

Get all account attributes.

An attribute is linked to a third party or un dossier (a set of documents)

The bondType query param determine the attribute type :

thirdparty : for third party attributes
\n
dossier : for dossier attributes
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9162e053-e9d8-41dc-8f5c-9e94521eeecb","id":"9162e053-e9d8-41dc-8f5c-9e94521eeecb","name":"Account information","type":"folder"}},"urlObject":{"path":["api","v1","account","{{account_id}}","attributes"],"host":["{{ea_api_serv}}"],"query":[{"key":"bondType","value":"thirdparty"}],"variable":[]}},"response":[{"id":"c63d641a-a305-4ec5-abee-5fcbf0913d20","name":"Account attributes","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/attributes?bondType=thirdparty","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","attributes"],"query":[{"key":"bondType","value":"thirdparty"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 800,\n \"accountId\": 111,\n \"type\": \"boolean\",\n \"bondType\": \"thirdparty\",\n \"label\": \"STRATEGIC\",\n \"creationDate\": \"2024-02-29T14:54:09.677+00:00\"\n },\n {\n \"id\": 801,\n \"accountId\": 111,\n \"type\": \"date\",\n \"bondType\": \"thirdparty\",\n \"label\": \"CONTACT_DATE\",\n \"creationDate\": \"2024-02-29T14:54:20.389+00:00\"\n },\n {\n \"id\": 884,\n \"accountId\": 111,\n \"type\": \"percentage\",\n \"bondType\": \"thirdparty\",\n \"label\": \"PERCENTAGE_ATTRIBUTE\",\n \"creationDate\": \"2024-06-10T16:53:05.625+00:00\"\n },\n {\n \"id\": 912,\n \"accountId\": 111,\n \"type\": \"decimal\",\n \"bondType\": \"thirdparty\",\n \"label\": \"TURNOVER_LAST_YEAR\",\n \"creationDate\": \"2024-07-31T12:37:57.565+00:00\"\n },\n {\n \"id\": 913,\n \"accountId\": 111,\n \"type\": \"list_unique\",\n \"bondType\": \"thirdparty\",\n \"label\": \"REGION\",\n \"creationDate\": \"2024-07-31T12:38:29.522+00:00\",\n \"values\": [\n {\n \"id\": 2952,\n \"value\": \"Option_1\"\n },\n {\n \"id\": 2953,\n \"value\": \"Option_2\"\n },\n {\n \"id\": 2954,\n \"value\": \"Option_3\"\n }\n ]\n },\n {\n \"id\": 916,\n \"accountId\": 111,\n \"type\": \"string\",\n \"bondType\": \"thirdparty\",\n \"label\": \"CATEGORY\",\n \"creationDate\": \"2024-08-09T13:20:19.297+00:00\"\n },\n {\n \"id\": 921,\n \"accountId\": 111,\n \"type\": \"list_multiple\",\n \"bondType\": \"thirdparty\",\n \"label\": \"RISK\",\n \"creationDate\": \"2024-09-03T07:45:52.709+00:00\",\n \"values\": [\n {\n \"id\": 2958,\n \"value\": \"High\"\n },\n {\n \"id\": 2959,\n \"value\": \"Moderate\"\n },\n {\n \"id\": 2960,\n \"value\": \"Low\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"b011dc9e-f940-4dab-9a40-a19a231cab58"}],"id":"9162e053-e9d8-41dc-8f5c-9e94521eeecb","description":"

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

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3006af65-21e6-4e82-8770-96e2401d12eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"acc41080-33c1-4dad-a1e2-e3c0f9b057d4","type":"text/javascript","exec":[""]}}],"_postman_id":"9162e053-e9d8-41dc-8f5c-9e94521eeecb"},{"name":"Requirements","item":[{"name":"Requirements for the account","event":[{"listen":"test","script":{"id":"cde92c9a-8b5a-4cb4-bcaa-b16544dddddf","exec":["pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.response.to.not.be.error;","});","","// getting Requirements from response json","var codes = pm.response.json().content.map(req => req[\"code\"]);","console.log(codes);","pm.test(\"Verify the contents of the response contains some requirements\", function () { "," pm.expect(codes).to.include(\"ATT_VIGI\");"," pm.expect(codes).to.include(\"JUSTIF_IMM\");"," pm.expect(codes).to.include(\"LST_SAL_ETR\");","});","",""],"type":"text/javascript"}}],"id":"0ce19dfd-f40a-488e-8137-3ff29ff0cbec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/requirements","description":"

Request account's allowed requierements which are the documents that you can use to compose dossiers.

\n","urlObject":{"path":["api","v1","account","{{account_id}}","requirements"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"0129f987-259d-4296-94c9-0eaf98a3a5a7","name":"Requirements for the account","originalRequest":{"method":"GET","header":[],"url":"https://edge.qa-e-attestations.com/api/v1/account/119631/requirements"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"documentId\": 1,\n \"accountId\": 119631,\n \"code\": \"ATT_VIGI\",\n \"name\": \"Attestationdevigilance6mois\",\n \"descriptionCategoryFr\": \"TRAVAIL DISSIMULE\",\n \"descriptionCategoryEn\": \"ILLEGAL WORK\",\n \"descriptionFr\": \"Attestation de vigilance (6 mois)\",\n \"descriptionEn\": \"Attestation de vigilance (6 mois)\"\n },\n {\n \"documentId\": 5,\n \"accountId\": 119631,\n \"code\": \"LST_SAL_ETR\",\n \"name\": \"Autorisationsdetravail\",\n \"descriptionCategoryFr\": \"TRAVAIL DISSIMULE\",\n \"descriptionCategoryEn\": \"ILLEGAL WORK\",\n \"descriptionFr\": \"Liste nominative des salariés étrangers soumis à autorisation de travail\",\n \"descriptionEn\": \"List of names of posted workers subjected to work permit\"\n },\n {\n \"documentId\": 49,\n \"accountId\": 119631,\n \"code\": \"RIB_IBAN\",\n \"name\": \"InternationalBankAccountNumberIBAN\",\n \"descriptionCategoryFr\": \"COORDONNEES BANCAIRES\",\n \"descriptionCategoryEn\": \"IBAN\",\n \"descriptionFr\": \"Coordonnées bancaires - RIB\",\n \"descriptionEn\": \"International Bank Account Number (IBAN)\"\n }\n ]\n}"}],"_postman_id":"0ce19dfd-f40a-488e-8137-3ff29ff0cbec"},{"name":"Requirements of one dossier","event":[{"listen":"test","script":{"id":"db1407be-480a-4028-b066-58a5e27d61f9","exec":["pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.response.to.not.be.error;","});","","// getting Requirements from response json","var codes = pm.response.json().content.map(req => req[\"code\"]);","console.log(codes);","pm.test(\"Verify the contents of the response contains some requirements\", function () { "," console.log(codes)"," pm.expect(codes).to.include(\"ADO\");"," pm.expect(codes).to.include(\"JUSTIF_IMM\");"," //pm.expect(codes).to.include(\"LST_SAL_ETR\");","});","",""],"type":"text/javascript"}}],"id":"da6aee50-94f6-4d8f-993f-37a79067e5bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossierId}}/requirements","description":"

Request one dossier's requirements/allowed documents to use in account's dossiers

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossierId}}","requirements"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"d38cfde7-0415-40b7-8ac7-ee3cba903637","name":"Requirements of one dossier (840158)","originalRequest":{"method":"GET","header":[],"url":"https://edge.qa-e-attestations.com/api/v1/account/119631/dossiers/840158/requirements"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"documentId\": 105,\n \"accountId\": 119631,\n \"code\": \"I9\",\n \"name\": \"Certificat ISO 9001\",\n \"nameEn\": \"ISO 9001 certification\",\n \"dossierId\": 840158\n },\n {\n \"documentId\": 1024,\n \"accountId\": 119631,\n \"code\": \"VT\",\n \"name\": \"Vincent teste\",\n \"nameEn\": \"Vincent teste\",\n \"dossierId\": 840158\n },\n {\n \"documentId\": 2,\n \"accountId\": 119631,\n \"code\": \"JUSTIF_IMM\",\n \"name\": \"Justificatif d’immatriculation\",\n \"nameEn\": \"Justificatif d’immatriculation\",\n \"dossierId\": 840158\n },\n {\n \"documentId\": 194,\n \"accountId\": 119631,\n \"code\": \"ADO\",\n \"name\": \"Attestation d'inscription ORIAS\",\n \"nameEn\": \"Attestation d'inscription ORIAS\",\n \"dossierId\": 840158\n },\n {\n \"documentId\": 135,\n \"accountId\": 119631,\n \"code\": \"CDSCP\",\n \"name\": \"Contrat de sous-traitance QOVANS SERVICES\",\n \"nameEn\": \"Contrat de sous-traitance QOVANS SERVICES\",\n \"dossierId\": 840158\n },\n {\n \"documentId\": 470,\n \"accountId\": 119631,\n \"code\": \"TDCDDTEMP(\",\n \"name\": \"Attestation CARSAT accidents du travail et maladies professionnelles (AT/MP)\",\n \"nameEn\": \"Attestation CARSAT accidents du travail et maladies professionnelles (AT/MP)\",\n \"dossierId\": 840158\n }\n ]\n}"}],"_postman_id":"da6aee50-94f6-4d8f-993f-37a79067e5bf"}],"id":"d04be594-f0bb-4a1d-9e2b-5c97b5aaf574","description":"

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.

\n","event":[{"listen":"prerequest","script":{"id":"22397320-4182-46ab-b0c4-3595a4538636","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cb66eb54-6245-421d-b39b-785d16a752d7","type":"text/javascript","exec":[""]}}],"_postman_id":"d04be594-f0bb-4a1d-9e2b-5c97b5aaf574","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Thirdparties","item":[{"name":"Search for new thirdparty","event":[{"listen":"test","script":{"id":"d534c37b-6487-41bc-9419-5942bb2494de","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"thirdpartyId\", jsonData.content[0].thirdpartyId);","","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript","packages":{}}}],"id":"83864301-967e-4baf-850e-1f423ddd7e11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"FR\",\n \"searchBy\": \"VAT\",\n \"value\": \"FR69503829368\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/search","description":"

Before creating a new dossier, you have to know a third party identifier : VAT number, DUNS etc.

This endpoint allows you to search for third party with different methods :

Parameter	Type	Description
countryCode\\\\\\*	string (2-alpha code)	ISO 3166 country code. List here : https://developers.aprovall.com/guides/dictionary/countriesExample : \"FR\", \"US\"
searchBy\\\\\\*	string	This parameter must be one of the following values : NAME : Search by thirdparty name DUNS : Dun & Bradstreet identifier SIRET : 14 digit number referring to your business location (SIREN + 5 digits). countryCode must be `FR` SIREN : unique French business identification number (9 digits). countryCode must be `FR` VAT : identifier used in many countries, including the countries of the European Union. LOCAL_ID : local identifier for a specified country
value\\\\\\*	string	value of the previously chosen type (`searchBy`) : DUNS, SIRET, SIREN, VAT, LOCAL_ID or NAME

\n\n

In the JSON response :

monitored : true for a followed third party, which have at least one active dossier in this account
\n
present : true for a third party, already followed by e-Attestations
\n
isIdEncrypted : true : for a non-french third party, without providing a DUNS number. If true, the DUNS number will be encrypted
\n
id : may be :
\n
- a SIRET number for a french third party
- a DUNS number (if specified) for a non-french third party,
- an encrypted DUNS for a non-french third party without providing DUNS number.

Possibles 400 errors :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
E1002	SIREN or SIRET type must be used with FR countryCode
E1004	Impossible to import a french third party with local ID. Use SIRET or SIREN instead
E1005	Invalid value
E1006	Service temporarily unavailable

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","search"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"32ca4d68-3ebb-462c-bfc0-a784a4ddce07","name":"Search by name","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"BE\",\n \"searchBy\" : \"NAME\",\n \"value\" : \"COCA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://edge.qa-e-attestations.com/api/v1/account/119631/thirdparties/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"monitored\": true,\n \"present\": false,\n \"name\": \"Cok Evelyn\",\n \"addressStreet\": \"Sint-Amandsplein 5\",\n \"addressCity\": \"Grimbergen (Strombeek-Bever )\",\n \"addressPostCode\": \"1853\",\n \"headquarter\": true,\n \"id\": \"u486vsDrNDWh4G2TyQ5Cyw==\",\n \"isIdEncrypted\": true,\n \"localIdValue\": \"0683869999\",\n \"localIdType\": \"BE_ENTERPRISE_NUMBER\",\n \"website\": null,\n \"isdCode\": null,\n \"nationalPhone\": \"049999999999\",\n \"activityCode\": null,\n \"activityLabel\": null,\n \"source\": \"DNB\",\n \"thirdPartyId\": 491345,\n \"registrationNumbers\": [\n {\n \"number\": \"0683869999\",\n \"code\": 800,\n \"libelle\": \"Enterprise Number (BE)\"\n }\n ]\n },\n {\n \"monitored\": false,\n \"present\": false,\n \"name\": \"Coca-Cola European Partners Belgium\",\n \"addressStreet\": \"Chaussée de Mons 1424\",\n \"addressCity\": \"Bruxelles\",\n \"addressPostCode\": \"1070\",\n \"headquarter\": true,\n \"id\": \"QG4fRP+kZektI+VlJup5lA==\",\n \"isIdEncrypted\": true,\n \"localIdValue\": \"BE0425079999\",\n \"localIdType\": \"BE_VAT_NUMBER\",\n \"website\": null,\n \"isdCode\": null,\n \"nationalPhone\": \"0299999999\",\n \"activityCode\": null,\n \"activityLabel\": null,\n \"source\": \"DNB\",\n \"thirdPartyId\": null,\n \"registrationNumbers\": [\n {\n \"number\": \"BE0425079999\",\n \"code\": 99,\n \"libelle\": \"Value Added Tax Number (BE)\"\n }\n ]\n }\n]"},{"id":"280d67d0-a964-4dde-8086-768e207a5868","name":"Search by SIRET","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"FR\",\n \"searchBy\" : \"SIRET\",\n \"value\" : \"50382936800045\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"monitored\": true,\n \"present\": false,\n \"name\": \"E-ATTESTATIONS.COM\",\n \"addressStreet\": \"2 RUE DU CHEMIN DES FEMMES\",\n \"addressCity\": \"MASSY\",\n \"addressPostCode\": \"91300\",\n \"headquarter\": true,\n \"id\": \"50382936800045\",\n \"isIdEncrypted\": false,\n \"localIdValue\": \"50382936800045\",\n \"localIdType\": \"FRANCE_SIRET_NUMBER\",\n \"website\": null,\n \"isdCode\": null,\n \"nationalPhone\": null,\n \"activityCode\": \"5829C\",\n \"activityLabel\": \"Edition de logiciels applicatifs\",\n \"source\": \"ALTARES\",\n \"thirdPartyId\": 875,\n \"registrationNumbers\": []\n }\n]"},{"id":"23858728-004a-447a-b8e6-798df433f01f","name":"Search by VAT","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"FR\",\n \"searchBy\" : \"SIRET\",\n \"value\" : \"50382936800045\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"monitored\": true,\n \"present\": false,\n \"name\": \"Cammaert Elastische Voegwerken Renovatie\",\n \"addressStreet\": \"Galgenbergstraat 50, Internal Mail Reference A\",\n \"addressCity\": \"Berlare\",\n \"addressPostCode\": \"9290\",\n \"headquarter\": true,\n \"id\": \"ICLv2ewmE6fXsAw1dmgGRA==\",\n \"isIdEncrypted\": true,\n \"localIdValue\": \"BE0423924840\",\n \"localIdType\": \"BE_VAT_NUMBER\",\n \"website\": null,\n \"isdCode\": null,\n \"nationalPhone\": \"052999999\",\n \"activityCode\": null,\n \"activityLabel\": null,\n \"source\": \"DNB\",\n \"thirdPartyId\": 445308,\n \"registrationNumbers\": [\n {\n \"number\": \"BE0423924840\",\n \"code\": 99,\n \"libelle\": \"Value Added Tax Number (BE)\"\n }\n ]\n }\n]"},{"id":"835984a6-6efe-4769-ba2c-4fdeaa623e98","name":"Error 400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"countryCode\": \"BLABLABLA\",\n \"searchBy\": \"NAME\",\n \"value\": \"EMERIA\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 13:19:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": {\n \"error\": [\n {\n \"code\": \"E1006\",\n \"message\": \"Service temporarily unavailable \",\n \"request\": null,\n \"reason\": null\n }\n ]\n }\n}"}],"_postman_id":"83864301-967e-4baf-850e-1f423ddd7e11"},{"name":"Append a new third party in my portfolio","id":"639cad99-6e3d-4f11-ab70-d8ab06b80ce7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\":\"CIT001\",\n \"companyIdValue\":\"50382936800052\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties","description":"

Import a new third party in my porffolio

The body contains several attributes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Mandatory	Type	Description
companyIdType	yes	String	CIT001 for a SIRET number (french companies), composed of 14 numbers. Ex : 50382936800045 CIT002 for an intra-community VAT number, composed of two letters (country code), followed by numbers. Ex : FR69503829368 CIT003 for a DUNS number, composed of 9 numbers. Ex : 260004250. Or you can use an encrypted DUNS, found by using the Thirdparties Search for new thirdparty endpoint
companyIdValue	yes	String	SIRET, TVA or DUNS value
companyIdEncrypted	no	Boolean	true for encrypted DUNS, fetched with Thirdparties Search for new thirdparty endpoint. This parameter is optional and is false by default. If you know the DUNS number, skip this parameter. companyIdType must be CIT003
thirdpartyCode	no	String	A reference code from an external system or database. If a third party code already exists (set in another dossier), let this field empty

List of error codes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Error description
E001	Missing parameter
E002	Unknown parameter
E003	Empty parameter
E010	Wrong format
E030	Invalid E-mail domain
E101	Error qualifying the company
E102	Company does not exist
E103	Company is closed
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.
E202	Reference exists for third party
E1002	SIREN or SIRET type must be used with FR countryCode
E1003	Impossible to import a french third party with a VAT number. Use SIRET or SIREN instead
E1004	Impossible to import a french third party with local ID. Use SIRET or SIREN instead
E1005	Invalid value
E1006	Service temporarily unavailable

Import a third party manually without linking it to an external business registry such as Altares or Dun & Bradstreet (D&B).

Only use this endpoint if the third party does not exist in Altares or DNB registries (CIT001, CIT002, CIT003).

The body contains several attributes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Mandatory	Type	Description
companyIdType	yes	String	CIT004
unmanagedSupplierInformation	yes	JSON object	third party informations

unmanagedSupplierInformation :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Mandatory	Type	Description
name	yes	String	CIT004
addressCity	yes	JSON object	City
addressCountryCode	yes	String	ISO country code (e.g., FR, US). See all countries code here : https://developers.aprovall.com/guides/dictionary/countries
addressPostCode	yes	String	Postal/ZIP code
addressStreet	yes	String	Street address
capital	no	String	Share capital amount
capitalCurrency	no	String	Currency code (e.g., EUR, USD). See all currencies code here : https://developers.aprovall.com/guides/dictionary/currencies
category	no	String	Values: PME (Small/Medium), ETI (Mid-sized), GE (Large)
companyIdValue	no	String	Company identifier (e.g., SIRET, VAT etc)
etabActivityCode	yes	String	Activity code from a specific list : https://developers.aprovall.com/guides/dictionary/activities
headquarter	yes	Boolean	HQ or not
legalCategoryCode	no	String	Legal form code from a specific list : https://developers.aprovall.com/guides/dictionary/legal-categories

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"c33efa47-2764-4f77-bed0-72126f6ca8fa","name":"Append a new unmanaged third party in my portfolio","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\":\"CIT004\",\n \"unmanagedSupplierInformation\":{\n \"etabActivityCode\":\"011\",\n \"addressStreet\":\"2 rue de la Gare\",\n \"capital\":\"1000\",\n \"addressCountryCode\":\"FR\",\n \"headquarter\":true,\n \"companyIdValue\":\"123456789\",\n \"legalCategoryCode\":\"1000\",\n \"addressPostCode\":\"58745\",\n \"name\":\"My third party\",\n \"category\":\"PME\",\n \"addressCity\":\"CLAM\",\n \"capitalCurrency\":\"EUR\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"content\": {\n \"authorizingRoles\": [],\n \"thirdpartyId\": 516873,\n \"accountId\": 15601,\n \"companyIdType\": \"CIT004\",\n \"siret\": null,\n \"localIdValue\": null,\n \"localIdType\": null,\n \"siren\": null,\n \"tva\": null,\n \"duns\": null,\n \"dateCreation\": \"2026-01-29\",\n \"companyStartDate\": null,\n \"followingDate\": \"2026-01-29\",\n \"legalCategoryLabel\": \"Entrepreneur individuel\",\n \"legalCategoryCode\": \"1000\",\n \"acronym\": null,\n \"brandName\": null,\n \"addressingName\": null,\n \"activityLabel\": \"Cash grains\",\n \"activityCode\": \"011\",\n \"etabActivityCode\": \"011\",\n \"etabActivityType\": \"SIC\",\n \"etabActivityLabel\": \"Cash grains\",\n \"ceo\": null,\n \"principals\": [],\n \"capital\": 1000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": null,\n \"turnoverCurrency\": null,\n \"lastBalanceSheetDate\": null,\n \"workforce\": null,\n \"companyIdValue\": \"123456789\",\n \"thirdpartyCode\": null,\n \"monitored\": false,\n \"onboarded\": true,\n \"stoppingDate\": null,\n \"stoppingReason\": null,\n \"isMonitored\": \"false\",\n \"name\": \"MY THIRD PARTY\",\n \"addressStreet\": \"2 rue de la Gare\",\n \"addressCity\": \"CLAM\",\n \"addressPostCode\": \"58745\",\n \"addressCountryCode\": \"FR\",\n \"additionalAddressDetails\": null,\n \"province\": null,\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"registered\": false,\n \"isRegistered\": \"false\",\n \"registrationDate\": null,\n \"active\": true,\n \"isActive\": \"true\",\n \"outOfBusiness\": false,\n \"isOutOfBusiness\": \"false\",\n \"stateLastChangeDate\": \"2026-01-29\",\n \"complete\": null,\n \"isComplete\": \"n/a\",\n \"category\": \"PME\",\n \"subCategory\": null,\n \"thirdpartyAlerts\": null,\n \"totalDossiers\": 0,\n \"thirdpartyUsers\": [],\n \"listRegistrationNumber\": [],\n \"lastStateSuivi\": null,\n \"financialHistory\": null,\n \"hasRestrictedDisclosure\": false,\n \"dunsEncrypted\": false\n }\n}"}],"_postman_id":"af068aee-fd66-406e-aa87-38ca50a9db77"},{"name":"Update a thirdparty code","id":"3bb85660-821a-4b68-8bfa-ff3115f231e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"supplierCode\": \"NEW_SUPPLIER_CODE_1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}","description":"

Modify a thirdparty code ( or supplier code)

This code must be unique

Possible 400 errors :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
E001	Missing parameter supplierCode
E011	Maximum size exceeded
E112	Thirdparty code (supplierCode) is already used for another thirdparty

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"f75c2d6a-b66d-4715-b3a0-3364157fb833","name":"Update a thirdparty code","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\":\"CIT001\",\n \"companyIdValue\":\"50382936800052\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"fc5416d2-2b13-4e88-b7be-e3482cc139fb","name":"Error 404 : Third party not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"test\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:13:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/1581809/attributes;client=10.114.1.144;user=aaa@e-attestations.com\",\n \"reason\": \"404 : [{\\\"timestamp\\\":\\\"2024-11-08T10:13:40.417+00:00\\\",\\\"status\\\":404,\\\"error\\\":\\\"Not Found\\\",\\\"message\\\":\\\"\\\",\\\"path\\\":\\\"/api/account/15601/dossier/1581809/attributes\\\"}]\"\n }\n ]\n}"},{"id":"09f2a7d0-3b92-4b61-b615-1e8f381caa7b","name":"Error 400","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 13:08:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": {\n \"error\": [\n {\n \"code\": \"E001\",\n \"message\": \"Missing parameter (thirdpartyCode)\",\n \"request\": null,\n \"reason\": null\n }\n ]\n }\n}"}],"_postman_id":"3bb85660-821a-4b68-8bfa-ff3115f231e0"},{"name":"Add or update a thirdparty attribute","id":"a08292bd-4c24-417b-964e-d2be501605e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"4. Purchase Annual Amount\",\n \"values\":[\"+5K€\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes","description":"

Add or update a thirdparty attribute.

label : attribute name, you can find this name by using the following endpoint : Account attributes
\n
values : an array of values, multiples values can be added a list_multiple attribute type
\n

Il you want to set an empty value, you can set the following value : \"values\":[null]

Possible 400 errors codes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
E001	Missing parameter
E011	For non multiple attribute, juste one value must be present in the values array

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","attributes"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"4e1bbc06-f8a3-4da8-8d84-f7556c2401f3","name":"Add or update a thirdparty attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"4. Purchase Annual Amount\",\n \"values\":[\"+5K€\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"2b90a3d7-9ec5-4baa-8bab-71d8387f1340","name":"Errors 400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"test\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:12:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": {\n \"error\": [\n {\n \"code\": \"E010\",\n \"message\": \"Wrong format (values/Should be one or multiple of the following values [aaa, aaaa].)\",\n \"request\": null,\n \"reason\": null\n }\n ]\n }\n}"},{"id":"9bada612-cfda-49dd-9d88-26c87d10656c","name":"Error 404 : Third party or attribute label not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"test\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:13:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/1581809/attributes;client=10.114.1.144;user=aaa@e-attestations.com\",\n \"reason\": \"404 : [{\\\"timestamp\\\":\\\"2024-11-08T10:13:40.417+00:00\\\",\\\"status\\\":404,\\\"error\\\":\\\"Not Found\\\",\\\"message\\\":\\\"\\\",\\\"path\\\":\\\"/api/account/15601/dossier/1581809/attributes\\\"}]\"\n }\n ]\n}"}],"_postman_id":"a08292bd-4c24-417b-964e-d2be501605e0"},{"name":"Add un new thirdparty contact","id":"be930c43-e2fb-4d1a-9592-73110261ed3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\" : \"email@domain.com\",\n \"lang\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/contacts","description":"

Invite a new contact for a specific third party

lang parameter can take the following values :

en : english
\n
fr : french
\n
es : spanish
\n
de : german
\n
it : italian
\n
pt : portuguese
\n
nl : dutch
\n

An invitation email will be send in this lang

Possible 400 errors

\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
E1005	Invalid value (Invalid email address)

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","contacts"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"f5b98965-a7d5-4f86-bd5d-dfadd6c0c3dd","name":"Add un new thirdparty contact","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\" : \"email@domain.com\",\n \"lang\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"6fb3c331-033c-402c-9848-621b4d308868","name":"Error 400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\" : \"emaidain.com\",\n \"lang\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/contacts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 12:53:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": {\n \"error\": [\n {\n \"code\": \"E1005\",\n \"message\": \"Invalid value (Invalid email address)\",\n \"request\": null,\n \"reason\": null\n }\n ]\n }\n}"}],"_postman_id":"be930c43-e2fb-4d1a-9592-73110261ed3c"},{"name":"Archive a third party","id":"b8210e23-3bf2-425c-9f3a-de1363853510","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deactivationReason\":\"we no longer work with this thirdparty\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/stop","description":"

Archive a new third party in my porffolio

The body contains several attributes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Mandatory	Type	Description
deactivationReason	no	String	Reason for third-party deactivation

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","stop"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"93712183-6958-4248-aa7a-3c753e5a9bd2","name":"Archive a third party","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deactivationReason\":\"we no longer work with this thirdparty\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"authorizingRoles\": [],\n \"thirdpartyId\": 875,\n \"accountId\": 15601,\n \"companyIdType\": \"CIT001\",\n \"siret\": \"50382936800052\",\n \"siren\": \"503829368\",\n \"tva\": \"FR69503829368\",\n \"duns\": \"260004250\",\n \"dateCreation\": \"2010-11-24\",\n \"companyStartDate\": \"2008-04-07\",\n \"followingDate\": \"2012-12-27\",\n \"legalCategoryLabel\": \"Société par actions simplifiée\",\n \"legalCategoryCode\": \"5710\",\n \"acronym\": null,\n \"brandName\": null,\n \"addressingName\": \"E-ATTESTATIONS.COM CERTICORPS\",\n \"activityLabel\": \"Edition de logiciels applicatifs\",\n \"activityCode\": \"5829C\",\n \"etabActivityCode\": \"5829C\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Edition de logiciels applicatifs\",\n \"ceo\": null,\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Philippe\",\n \"function\": \"Directeur général\",\n \"companyName\": null\n }\n ],\n \"capital\": 111,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 1111111,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2022-12-31T01:00:00.000\",\n \"workforce\": 24,\n \"companyIdValue\": \"50382936800052\",\n \"thirdpartyCode\": \"tp code example\",\n \"monitored\": true,\n \"onboarded\": true,\n \"stoppingDate\": \"2023-06-27\",\n \"stoppingReason\": null,\n \"isMonitored\": \"true\",\n \"name\": \"E-ATTESTATIONS.COM\",\n \"addressStreet\": \"27 AVENUE CARNOT\",\n \"addressCity\": \"MASSY\",\n \"addressPostCode\": \"91300\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": \"0158060010\",\n \"website\": null,\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"registered\": true,\n \"isRegistered\": \"true\",\n \"registrationDate\": \"2010-11-24\",\n \"active\": true,\n \"isActive\": \"true\",\n \"outOfBusiness\": false,\n \"isOutOfBusiness\": \"false\",\n \"stateLastChangeDate\": \"2023-10-30\",\n \"complete\": false,\n \"isComplete\": \"false\",\n \"category\": \"PME\",\n \"subCategory\": \"PE\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"totalDossiers\": 18,\n \"thirdpartyUsers\": [\n {\n \"userId\": 981739,\n \"firstName\": \"Jean\",\n \"lastName\": \"DUPONT\",\n \"email\": \"j.dupont@email.com\",\n \"phone\": \"+33 6 11 11 11 11\",\n \"accountId\": 875\n }\n ],\n \"listRegistrationNumber\": [],\n \"lastStateSuivi\": null,\n \"dunsEncrypted\": false\n }\n}"},{"id":"e1609a5b-cfdc-4626-a217-248562a50687","name":"Error 404 : Third party or attribute label not found Copy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"test\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:13:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/1581809/attributes;client=10.114.1.144;user=aaa@e-attestations.com\",\n \"reason\": \"404 : [{\\\"timestamp\\\":\\\"2024-11-08T10:13:40.417+00:00\\\",\\\"status\\\":404,\\\"error\\\":\\\"Not Found\\\",\\\"message\\\":\\\"\\\",\\\"path\\\":\\\"/api/account/15601/dossier/1581809/attributes\\\"}]\"\n }\n ]\n}"}],"_postman_id":"b8210e23-3bf2-425c-9f3a-de1363853510"},{"name":"Account thirdparties","event":[{"listen":"test","script":{"id":"d534c37b-6487-41bc-9419-5942bb2494de","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"thirdpartyId\", jsonData.content[0].thirdpartyId);","","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript"}}],"id":"91ed1765-b6e8-4069-8042-944180de1b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?page=0&pageSize=5","description":"

Get the list of your thirdparties.\nThe result is paginated with 10 entries per page by default.

You can specify the page size et page number with the following parameters.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pageSize	integer	the number of results returned by the request (default is 10)
page	integer	parameter to specify the number of the page you want to access (default is 0)
insee	boolean	this parameter is not a search criteria but enable to get complementary information for french thirdparties, like insee code. All INSEE informations will be present in the `insee` section of the JSON response\n
finess	boolean	this parameter is not a search criteria but enable to get complementary information for a FINESS (Fichier national des établissements sanitaires et sociaux) third party. All FINESS informations will be present in the `finess` section of the JSON response\n

\n\n

Note :

\n\"companyIdType\": \"CIT001\" for french thirdparties with companyIdValue = SIRET\n
\n\"companyIdType\": \"CIT002\" for NON french thirdparties. When an intra-community VAT exists, it will appear in the companyIdValue field, otherwise it will be a null value for a DUNS without VAT. The DUNS is not yet returned\n

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties"],"host":["{{ea_api_serv}}"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"5"}],"variable":[]}},"response":[{"id":"e1772c30-ff74-4694-9e20-db6c08a8e951","name":"Thirdparties","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?page=0&pageSize=5","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"5"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 487744,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"48293649900999\",\n \"thirdpartyCode\": null,\n \"siren\": \"482999999\",\n \"siret\": \"48293649900999\",\n \"tva\": \"FR49482999999\",\n \"name\": \"COMPANY NAME\",\n \"dateCreation\": \"2021-05-19\",\n \"companyStartDate\": \"2003-10-15\",\n \"legalCategoryLabel\": \"Profession libérale\",\n \"legalCategoryCode\": \"1500\",\n \"acronym\": null,\n \"activityLabel\": \"Activités spécialisées, scientifiques et techniques diverses\",\n \"activityCode\": \"7490B\",\n \"etabActivityCode\": \"7490B\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Activités spécialisées, scientifiques et techniques diverses\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"DUPONT\",\n \"firstname\": \"Jean\",\n \"function\": \"Exploitant\"\n }\n ],\n \"capital\": 0,\n \"capitalCurrency\": null,\n \"turnover\": null,\n \"turnoverCurrency\": null,\n \"lastBalanceSheetDate\": null,\n \"workforce\": 1,\n \"addressStreet\": \"32 QUAI ANDRE\",\n \"addressCity\": \"ST GINNNN\",\n \"addressPostCode\": \"74500\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": \"0699999999\",\n \"website\": null,\n \"category\": null,\n \"subCategory\": null,\n \"thirdpartyUsers\": [{\n \"userId\": 981739,\n \"firstName\": \"Thierry\",\n \"lastName\": \"Adey\",\n \"email\": \"t.adey@e-attestations.com\",\n \"phone\": \"+33 1 01 01 01 01\",\n \"accountId\": 875\n }],\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n },\n {\n \"thirdpartyId\": 445308,\n \"companyIdType\": \"CIT002\",\n \"companyIdValue\": \"BE0423929999\",\n \"thirdpartyCode\": null,\n \"siren\": null,\n \"siret\": null,\n \"tva\": \"BE0423929999\",\n \"name\": \"Cammaert Elastische\",\n \"dateCreation\": \"2019-09-30\",\n \"companyStartDate\": \"1983-04-01\",\n \"legalCategoryLabel\": \"Corporation\",\n \"legalCategoryCode\": null,\n \"acronym\": \"Cauwaert\",\n \"activityLabel\": \"Floor laying and floor work, nec\",\n \"activityCode\": \"17520000\",\n \"etabActivityCode\": \"17520000\",\n \"etabActivityType\": \"SIC\",\n \"etabActivityLabel\": \"Floor laying and floor work, nec\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"XXX\",\n \"firstname\": \"XXXX\",\n \"function\": \"Manager\"\n }\n ],\n \"capital\": null,\n \"capitalCurrency\": null,\n \"turnover\": 3684155.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2019-12-31\",\n \"workforce\": 12,\n \"addressStreet\": \"Galgenbergstraat 50 AAA\",\n \"addressCity\": \"Berlare\",\n \"addressPostCode\": \"9290\",\n \"addressCountryCode\": \"BE\",\n \"etabPhoneNumber\": \"32 77778599\",\n \"website\": \"www.blablabla.be\",\n \"category\": null,\n \"subCategory\": null,\n \"headquarter\": false,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": [\n {\n \"number\": \"1472583697\",\n \"code\": 1800,\n \"libelle\": \"Branch Unit Number (BE)\"\n },\n {\n \"number\": \"BE0423929999\",\n \"code\": 99,\n \"libelle\": \"Value Added Tax Number (BE)\"\n },\n {\n \"number\": \"147258369\",\n \"code\": 800,\n \"libelle\": \"Enterprise Number (BE)\"\n }\n ]\n }\n ]\n}"},{"id":"485ac3e3-6d33-4026-a791-f4346f861848","name":"Thirdparties with INSEE informations","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?page=0&pageSize=5&insee=true","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"5"},{"key":"insee","value":"true"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300999\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841999\",\n \"siret\": \"49384180300999\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANY NAME\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"thirdpartyUsers\": [{\n \"userId\": 981739,\n \"firstName\": \"Thierry\",\n \"lastName\": \"Adey\",\n \"email\": \"t.adey@e-attestations.com\",\n \"phone\": \"+33 1 01 01 01 01\",\n \"accountId\": 875\n }],\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": [],\n \"insee\": {\n \"economieSocialeSolidaire\": false,\n \"codeInsee\": \"98727\"\n }\n },\n {\n \"thirdpartyId\": 1186,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300998\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841998\",\n \"siret\": \"49384180300998\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANY NAME 2\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE 2\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75002\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": [],\n \"insee\": {\n \"economieSocialeSolidaire\": true,\n \"codeInsee\": \"98728\"\n }\n }\n ]\n}"},{"id":"2c62a668-a9cb-4be2-b69e-1c392490d909","name":"Thirdparties with FINESS informations","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?page=0&pageSize=5&finess=true","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"5"},{"key":"finess","value":"true"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300999\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841999\",\n \"siret\": \"49384180300999\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANY NAME\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"thirdpartyUsers\": [{\n \"userId\": 981739,\n \"firstName\": \"Thierry\",\n \"lastName\": \"Adey\",\n \"email\": \"t.adey@e-attestations.com\",\n \"phone\": \"+33 1 01 01 01 01\",\n \"accountId\": 875\n }],\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": [],\n \"finess\": [\n {\n \"catEtabLabel\": \"Service d'Accompagnement à la Vie Sociale (S.A.V.S.)\",\n \"numFinessET\": \"147258369\",\n \"updateDate\": \"2018-10-08T00:00:00\"\n },\n {\n \"catEtabLabel\": \"Autre Résidence Sociale (hors Maison Relais, Pension de Fami\",\n \"numFinessET\": \"1472588996\",\n \"updateDate\": \"2012-07-10T00:00:00\"\n }\n ]\n }\n ]\n}"},{"id":"4e138b42-5b2d-4276-9618-caefad6154f3","name":"French thirdparty","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?page=0&pageSize=5","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"5"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 487744,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"48293649900999\",\n \"thirdpartyCode\": null,\n \"siren\": \"482999999\",\n \"siret\": \"48293649900999\",\n \"tva\": \"FR49482999999\",\n \"name\": \"COMPANY NAME\",\n \"dateCreation\": \"2021-05-19\",\n \"companyStartDate\": \"2003-10-15\",\n \"legalCategoryLabel\": \"Profession libérale\",\n \"legalCategoryCode\": \"1500\",\n \"acronym\": null,\n \"activityLabel\": \"Activités spécialisées, scientifiques et techniques diverses\",\n \"activityCode\": \"7490B\",\n \"etabActivityCode\": \"7490B\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Activités spécialisées, scientifiques et techniques diverses\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"DUPONT\",\n \"firstname\": \"Jean\",\n \"function\": \"Exploitant\"\n }\n ],\n \"capital\": 0,\n \"capitalCurrency\": null,\n \"turnover\": null,\n \"turnoverCurrency\": null,\n \"lastBalanceSheetDate\": null,\n \"workforce\": 1,\n \"addressStreet\": \"32 QUAI ANDRE\",\n \"addressCity\": \"ST GINNNN\",\n \"addressPostCode\": \"74500\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": \"0699999999\",\n \"website\": null,\n \"category\": null,\n \"subCategory\": null,\n \"thirdpartyUsers\": [{\n \"userId\": 981739,\n \"firstName\": \"Thierry\",\n \"lastName\": \"Adey\",\n \"email\": \"t.adey@e-attestations.com\",\n \"phone\": \"+33 1 01 01 01 01\",\n \"accountId\": 875\n }],\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n },\n {\n \"thirdpartyId\": 445308,\n \"companyIdType\": \"CIT002\",\n \"companyIdValue\": \"BE0423929999\",\n \"thirdpartyCode\": null,\n \"siren\": null,\n \"siret\": null,\n \"tva\": \"BE0423929999\",\n \"name\": \"Cammaert Elastische\",\n \"dateCreation\": \"2019-09-30\",\n \"companyStartDate\": \"1983-04-01\",\n \"legalCategoryLabel\": \"Corporation\",\n \"legalCategoryCode\": null,\n \"acronym\": \"Cauwaert\",\n \"activityLabel\": \"Floor laying and floor work, nec\",\n \"activityCode\": \"17520000\",\n \"etabActivityCode\": \"17520000\",\n \"etabActivityType\": \"SIC\",\n \"etabActivityLabel\": \"Floor laying and floor work, nec\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"XXX\",\n \"firstname\": \"XXXX\",\n \"function\": \"Manager\"\n }\n ],\n \"capital\": null,\n \"capitalCurrency\": null,\n \"turnover\": 3684155.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2019-12-31\",\n \"workforce\": 12,\n \"addressStreet\": \"Galgenbergstraat 50 AAA\",\n \"addressCity\": \"Berlare\",\n \"addressPostCode\": \"9290\",\n \"addressCountryCode\": \"BE\",\n \"etabPhoneNumber\": \"32 77778599\",\n \"website\": \"www.blablabla.be\",\n \"category\": null,\n \"subCategory\": null,\n \"headquarter\": false,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": [\n {\n \"number\": \"1472583697\",\n \"code\": 1800,\n \"libelle\": \"Branch Unit Number (BE)\"\n },\n {\n \"number\": \"BE0423929999\",\n \"code\": 99,\n \"libelle\": \"Value Added Tax Number (BE)\"\n },\n {\n \"number\": \"147258369\",\n \"code\": 800,\n \"libelle\": \"Enterprise Number (BE)\"\n }\n ]\n }\n ]\n}"},{"id":"6a72d451-cba1-4187-b1c1-386afd04ddd1","name":"Non french thirdparty","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?page=0&pageSize=5","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"5"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 445308,\n \"companyIdType\": \"CIT002\",\n \"companyIdValue\": \"BE0423929999\",\n \"thirdpartyCode\": null,\n \"siren\": null,\n \"siret\": null,\n \"tva\": \"BE0423929999\",\n \"name\": \"Cammaert Elastische\",\n \"dateCreation\": \"2019-09-30\",\n \"companyStartDate\": \"1983-04-01\",\n \"legalCategoryLabel\": \"Corporation\",\n \"legalCategoryCode\": null,\n \"acronym\": \"Cauwaert\",\n \"activityLabel\": \"Floor laying and floor work, nec\",\n \"activityCode\": \"17520000\",\n \"etabActivityCode\": \"17520000\",\n \"etabActivityType\": \"SIC\",\n \"etabActivityLabel\": \"Floor laying and floor work, nec\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"XXX\",\n \"firstname\": \"XXXX\",\n \"function\": \"Manager\"\n }\n ],\n \"capital\": null,\n \"capitalCurrency\": null,\n \"turnover\": 3684155.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2019-12-31\",\n \"workforce\": 12,\n \"addressStreet\": \"Galgenbergstraat 50 AAA\",\n \"addressCity\": \"Berlare\",\n \"addressPostCode\": \"9290\",\n \"addressCountryCode\": \"BE\",\n \"etabPhoneNumber\": \"32 77778599\",\n \"website\": \"www.blablabla.be\",\n \"category\": null,\n \"subCategory\": null,\n \"headquarter\": false,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": [\n {\n \"number\": \"1472583697\",\n \"code\": 1800,\n \"libelle\": \"Branch Unit Number (BE)\"\n },\n {\n \"number\": \"BE0423929999\",\n \"code\": 99,\n \"libelle\": \"Value Added Tax Number (BE)\"\n },\n {\n \"number\": \"147258369\",\n \"code\": 800,\n \"libelle\": \"Enterprise Number (BE)\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"91ed1765-b6e8-4069-8042-944180de1b45"},{"name":"Search for my account thirdparties by criterias","event":[{"listen":"test","script":{"id":"2bccc36d-ddf3-4463-982c-3d07fa4a1782","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"76a19b7c-4bb2-47ee-ba30-f1927b8d4f3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties","description":"

Requests thirdparties by search criteria.

You can view multiple examples on the right and select them with the dropdown.

The list of search criteria :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
name	String	the thirdparty company name
siren	String	the thirdparty company siren (french company id)
siret	String	the thirdparty siret (french thirdparty id)
tva	String	the thirdparty VAT number
duns	String	the thirdparty DUNS number (D&B identifier)
thirdpartyCode	String	the thirdparty code (supplier code defined by the client)
monitored	boolean	search for thirdparties your currently monitoring Aprovall. If monitored=false, you can request for thirdparties your no longer monitoring on e-Attestations. Monitored=true for all third parties who have at least one active dossier
onboarded	boolean	search for onboarded thirdparties. If onboarded=true, returns thirdparties that are currently followed. If onboarded=false, returns archived thirdparties
complete	boolean	complete=true for all third parties who have complete dossiers / complete=false for all third parties who have at least one incomplete dossier
registered	boolean	search for thirdparties based on their registration status on Aprovall portal
isCollectiveProceeding	boolean	search for thirdparties that are in collective proceeding (redressement judiciaire, liquidation, etc.)
stateLastChangeDate	String (format yyyy-MM-dd)	enable to search for third parties which state has changed since the specified date (the date must be formatted like this : '2021-06-02'). Example : one dossier has changed state to incomplete on February 1 2022, therefore stateLastChangeDate will be 2022-02-01
identityLastChangeDate	String (format yyyy-MM-dd)	enable to search for thirdparties who's identity information has change since the specified date (address, principals, ...)
companyClosedDate	String (format yyyy-MM-dd)	search for thirdparties whose company has been closed since the specified date
fromCreationDate	String (format yyyy-MM-dd)	search for thirdparties created (followed) since the specified date
attributeLabel	String	the label of a custom attribute to filter on (must be used with attributeValue or fromAttributeChangeDate)
attributeValue	String	the value of the custom attribute to filter on (must be used with attributeLabel)
fromAttributeChangeDate	String (format yyyy-MM-dd)	search for thirdparties whose custom attribute value has changed since the specified date
eventNames	List	Filter third parties that have specific events in their history. You can specify one or more event types separated by commas. See available event types here : https://developers.aprovall.com/guides/dictionary/events
eventOccurrenceStartDate	String (format yyyy-MM-dd'T'HH:mm:ss)	start date for event occurrence filter (must be used with eventNames and eventOccurrenceEndDate)
eventOccurrenceEndDate	String (format yyyy-MM-dd'T'HH:mm:ss)	end date for event occurrence filter (must be used with eventNames and eventOccurrenceStartDate)
page	Integer	the page number for pagination (default: 0)
pageSize	Integer	the number of results per page
insee	boolean	this parameter is not a search criteria but enable to get complementary information for french thirdparties, like insee code. All INSEE informations will be present in the insee section of the JSON response
finess	boolean	this parameter is not a search criteria but enable to get complementary information for a FINESS (Fichier national des établissements sanitaires et sociaux) third party. All FINESS informations will be present in the finess section of the JSON response

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"59f2c45a-d3fd-458c-85f9-a7dbf7572c21","name":"Search for monitored thirdparties","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?monitored=true","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"monitored","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300999\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841999\",\n \"siret\": \"49384180300999\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANY NAME\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n },\n {\n \"thirdpartyId\": 1186,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300998\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841998\",\n \"siret\": \"49384180300998\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANY NAME 2\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE 2\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75002\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 50\n}"},{"id":"848f0370-e8a8-4f52-bffe-75e4e5af0504","name":"Search by company name","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?name=COMPANYNAME","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"name","value":"COMPANYNAME"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300999\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841999\",\n \"siret\": \"49384180300999\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANYNAME\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 1\n}"},{"id":"3d41d2a7-f2a1-4e01-b12f-7e0c0d7387bd","name":"Search by siret","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?siret=49384180300999","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"siret","value":"49384180300999"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300999\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841999\",\n \"siret\": \"49384180300999\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANYNAME\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 1\n}"},{"id":"da2bfc60-228a-438a-b53b-4b1ce855ea44","name":"Search by VAT number","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?tva=FR92493841803","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"tva","value":"FR92493841803"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300999\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841999\",\n \"siret\": \"49384180300999\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANYNAME\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 1\n}"},{"id":"1bf2ad96-1856-442f-a085-bf5897adae99","name":"Search by last change date","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties?stateLastChangeDate=2020-06-01","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties"],"query":[{"key":"stateLastChangeDate","value":"2020-06-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300999\",\n \"thirdpartyCode\": \"20192511\",\n \"siren\": \"493841999\",\n \"siret\": \"49384180300999\",\n \"tva\": \"FR92493841803\",\n \"name\": \"COMPANYNAME\",\n \"dateCreation\": \"2010-11-26\",\n \"companyStartDate\": \"2006-11-20\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": \"5720\",\n \"acronym\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"ceo\": \"DUPONT Jean\",\n \"principals\": [\n {\n \"name\": \"Dupont\",\n \"firstname\": \"Jean\",\n \"function\": \"Président\"\n }\n ],\n \"capital\": 5000,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 128204.0,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2012-12-31\",\n \"workforce\": 0,\n \"addressStreet\": \"6 ALLEE DE LA GARE\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"etabPhoneNumber\": null,\n \"website\": null,\n \"category\": \"PME\",\n \"subCategory\": \"MICRO\",\n \"headquarter\": true,\n \"groupCompanyName\": null,\n \"groupSiren\": null,\n \"groupPercentageOwnership\": null,\n \"listRegistrationNumber\": []\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 1\n}"}],"_postman_id":"76a19b7c-4bb2-47ee-ba30-f1927b8d4f3f"},{"name":"Account thirdparthy details","event":[{"listen":"test","script":{"id":"734d7dc4-c9f1-4159-9f20-dbde185534b4","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonData = pm.response.json();","pm.test(\"Check thirdpartyId is valid\", function () {"," pm.expect(jsonData.content).not.to.be.empty"," pm.expect(jsonData.content.thirdpartyId).to.eq(pm.environment.get(\"thirdpartyId\"))","})"],"type":"text/javascript","packages":{}}}],"id":"46214351-7c1c-414c-89e2-f728b72c06e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}","description":"

Request one thirdparty details by the given id

You can specify the page size et page number with the following parameters.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
insee	boolean	this parameter is not a search criteria but enable to get complementary information for french thirdparties, like insee code. All INSEE informations will be present in the `insee` section of the JSON response
finess	boolean	this parameter is not a search criteria but enable to get complementary information for a FINESS (Fichier national des établissements sanitaires et sociaux) third party. All FINESS informations will be present in the `finess` section of the JSON response\n

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"2dc55afd-1c67-463e-a2d6-77f5682932c6","name":"Account thirdparties details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"thirdpartyId\": 875,\n \"accountId\": 119631,\n \"companyIdType\": \"CIT001\",\n \"siret\": \"50382936800045\",\n \"siren\": \"503829368\",\n \"tva\": \"FR69503829368\",\n \"dateCreation\": \"2010-11-24\",\n \"legalCategoryLabel\": \"Société par actions simplifiée\",\n \"legalCategoryCode\": \"5710\",\n \"acronym\": null,\n \"activityLabel\": \"Edition de logiciels applicatifs\",\n \"activityCode\": \"5829C\",\n \"ceo\": null,\n \"capital\": 545444,\n \"capitalCurrency\": \"EUR\",\n \"turnover\": 4891866,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2019-12-31T01:00:00.000\",\n \"workforce\": 18,\n \"companyIdValue\": \"50382936800045\",\n \"thirdpartyCode\": \"123\",\n \"monitored\": true,\n \"isMonitored\": \"true\",\n \"name\": \"E-ATTESTATIONS.COM\",\n \"addressStreet\": \"2 RUE DU CHEMIN DES FEMMES\",\n \"addressCity\": \"MASSY\",\n \"addressPostCode\": \"91300\",\n \"addressCountryCode\": \"FR\",\n \"registered\": true,\n \"isRegistered\": \"true\",\n \"registrationDate\": \"2010-11-24\",\n \"active\": true,\n \"isActive\": \"true\",\n \"outOfBusiness\": false,\n \"isOutOfBusiness\": \"false\",\n \"stateLastChangeDate\": \"2021-05-11\",\n \"complete\": false,\n \"isComplete\": \"false\",\n \"category\": \"PME\",\n \"subCategory\": \"PE\",\n \"thirdpartyUsers\": [\n {\n \"userId\": 3241,\n \"firstName\": \"Test\",\n \"lastName\": \"Test\",\n \"email\": \"test@e-attestations.com\",\n \"phone\": \"+33 1 00 00 00 00\",\n \"accountId\": 875\n }\n ]\n }\n}"}],"_postman_id":"46214351-7c1c-414c-89e2-f728b72c06e4"},{"name":"Account thirdparthy attributes","event":[{"listen":"test","script":{"id":"734d7dc4-c9f1-4159-9f20-dbde185534b4","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonData = pm.response.json();","pm.test(\"Check thirdpartyId is valid\", function () {"," pm.expect(jsonData.content).not.to.be.empty"," pm.expect(jsonData.content.thirdpartyId).to.eq(pm.environment.get(\"thirdpartyId\"))","})"],"type":"text/javascript","packages":{}}}],"id":"c1b95051-e294-4f54-8e6d-0d5ff0ee0a79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes","description":"

Get all attributes for a specifc thirdparty

\n","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","attributes"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"1c9e210f-949f-4e69-a3b4-9260d3ca0445","name":"Account thirdparthy attributes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [ \n {\n \"id\": 6896,\n \"attributeId\": 784,\n \"label\": \"4. Purchase Annual Amount\",\n \"type\": \"list_unique\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": \"2024-10-10T09:00:46.469+00:00\",\n \"updateDate\": null,\n \"values\": [\n \"+5K€\"\n ]\n },\n {\n \"id\": 6898,\n \"attributeId\": 911,\n \"label\": \"Attribut_numérique_1\",\n \"type\": \"decimal\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": \"2024-10-10T09:00:55.361+00:00\",\n \"updateDate\": null,\n \"values\": [\n \"12\"\n ]\n },\n {\n \"id\": 6588,\n \"attributeId\": 800,\n \"label\": \"BOOLEEN\",\n \"type\": \"boolean\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": \"2024-02-29T15:26:51.503+00:00\",\n \"updateDate\": \"2024-10-10T09:00:59.467+00:00\",\n \"values\": [\n \"true\"\n ]\n },\n {\n \"id\": 6899,\n \"attributeId\": 801,\n \"label\": \"DATE\",\n \"type\": \"date\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": \"2024-10-10T09:01:09.347+00:00\",\n \"updateDate\": null,\n \"values\": [\n \"2024-10-11\"\n ]\n },\n {\n \"id\": null,\n \"attributeId\": 916,\n \"label\": \"Text attribute\",\n \"type\": \"string\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": null,\n \"updateDate\": null,\n \"values\": [\"Text attribute value\"]\n }\n ]\n}"}],"_postman_id":"c1b95051-e294-4f54-8e6d-0d5ff0ee0a79"},{"name":"Account thirdparthy calculated attributes","event":[{"listen":"test","script":{"id":"734d7dc4-c9f1-4159-9f20-dbde185534b4","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonData = pm.response.json();","pm.test(\"Check thirdpartyId is valid\", function () {"," pm.expect(jsonData.content).not.to.be.empty"," pm.expect(jsonData.content.thirdpartyId).to.eq(pm.environment.get(\"thirdpartyId\"))","})"],"type":"text/javascript","packages":{}}}],"id":"325d0e6c-3690-48cb-844c-f564aa029078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/calculated-attributes","description":"

Get all calculted attributes for a specific thirdparty.

Response details :

name : attribute name
\n
resultType : result type of the attribute :
\n
- STRING : for a text value
  \n
- ARITHMETIC_FORMULA_OUTPUT : for a double value
  \n
\n
resultValue : attribute value, depending of the type ( text or double)
\n
resultColorCode: hexa code color displayed in the SAAS application for this attribute
\n

\n","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","calculated-attributes"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"20adea41-3400-4dd4-af21-0e4bea7b4569","name":"Account thirdparthy calculated attributes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/calculated-attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 111,\n \"calculationId\": null,\n \"name\": \"text attribute\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"France\",\n \"resultColorCode\": \"#9900ef\",\n \"resultLastUpdateDate\": \"2024-05-15T16:05:57.187+00:00\"\n },\n {\n \"id\": 222,\n \"calculationId\": null,\n \"name\": \"numeric label\",\n \"resultType\": \"ARITHMETIC_FORMULA_OUTPUT\",\n \"resultValue\": \"4.5\",\n \"resultColorCode\": \"\",\n \"resultLastUpdateDate\": \"2024-07-23T10:22:33.969+00:00\"\n }\n ]\n}"}],"_postman_id":"325d0e6c-3690-48cb-844c-f564aa029078"},{"name":"Account thirdparthy indicators","event":[{"listen":"test","script":{"id":"734d7dc4-c9f1-4159-9f20-dbde185534b4","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonData = pm.response.json();","pm.test(\"Check thirdpartyId is valid\", function () {"," pm.expect(jsonData.content).not.to.be.empty"," pm.expect(jsonData.content.thirdpartyId).to.eq(pm.environment.get(\"thirdpartyId\"))","})"],"type":"text/javascript","packages":{}}}],"id":"841fe48c-114e-4a46-96a1-04418d12c3ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/indicators","description":"

Get all indicators for a specific thirdparty.

Response details :

name : indicator name
\n
resultType : result type of the indicator :
\n
- STRING : for a text value
  \n
- ARITHMETIC_FORMULA_OUTPUT : for a double value
  \n
\n
resultValue : indicator value, depending of the type ( text or double)
\n
resultColorCode: hexa code color displayed in the SAAS application for this indicator
\n

\n","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","indicators"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"514c9800-662f-45d0-91dd-65162406648d","name":"Account thirdparthy indicators","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 12,\n \"calculationId\": null,\n \"name\": \"Indued_ACT\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"MEDIUM\",\n \"resultColorCode\": \"#fcb900\",\n \"resultLastUpdateDate\": \"2024-04-27T22:06:13.936+00:00\"\n },\n {\n \"id\": 23,\n \"calculationId\": null,\n \"name\": \"RISK_CYBER\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"DEFAVORABLE\",\n \"resultColorCode\": \"#eb144c\",\n \"resultLastUpdateDate\": \"2023-12-11T13:43:54.794+00:00\"\n },\n {\n \"id\": 313,\n \"calculationId\": null,\n \"name\": \"TEST_INDICATOR\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"Default\",\n \"resultColorCode\": \"\",\n \"resultLastUpdateDate\": \"2024-03-22T08:09:33.603+00:00\"\n },\n {\n \"id\": 131,\n \"calculationId\": null,\n \"name\": \"SIS-ID\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"OK\",\n \"resultColorCode\": \"#00d084\",\n \"resultLastUpdateDate\": \"2024-10-01T07:01:04.602+00:00\"\n },\n {\n \"id\": 2423,\n \"calculationId\": null,\n \"name\": \"ARITHMETIC INDICATOR\",\n \"resultType\": \"ARITHMETIC_FORMULA_OUTPUT\",\n \"resultValue\": \"12345\",\n \"resultColorCode\": \"\",\n \"resultLastUpdateDate\": \"2024-07-26T15:54:50.188+00:00\"\n }\n ]\n}"}],"_postman_id":"841fe48c-114e-4a46-96a1-04418d12c3ce"},{"name":"Account thirdparthy scores","event":[{"listen":"test","script":{"id":"734d7dc4-c9f1-4159-9f20-dbde185534b4","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonData = pm.response.json();","pm.test(\"Check thirdpartyId is valid\", function () {"," pm.expect(jsonData.content).not.to.be.empty"," pm.expect(jsonData.content.thirdpartyId).to.eq(pm.environment.get(\"thirdpartyId\"))","})"],"type":"text/javascript","packages":{}}}],"id":"79bbcac7-c368-417c-b883-4a2bbaf25a43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/scores","description":"

Get all scores from external sources : DNB, Ecovadis, Transparency etc.

\n","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","scores"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"ffaddf64-0a8c-4567-ac1e-2e0984e9783a","name":"Account thirdparthy scores","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/scores"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"datablocks_financial_strength\": {\n \"scoreDate\": \"2024-07-03\",\n \"score\": \"1\",\n \"isFailureScore\": false,\n \"rating\": \"HH1\",\n \"financialStrength\": \"HH\",\n \"riskLevel\": \"very_low\",\n \"riskSegmentDescription\": \"Minimum Risk - Proceed with transaction – offer extended terms if required\",\n \"riskSegmentDescriptionFr\": \"Risque minimum - Poursuivre la transaction - proposer des conditions prolongées si nécessaire\",\n \"financialStrengthDescription\": \"This entity has minimal Capital (Under 12K€).\",\n \"financialStrengthDescriptionFr\": \"Ce tiers dispose d'un capital minimal (moins de 12K€).\",\n \"dnbAssessment\": {\n \"failureScore\": {\n \"classScore\": null,\n \"classScoreDescription\": null,\n \"scoreDate\": \"2024-07-03\",\n \"scoreModel\": {\n \"description\": \"FR43077\",\n \"dnbCode\": null\n },\n \"nationalPercentile\": null,\n \"scoreOverrideReasons\": null,\n \"rawScore\": null,\n \"riskIncidencePercentage\": null,\n \"scoreCommentary\": null\n },\n \"delinquencyScore\": {\n \"classScore\": null,\n \"classScoreDescription\": null,\n \"scoreDate\": null,\n \"scoreModel\": null,\n \"nationalPercentile\": null,\n \"scoreOverrideReasons\": null,\n \"rawScore\": null,\n \"riskIncidencePercentage\": null,\n \"scoreCommentary\": null\n },\n \"historyRating\": {\n \"description\": null,\n \"dnbCode\": null\n },\n \"standardRating\": {\n \"rating\": \"HH1\",\n \"scoreDate\": \"2024-07-03\",\n \"financialStrength\": \"HH\",\n \"riskSegment\": \"1\",\n \"ratingOverrideReasons\": null,\n \"ratingReason\": null\n },\n \"nordicAAARating\": {\n \"rating\": null,\n \"scoreDate\": null,\n \"financialStrength\": null,\n \"riskSegment\": null\n },\n \"financialCondition\": {\n \"description\": null,\n \"dnbCode\": null\n },\n \"creditLimitRecommendation\": null,\n \"emergingMarketMediationScore\": null,\n \"hasSevereNegativeEvents\": null\n }\n },\n \"transparency\": [\n {\n \"cpiYear\": 2019,\n \"countryIso2\": \"FR\",\n \"countryIso3\": \"FRA\",\n \"countryScore\": 69,\n \"countryRank\": 23,\n \"cpiNumberOfSources\": 8,\n \"cpiStandardError\": 2,\n \"countryScorePrecedentVar\": -3,\n \"countryRankPrecedentVar\": 2,\n \"countryNosPrecedentVar\": 0,\n \"color\": \"#E99D20\",\n \"intervalEnumName\": \"SIXTY_TO_SIXTY_NINE\"\n },\n {\n \"cpiYear\": 2020,\n \"countryIso2\": \"FR\",\n \"countryIso3\": \"FRA\",\n \"countryScore\": 69,\n \"countryRank\": 23,\n \"cpiNumberOfSources\": 8,\n \"cpiStandardError\": 1,\n \"countryScorePrecedentVar\": 0,\n \"countryRankPrecedentVar\": 0,\n \"countryNosPrecedentVar\": 0,\n \"color\": \"#E99D20\",\n \"intervalEnumName\": \"SIXTY_TO_SIXTY_NINE\"\n },\n {\n \"cpiYear\": 2021,\n \"countryIso2\": \"FR\",\n \"countryIso3\": \"FRA\",\n \"countryScore\": 71,\n \"countryRank\": 22,\n \"cpiNumberOfSources\": 8,\n \"cpiStandardError\": 1,\n \"countryScorePrecedentVar\": 2,\n \"countryRankPrecedentVar\": -1,\n \"countryNosPrecedentVar\": 0,\n \"color\": \"#EEB805\",\n \"intervalEnumName\": \"SEVENTY_TO_SEVENTY_NINE\"\n },\n {\n \"cpiYear\": 2022,\n \"countryIso2\": \"FR\",\n \"countryIso3\": \"FRA\",\n \"countryScore\": 72,\n \"countryRank\": 21,\n \"cpiNumberOfSources\": 8,\n \"cpiStandardError\": 0,\n \"countryScorePrecedentVar\": 1,\n \"countryRankPrecedentVar\": -1,\n \"countryNosPrecedentVar\": 0,\n \"color\": \"#EEB805\",\n \"intervalEnumName\": \"SEVENTY_TO_SEVENTY_NINE\"\n },\n {\n \"cpiYear\": 2023,\n \"countryIso2\": \"FR\",\n \"countryIso3\": \"FRA\",\n \"countryScore\": 71,\n \"countryRank\": 0,\n \"cpiNumberOfSources\": 0,\n \"cpiStandardError\": 0,\n \"countryScorePrecedentVar\": 0,\n \"countryRankPrecedentVar\": 0,\n \"countryNosPrecedentVar\": 0,\n \"color\": \"#EEB805\",\n \"intervalEnumName\": \"SEVENTY_TO_SEVENTY_NINE\"\n }\n ],\n \"indued\": {\n \"due_diligence_id\": \"111\",\n \"due_diligence\": {\n \"status\": \"fpm_done\",\n \"fpm_url\": \"https://api-indued.altares.com/v3/entities/...\",\n \"compliance_score\": 5,\n \"country_score\": 1,\n \"activity_score\": 2,\n \"state\": \"active\",\n \"pep_score\": 1,\n \"sanctions_score\": 1,\n \"adverse_media_score\": 1,\n \"risk_event_score\": 1,\n \"report_url\": \"https://api-indued.altares.com/api/v3/reports/...\",\n \"risk_level\": 2,\n \"workflow_status\": null,\n \"failure_score\": null\n },\n \"report_id\": \"111\",\n \"report_data\": {\n \"status\": \"succeeded\",\n \"url\": \"https://api-indued.altares.com/api/v3/...\"\n },\n \"created_date\": \"2024-10-09T19:30:10.871+00:00\",\n \"last_modified_date\": \"2024-10-09T19:30:10.871+00:00\"\n }\n }\n}"}],"_postman_id":"79bbcac7-c368-417c-b883-4a2bbaf25a43"},{"name":"Account thirdparties legal informations","event":[{"listen":"test","script":{"id":"734d7dc4-c9f1-4159-9f20-dbde185534b4","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonData = pm.response.json();","pm.test(\"Check thirdpartyId is valid\", function () {"," pm.expect(jsonData.content).not.to.be.empty"," pm.expect(jsonData.content.thirdpartyId).to.eq(pm.environment.get(\"thirdpartyId\"))","})"],"type":"text/javascript"}}],"id":"c2314fd4-70a3-4f0f-91fc-591f3d16432d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/legalstatus?fromDate=2020-01-01","description":"

Get all legal informations about followed third parties : address modification, judicial liquidation...

\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
fromDate	YYYY-MM-DD	all legal informations from this specified date

","urlObject":{"path":["api","v1","account","{{account_id}}","legalstatus"],"host":["{{ea_api_serv}}"],"query":[{"key":"fromDate","value":"2020-01-01"}],"variable":[]}},"response":[{"id":"a37a1883-582a-47af-84e2-a11ca3753277","name":"Account thirdparties legal informations from 2020-01-01","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/legalstatus?fromDate=2020-01-01","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","legalstatus"],"query":[{"key":"fromDate","value":"2020-01-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"content\": {\n \"Raison Sociale\": \"COMPANY NAME FRANCE\",\n \"Siren\": \"014725836\",\n \"Évenement\": \"Information légale - Changement d'adresse\",\n \"Date de parution\": \"29/03/2020\",\n \"Annonce\": \"N° Annonce XXXX, N° Bodacc XX, N° Parution XXXXXXX\",\n \"Tribunal\": \"XXXX TRIBUNAL DE COMMERCE DE LYON 69\",\n \"Descriptif\": \"Nouveau siège. Mise en activité de la société. Origine : Fonds reçu en location gérance.\"\n },\n \"category\": \"Modifications\"\n },\n {\n \"content\": {\n \"Raison Sociale\": \"COMPANY NAME FRANCE\",\n \"Siren\": \"014725836\",\n \"Évenement\": \"Information légale - Location gérance reçue d'un fonds de commerce\",\n \"Date de parution\": \"29/03/2020\",\n \"Annonce\": \"N° Annonce XXXX, N° Bodacc XX, N° Parution XXXXXXX\",\n \"Tribunal\": \"PERPIC TRIBUNAL DE COMMERCE DE PERPIGNAN 66\",\n \"Descriptif\": \"Mise en activité de la société. Origine : Fonds reçu en location gérance.\"\n },\n \"category\": \"Modifications\"\n },\n {\n \"content\": {\n \"Raison Sociale\": \"COMPANY NAME IMMOBILIER\",\n \"Siren\": \"014725836\",\n \"Évenement\": \"Information légale - Nomination / modification sur les commissaires aux comptes\",\n \"Date de parution\": \"29/03/2020\",\n \"Annonce\": \"N° Annonce XXXX, N° Bodacc XX, N° Parution XXXXXXX\",\n \"Tribunal\": \"XXXXX TRIBUNAL DE COMMERCE DE VERSAILLES 78\",\n \"Descriptif\": \"Modification survenue sur l'administration.\"\n },\n \"category\": \"Modifications\"\n }\n ]\n}"}],"_postman_id":"c2314fd4-70a3-4f0f-91fc-591f3d16432d"},{"name":"Account thirdparties location history","event":[{"listen":"test","script":{"id":"734d7dc4-c9f1-4159-9f20-dbde185534b4","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","var jsonData = pm.response.json();","pm.test(\"Check thirdpartyId is valid\", function () {"," pm.expect(jsonData.content).not.to.be.empty"," pm.expect(jsonData.content.thirdpartyId).to.eq(pm.environment.get(\"thirdpartyId\"))","})"],"type":"text/javascript"}}],"id":"56fbb6a4-e6ff-4f13-b1bc-8a7e16231672","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/history","description":"

Get the history of this thirdparty's locations

\n","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","history"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"a71f4a29-fa93-4c47-b1d9-42cd528e7d20","name":"Account thirdparties localtion history","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}//thirdparties/{{thirdparty_id}}/history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"etablissementId\": 360621,\n \"thirdpartyId\": 875,\n \"identifiant\": \"50382936800045\",\n \"tpStartDate\": \"2017-06-07T02:00:00\",\n \"tpClosingDate\": null,\n \"addressStreet\": \"2 RUE DU CHEMIN DES FEMMES\",\n \"addressCity\": \"MASSY\",\n \"addressPostCode\": \"91300\",\n \"addressCountryCode\": \"FR\",\n \"active\": true\n },\n {\n \"etablissementId\": 684534,\n \"thirdpartyId\": 875,\n \"identifiant\": \"50382936800052\",\n \"tpStartDate\": \"2021-10-01T02:00:00\",\n \"tpClosingDate\": null,\n \"addressStreet\": \"27 AVENUE CARNOT\",\n \"addressCity\": \"MASSY\",\n \"addressPostCode\": \"91300\",\n \"addressCountryCode\": \"FR\",\n \"active\": true\n },\n {\n \"etablissementId\": 930,\n \"thirdpartyId\": 875,\n \"identifiant\": \"50382936800037\",\n \"tpStartDate\": \"2010-06-24T02:00:00\",\n \"tpClosingDate\": \"2017-06-07T02:00:00\",\n \"addressStreet\": \"VILLA DE LOURCINE\",\n \"addressCity\": \"PARIS 14E ARRONDISSEMENT\",\n \"addressPostCode\": \"75014\",\n \"addressCountryCode\": \"FR\",\n \"active\": false\n }\n ]\n}"}],"_postman_id":"56fbb6a4-e6ff-4f13-b1bc-8a7e16231672"}],"id":"a40569ac-d749-41e2-8c87-46d3c045478c","description":"

Account's thirdparties list and details.

\n","event":[{"listen":"prerequest","script":{"id":"cca7ef93-bde6-45a5-b235-412decf890f0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4dcd3ebe-f5a1-4197-9748-e0a5f3428884","type":"text/javascript","exec":[""]}}],"_postman_id":"a40569ac-d749-41e2-8c87-46d3c045478c","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Dossiers","item":[{"name":"Dossiers ALL","event":[{"listen":"test","script":{"id":"83982e40-7a9e-4734-a4cf-2f732d53b016","exec":["var jsonData = JSON.parse(responseBody);","","pm.globals.set(\"dossierReference\", jsonData.content[0].dossierReference);","pm.globals.set(\"companyIdType\", jsonData.content[0].companyIdType);","pm.globals.set(\"companyIdValue\", jsonData.content[0].companyIdValue);","pm.globals.set(\"dossierId\", jsonData.content[0].dossierId);","","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"80e8a93c-92dc-4d56-b5f7-3d49d7117e3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/all","description":"

Requests all dossiers at once (not paginated)

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","all"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"d5e16081-9a93-46d9-be2c-480d84bd1fff","name":"All Dossiers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/all"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"dossierId\": 1433524,\n \"accountId\": 119631,\n \"siren\": \"542107800\",\n \"siret\": \"54210780003943\",\n \"tva\": \"FR72542107800\",\n \"thirdpartyId\": 320479,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"54210780003943\",\n \"thirdpartyCode\": \"9833\",\n \"thirdpartyState\": true,\n \"thirdpartyName\": \"E-ATTESTATIONS.COM\",\n \"thirdpartyActivityCode\": \"5829C\",\n \"thirdpartyActivityLabel\": \"Edition de logiciels applicatifs\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"companyCountryCode\": \"FR\",\n \"monitored\": false,\n \"isMonitored\": \"false\",\n \"dossierReference\": \"TEST\",\n \"description\": \"description_1433524\",\n \"purchasingCategory\": \"ttttt\",\n \"creationDate\": \"2018-07-16T11:04:59.756\",\n \"startingDate\": null,\n \"expirationDate\": null,\n \"stoppingDate\": \"2020-03-17T10:55:42.411\",\n \"stoppingReason\": \"ACTION_VOLONTAIRE\",\n \"state\": null,\n \"isComplete\": \"true\",\n \"stateLastChangeDate\": null,\n \"notes\": [\n {\n \"dateCreation\": \"2018-09-18T14:41:33.193+00:00\",\n \"prenomNom\": \"Jean Dupont\",\n \"userOid\": 14785,\n \"contenu\": \"this is a note\"\n },\n {\n \"dateCreation\": \"2018-09-18T14:43:56.742+00:00\",\n \"prenomNom\": \"Jean Dupont\",\n \"userOid\": 14785,\n \"contenu\": \"This is a second note\"\n }\n ],\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2020-03-17T10:47:37.585\"\n }\n ],\n \"documents\": [],\n \"statusCode\": \"VALID\"\n },\n {\n \"dossierId\": 1504311,\n \"accountId\": 119631,\n \"siren\": \"480470152\",\n \"siret\": \"48047015200012\",\n \"tva\": \"FR71480470152\",\n \"thirdpartyId\": 86049,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"48047015200012\",\n \"thirdpartyCode\": null,\n \"companyCountryCode\": \"FR\",\n \"thirdpartyState\": true,\n \"thirdpartyName\": \"GOOGLE\",\n \"thirdpartyActivityCode\": \"5829C\",\n \"thirdpartyActivityLabel\": \"Edition de logiciels applicatifs\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"monitored\": true,\n \"isMonitored\": \"true\",\n \"dossierReference\": \"-\",\n \"description\": \"\",\n \"purchasingCategory\": \"\",\n \"creationDate\": \"2018-07-16T11:04:59.756\",\n \"startingDate\": null,\n \"expirationDate\": null,\n \"stoppingDate\": null,\n \"stoppingReason\": \"NA\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"stateLastChangeDate\": \"2021-05-26T13:58:04.688\",\n \"notes\": [],\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2021-05-26T13:58:04.688\"\n }\n ],\n \"documents\": [\n {\n \"documentId\": 11675833,\n \"dossierId\": 1504311,\n \"documentCode\": \"RIB_IBAN\",\n \"documentName\": \"Coordonnées bancaires - RIB\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2021-05-26T13:58:05.312\",\n \"present\": true,\n \"isPresent\": \"true\",\n \"evidences\": [\n {\n \"id\": 2704163,\n \"responseId\": 2238768,\n \"uploadDate\": \"2017-04-25T10:45:16.537\",\n \"fileUUID\": \"a3218884b699c5074ce07e111c6eb43ddb3ddcf2\",\n \"fileName\": \"file:/data/CCDocs/50382936800045/20190306-110611_50382936800045_NDA_e-attestations.com.pdf\",\n \"fileCreation\": \"2017-04-25T10:45:16.520\",\n \"fileSize\": 25999,\n \"expirationDate\": \"2022-04-25T23:59:59.999\",\n \"formdata\": [\n {\n \"type\": \"iban\",\n \"key\": \"f_49_bn_0\",\n \"title\": \"IBAN\",\n \"order\": 0,\n \"value\": \"FR76 XXXX XXXX XXXX XXXX XXXX XXX\"\n }\n ],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {\n \"bank_data_country_iso\": \"FR\",\n \"bank_data_bank\": \"STE GENERALE\",\n \"sepa_data_cor1\": \"NO\",\n \"verified\": \"true\",\n \"sepa_data_sct\": \"YES\",\n \"bank_data_country\": \"\",\n \"bank_data_address\": \"28 R DES ARTS\",\n \"bank_data_account\": \"XXXXXXXXX\",\n \"bank_data_phone\": \"\",\n \"bank_data_zip\": \"XXXXX\",\n \"bank_data_city\": \"LILLE\",\n \"bank_data_bic\": \"XXXXXX\",\n \"bank_data_fax\": \"\",\n \"sepa_data_b2b\": \"YES\",\n \"bank_data_www\": \"\",\n \"sepa_data_scc\": \"YES\",\n \"sepa_data_sdd\": \"YES\",\n \"date_verification\": \"25/04/2017\",\n \"bank_data_email\": \"\"\n }\n }\n ]\n }\n ],\n \"statusCode\": \"VALID\"\n }\n ]\n}\n "}],"_postman_id":"80e8a93c-92dc-4d56-b5f7-3d49d7117e3e"},{"name":"Dossiers","event":[{"listen":"test","script":{"id":"83ecb2cd-0909-41e2-bda9-1aed8830fddf","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"dossierId\", jsonData.content[0].dossierId);","/*","pm.environment.set(\"dossierReference\", jsonData.content[0].dossierReference);","pm.environment.set(\"companyIdType\", jsonData.content[0].companyIdType);","pm.environment.set(\"companyIdValue\", jsonData.content[0].companyIdValue);","*/","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"a2362ae3-e31a-4933-b84c-4a5f023c6c3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers?page=0&pageSize=5","description":"

Get the list of your dossiers.\nThe result is paginated with 10 entries per page by default.

You can specify the page size et page number with the following parameters.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pageSize	integer	the number of results returned by the request (default is 10)
page	integer	parameter to specify the number of the page you want to access (default is 0)

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers"],"host":["{{ea_api_serv}}"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"5"}],"variable":[]}},"response":[{"id":"46abc0f5-093d-41c5-8748-6a6e7b9ce591","name":"Account dossiers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers?page=2&pageSize=5","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","dossiers"],"query":[{"key":"page","value":"2"},{"key":"pageSize","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"dossierId\": 1433524,\n \"accountId\": 119631,\n \"siren\": \"542107800\",\n \"siret\": \"54210780003943\",\n \"tva\": \"FR72542107800\",\n \"thirdpartyId\": 320479,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"54210780003943\",\n \"thirdpartyCode\": \"9833\",\n \"thirdpartyState\": true,\n \"thirdpartyName\": \"COMPANY NAME\",\n \"thirdpartyActivityCode\": \"5829C\",\n \"thirdpartyActivityLabel\": \"Edition de logiciels applicatifs\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"companyCountryCode\": \"FR\",\n \"monitored\": false,\n \"isMonitored\": \"false\",\n \"dossierReference\": \"TEST\",\n \"description\": \"description_1433524\",\n \"purchasingCategory\": \"ttttt\",\n \"creationDate\": \"2018-07-16T11:04:59.756\",\n \"startingDate\": null,\n \"expirationDate\": null,\n \"stoppingDate\": \"2020-03-17T10:55:42.411\",\n \"stoppingReason\": \"ACTION_VOLONTAIRE\",\n \"state\": null,\n \"isComplete\": \"true\",\n \"stateLastChangeDate\": null,\n \"notes\": [],\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2020-03-17T10:47:37.585\"\n }\n ],\n \"documents\": [],\n \"statusCode\": \"VALID\"\n },\n {\n \"dossierId\": 1504311,\n \"accountId\": 119631,\n \"siren\": \"480470152\",\n \"siret\": \"48047015200012\",\n \"tva\": \"FR71480470152\",\n \"thirdpartyId\": 86049,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"48047015200012\",\n \"thirdpartyCode\": null,\n \"companyCountryCode\": \"FR\",\n \"monitored\": true,\n \"isMonitored\": \"true\",\n \"dossierReference\": \"-\",\n \"description\": \"\",\n \"purchasingCategory\": \"\",\n \"startingDate\": null,\n \"expirationDate\": null,\n \"stoppingDate\": null,\n \"stoppingReason\": \"NA\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"stateLastChangeDate\": \"2021-05-26T13:58:04.688\",\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2021-05-26T13:58:04.688\"\n }\n ],\n \"documents\": [\n {\n \"documentId\": 11675833,\n \"dossierId\": 1504311,\n \"documentCode\": \"RIB_IBAN\",\n \"documentName\": \"Coordonnées bancaires - RIB\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2021-05-26T13:58:05.312\",\n \"present\": true,\n \"isPresent\": \"true\",\n \"evidences\": [\n {\n \"id\": 2704163,\n \"responseId\": 2238768,\n \"uploadDate\": \"2017-04-25T10:45:16.537\",\n \"fileUUID\": \"a3218884b699c5074ce07e111c6eb43ddb3ddcf2\",\n \"fileName\": \"file:/data/CCDocs/50382936800045/20190306-110611_50382936800045_NDA_e-attestations.com.pdf\",\n \"fileCreation\": \"2017-04-25T10:45:16.520\",\n \"fileSize\": 25999,\n \"expirationDate\": \"2022-04-25T23:59:59.999\",\n \"formdata\": [\n {\n \"type\": \"iban\",\n \"key\": \"f_49_bn_0\",\n \"title\": \"IBAN\",\n \"order\": 0,\n \"value\": \"FR76 XXXX XXXX XXXX XXXX XXXX XXX\"\n }\n ],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {\n \"bank_data_country_iso\": \"FR\",\n \"bank_data_bank\": \"STE GENERALE\",\n \"sepa_data_cor1\": \"NO\",\n \"verified\": \"true\",\n \"sepa_data_sct\": \"YES\",\n \"bank_data_country\": \"\",\n \"bank_data_address\": \"28 R DES ARTS\",\n \"bank_data_account\": \"XXXXXXXXX\",\n \"bank_data_phone\": \"\",\n \"bank_data_zip\": \"XXXXX\",\n \"bank_data_city\": \"LILLE\",\n \"bank_data_bic\": \"XXXXXX\",\n \"bank_data_fax\": \"\",\n \"sepa_data_b2b\": \"YES\",\n \"bank_data_www\": \"\",\n \"sepa_data_scc\": \"YES\",\n \"sepa_data_sdd\": \"YES\",\n \"date_verification\": \"25/04/2017\",\n \"bank_data_email\": \"\"\n }\n }\n ]\n }\n ],\n \"statusCode\": \"VALID\"\n }\n ]\n}\n "}],"_postman_id":"a2362ae3-e31a-4933-b84c-4a5f023c6c3d"},{"name":"Dossiers by criterias","event":[{"listen":"test","script":{"id":"91ecde2e-3e55-4680-a504-c97b06112ef2","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"66fd7060-b3e2-407a-9739-727f0532d1db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers?monitored=false","description":"

Requests dossiers by search criterias.

The list of search criterias :

Parameter	Type	Description
siren	String	third party company siren (french company id)
siret	String	third party siret (third party SIRET number)
tva	String	third party intra-Community VAT number
duns	String	Dun & Bradstreet DUNS number
stateLastChangeDate	String (format : YYYY-MM-DD)	enable to search for dossiers which state has changed since the specified date (the date must be formatted like this : '2021-06-02'). ( state incomplete to complete for example)
state	boolean	true : search for active and complete dossiers., or false for incomplete or inative dossier
monitored	boolean	get all active dossiers (complete or incomplete)
thirdpartyId	Integer	technical third party ID
thirdpartyCode	String	third party code : defined during dossier creation or update
documentCode	String	Find all dossiers including a document (search by document code (to find it, use this endpoint `Requirements Requirements for the account`
dossierTypeCode	String	If you have enable dossier types on your account, you can search by the code of the dossier type
fromUploadedDate	String (format : YYYY-MM-DD)	find all dossiers which a document has been uploaded greater than or equal to this date. Example : find all dossiers including an IBAN document (documentCode=RIB_IBAN) , uploaded today (fromUploadedDate=2021-01-01)
dossierReference	String	dossier reference : defined during dossier creation or update
op	string	Possible values : 'like', 'ends' or 'starts'. This parameter works with these parameters : thirdpartyCode and/or dossierReference. For example : ?thirdpartyCode=\"OOG\"&op=like returns all dossiers with thirdpartyCode = \"GOOGLE\"
pageSize	integer	the number of results returned by the request (default is 10)
page	integer	parameter to specify the number of the page you want to access (default is 0)
`eventNames`	array of strings	Filter dossiers that have specific events in their history. You can specify one or more event types separated by commas. See available event types here : https://developers.aprovall.com/guides/dictionary/events
`eventOccurrenceStartDate`	array of strings	Start date for filtering events. Format: `yyyy-MM-dd'T'HH:mm:ss` (e.g., \"2024-01-01T00:00:00\")
`eventOccurrenceEndDate`	array of strings	End date for filtering events. Format: `yyyy-MM-dd'T'HH:mm:ss` (e.g., \"2024-12-31T23:59:59\")

\n\n

Example :

``/dossiers?stateLastChangeDate=2021-05-01&monitored=true&siren=493841803&thirdpartyCode=2019&op=starts``

This request returns :

all active dossiers of the third party with SIREN = 493841803
with a change since May 1, 2021
with a third party code that starts with \"2019\"

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers"],"host":["{{ea_api_serv}}"],"query":[{"key":"monitored","value":"false"}],"variable":[]}},"response":[{"id":"c4657b59-4998-4b84-9054-d68d7f15b7d9","name":"Account dossiers by criterias : dossierReference","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers?dossierReference=TESTAPI&op=like","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","dossiers"],"query":[{"key":"dossierReference","value":"TESTAPI"},{"key":"op","value":"like"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"dossierId\": 1331486,\n \"accountId\": 119631,\n \"siren\": \"753368935\",\n \"siret\": \"75336893500015\",\n \"tva\": \"FR27753368935\",\n \"thirdpartyId\": 177931,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"75336893500015\",\n \"thirdpartyCode\": \"FO1001\",\n \"thirdpartyState\": true,\n \"thirdpartyName\": \"TAXY COMPANY NAME\",\n \"thirdpartyActivityCode\": \"5829C\",\n \"thirdpartyActivityLabel\": \"Edition de logiciels applicatifs\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"companyCountryCode\": \"FR\",\n \"monitored\": false,\n \"isMonitored\": \"false\",\n \"dossierReference\": \"TESTAPI1.1\",\n \"description\": \"description_1331486\",\n \"purchasingCategory\": \"Taxi\",\n \"creationDate\": \"2018-07-16T11:04:59.756\",\n \"startingDate\": null,\n \"expirationDate\": \"2021-12-31T00:00:00.000\",\n \"stoppingDate\": \"2019-11-28T09:24:24.914\",\n \"stoppingReason\": \"ACTION_VOLONTAIRE\",\n \"state\": null,\n \"isComplete\": \"false\",\n \"stateLastChangeDate\": null,\n \"notes\": [],\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2019-11-26T15:43:40.118\"\n }\n ],\n \"documents\": [],\n \"statusCode\": \"VALID\"\n },\n {\n \"dossierId\": 1331488,\n \"accountId\": 119631,\n \"siren\": \"753368935\",\n \"siret\": \"75336893500015\",\n \"tva\": \"FR27753368935\",\n \"thirdpartyId\": 177931,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"75336893500015\",\n \"thirdpartyCode\": \"FO1001\",\n \"thirdpartyState\": true,\n \"thirdpartyName\": \"TAXY COMPANY NAME\",\n \"thirdpartyActivityCode\": \"5829C\",\n \"thirdpartyActivityLabel\": \"Edition de logiciels applicatifs\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"companyCountryCode\": \"FR\",\n \"monitored\": false,\n \"isMonitored\": \"false\",\n \"dossierReference\": \"TESTAPI1.1002\",\n \"description\": \"description_1331488\",\n \"purchasingCategory\": \"Ambulance\",\n \"creationDate\": \"2018-07-16T11:04:59.756\",\n \"startingDate\": null,\n \"expirationDate\": \"2021-12-31T00:00:00.000\",\n \"stoppingDate\": \"2019-11-28T09:24:34.377\",\n \"stoppingReason\": \"ACTION_VOLONTAIRE\",\n \"state\": null,\n \"isComplete\": \"false\",\n \"stateLastChangeDate\": null,\n \"notes\": [],\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2019-11-26T15:45:34.130\"\n }\n ],\n \"documents\": [],\n \"statusCode\": \"VALID\"\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 1\n}"},{"id":"4c8106d8-51d8-4aa2-815f-b2a5028075a3","name":"Account dossiers by criterias : multi criterias","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers?stateLastChangeDate=2021-05-01&monitored=true&siren=493841803&thirdpartyCode=2019&op=starts","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","dossiers"],"query":[{"key":"stateLastChangeDate","value":"2021-05-01"},{"key":"monitored","value":"true"},{"key":"siren","value":"493841803"},{"key":"thirdpartyCode","value":"2019"},{"key":"op","value":"starts"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"dossierId\": 782514,\n \"accountId\": 119631,\n \"siren\": \"493841803\",\n \"siret\": \"49384180300056\",\n \"tva\": \"FR92493841803\",\n \"thirdpartyId\": 1185,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300056\",\n \"thirdpartyCode\": \"20192511\",\n \"thirdpartyState\": true,\n \"thirdpartyName\": \"TAXY COMPANY NAME\",\n \"thirdpartyActivityCode\": \"5829C\",\n \"thirdpartyActivityLabel\": \"Edition de logiciels applicatifs\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"companyCountryCode\": \"FR\",\n \"monitored\": true,\n \"isMonitored\": \"true\",\n \"dossierReference\": \"CCIRB\",\n \"description\": \"description_782514\",\n \"purchasingCategory\": \"\",\n \"creationDate\": \"2018-07-16T11:04:59.756\",\n \"startingDate\": null,\n \"expirationDate\": null,\n \"stoppingDate\": null,\n \"stoppingReason\": \"NA\",\n \"state\": false,\n \"isComplete\": \"false\",\n \"stateLastChangeDate\": \"2021-05-28T00:06:52.635\",\n \"notes\": [],\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2020-04-09T14:09:13.947\"\n }\n ],\n \"documents\": [\n {\n \"documentId\": 11207811,\n \"dossierId\": 782514,\n \"documentCode\": \"JUSTIF_IMM\",\n \"documentName\": \"Justificatif d’immatriculation\",\n \"documentNameEn\": \"Justificatif d’immatriculation\",\n \"requestDate\": \"2020-03-05T11:06:02.422\",\n \"present\": true,\n \"isPresent\": \"true\",\n \"evidences\": [\n {\n \"id\": 6876637,\n \"uploadDate\": \"2020-12-08T16:15:13.571\",\n \"fileUUID\": \"80e19221-beb6-4092-9604-347329367a06\",\n \"fileName\": \"file:/data/CCDocs/50382936800045/20190306-110611_50382936800045_NDA_e-attestations.com.pdf\",\n \"fileCreation\": \"2020-12-08T16:15:13.551\",\n \"fileSize\": 72446,\n \"expirationDate\": \"2021-06-08T23:59:59.999\",\n \"formdata\": [],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {\n \"siren\": \"493841803\",\n \"date_certification\": \"08/12/2020\"\n }\n }\n ]\n },\n {\n \"documentId\": 11304620,\n \"dossierId\": 782514,\n \"documentCode\": \"FDRPLGA\",\n \"documentName\": \"Fiche de référencement pour le GROUPE ARCADE - VYV\",\n \"documentNameEn\": \"Fiche de référencement pour le GROUPE ARCADE - VYV\",\n \"requestDate\": \"2020-03-23T13:40:33.000\",\n \"present\": false,\n \"isPresent\": \"false\",\n \"evidences\": []\n }\n ],\n \"statusCode\": \"VALID\"\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 1\n}"}],"_postman_id":"66fd7060-b3e2-407a-9739-727f0532d1db"},{"name":"Dossier details","event":[{"listen":"test","script":{"id":"c835e414-4786-4319-91a5-c60986529fda","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"bbdc9243-8bac-479a-bf63-4c8dc5257661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}","description":"

Requests one dossier details by its id

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"6c659eed-87f5-4995-946b-51ba3a7a9834","name":"Account dossiers details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"dossierId\": 1433524,\n \"accountId\": 119631,\n \"siren\": \"542107800\",\n \"siret\": \"54210780003943\",\n \"tva\": \"FR72542107800\",\n \"thirdpartyId\": 320479,\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"54210780003943\",\n \"thirdpartyCode\": \"9833\",\n \"thirdpartyState\": true,\n \"thirdpartyName\": \"TAXY COMPANY NAME\",\n \"thirdpartyActivityCode\": \"5829C\",\n \"thirdpartyActivityLabel\": \"Edition de logiciels applicatifs\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"companyCountryCode\": \"FR\",\n \"monitored\": false,\n \"isMonitored\": \"false\",\n \"dossierReference\": \"TEST\",\n \"description\": \"description_1433524\",\n \"purchasingCategory\": \"ttttt\",\n \"creationDate\": \"2018-07-16T11:04:59.756\",\n \"startingDate\": null,\n \"expirationDate\": null,\n \"stoppingDate\": \"2020-03-17T10:55:42.411\",\n \"stoppingReason\": \"ACTION_VOLONTAIRE\",\n \"state\": null,\n \"isComplete\": \"true\",\n \"stateLastChangeDate\": null,\n \"notes\": [],\n \"indicators\": [\n {\n \"indicatorCode\": \"I001\",\n \"state\": true,\n \"isComplete\": \"true\",\n \"lastChangeDate\": \"2020-03-17T10:47:37.585\"\n }\n ],\n \"documents\": [],\n \"statusCode\": \"VALID\"\n }\n}"}],"_postman_id":"bbdc9243-8bac-479a-bf63-4c8dc5257661"},{"name":"Dossier attributes","event":[{"listen":"test","script":{"id":"c835e414-4786-4319-91a5-c60986529fda","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"4e89c4cd-9a6a-4da8-ab3a-09f0e721e539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributes","description":"

Get all dossiers attributes

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","attributes"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"9fb2ad3d-4be6-4d2b-b073-8f9ea341cd80","name":"Dossier attributes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 6900,\n \"attributeId\": 157,\n \"label\": \"multiple liste label\",\n \"type\": \"list_multiple\",\n \"bondType\": \"dossier\",\n \"creationDate\": \"2024-10-10T09:17:05.467+00:00\",\n \"updateDate\": null,\n \"values\": [\n \"aaa\"\n ]\n },\n {\n \"id\": 6901,\n \"attributeId\": 903,\n \"label\": \"Test FLO\",\n \"type\": \"integer\",\n \"bondType\": \"dossier\",\n \"creationDate\": \"2024-10-10T09:17:20.713+00:00\",\n \"updateDate\": null,\n \"values\": [\n \"10\"\n ]\n },\n {\n \"id\": 6902,\n \"attributeId\": 96,\n \"label\": \"Region\",\n \"type\": \"list_multiple\",\n \"bondType\": \"dossier\",\n \"creationDate\": \"2024-10-10T09:18:22.678+00:00\",\n \"updateDate\": null,\n \"values\": [\n \"Ain\"\n ]\n },\n {\n \"id\": 6903,\n \"attributeId\": 915,\n \"label\": \"Responsable de dossier\",\n \"type\": \"string\",\n \"bondType\": \"dossier\",\n \"creationDate\": \"2024-10-10T09:18:35.387+00:00\",\n \"updateDate\": null,\n \"values\": [\n \"text attribute\"\n ]\n }\n ]\n}"}],"_postman_id":"4e89c4cd-9a6a-4da8-ab3a-09f0e721e539"}],"id":"2dd531b1-a0f0-4538-b321-b6873415d20f","description":"

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)

","_postman_id":"2dd531b1-a0f0-4538-b321-b6873415d20f","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Dossiers creation & Processes","item":[{"name":"Create new dossier (sync)","event":[{"listen":"test","script":{"id":"b002867a-4b94-4a9e-a155-3a4e1da863b4","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"processId\", jsonData.content.processId);","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4bea3b1c-7716-4083-92b9-af4e57e2bf2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"thirdpartyCode\": \"TEST4\",\n \"dossierReference\": \"TEST#4\",\n \"description\": \"Optional description\",\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"],\n \"dossierTypeCode\" : \"TRAVDISS\"\n}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/dossiers","description":"

Creates a new dossier with details for an existing third party

This is an synchronous process

You can use some or all of the attributes depending of your needs and your use cases.

We have a new attribute dossierTypeCode: you can specify dossier types by contacting your key account manager. This new feature allows to preconfigure a defined set of requirement, to simplify the dossier configuration.

The body contains several attributes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
thirdpartyCode*	String	A reference code from an external system or database. If a third party code already exists (set in another dossier), let this field empty
dossierReference*	String	A dossier that identifies this dossier and that could come from an external system or database for instance
description	String	A free text field for description, or any other use
purchasingCategory	String	Another free text field for dossiers category, or any other use
expirationDate	YYYY-MM-DD	If given this date will be the end of this dossier. The third party won't be monitored with this dossier after this date
requiredDocuments	String[]	This array sets the required documents for this third party managed with this dossier. Each item in the list is a document code (to find it, use this endpoint `Requirements Requirements for the account`
dossierTypeCode	String	If you have enable dossier types on your account, you can specify a dossier type when you create your dossier. List of all dossier types list available by calling this endpoint `Account dossier types list`
thirdpartyEmail	String[]	third party email addresses. Persons will receive an email.
usersInCharge	String[]	A list of emails of users from your organisation that will receive ownership for this dossier management. Will invite them or send an email.

List of possible errors :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Error description
E001	Missing parameter
E002	Unknown parameter
E003	Empty parameter
E010	Wrong format
E021	Expiration date is in the past
E022	Date in future
E030	Invalid E-mail domain
E101	Error qualifying the company
E102	Company does not exist
E103	Company is closed
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.
E201	Dossier disabled
E202	Reference exists for third party
E204	Dossier already enabled
E206	Dossier type not found
E207	Updating documents is forbidden on a typed dossier
E301	Requirement disabled
E302	Requirement not allowed

","urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","{{thirdparty_id}}","dossiers"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"48ca1bb1-f9fb-4c5a-a034-23701759098a","name":"Create new dossier with more details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"thirdpartyCode\": \"TEST3\",\n \"dossierReference\": \"TEST#3\",\n \"description\": \"Dossier\",\n \"purchasingCategory\": \"Dog\",\n \"expirationDate\": \"2020-05-31\",\n \"requiredDocuments\": [\"JUSTIF_IMM\"],\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"],\n \"userInCharge\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/dossiers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\"\n }\n}"},{"id":"77ec1a59-7710-42a0-82df-e73c1ad1fe52","name":"Create new dossier with a dossier type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"thirdpartyCode\": \"TEST3\",\n \"dossierReference\": \"TEST#3\",\n \"dossierTypeCode\": \"SECU\",\n \"description\": \"Dossier\",\n \"purchasingCategory\": \"Dog\",\n \"expirationDate\": \"2020-05-31\",\n \"requiredDocuments\": [\"JUSTIF_IMM\"],\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"],\n \"userInCharge\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/dossiers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\"\n }\n}"},{"id":"29d3e410-545b-4a31-b798-baa137950d0e","name":"Create dossier (minimal)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dossierReference\": \"TEST#7\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/{{thirdparty_id}}/dossiers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\"\n }\n}"}],"_postman_id":"4bea3b1c-7716-4083-92b9-af4e57e2bf2c"},{"name":"Deprecated - Create new dossier with third party identifier (async)","event":[{"listen":"test","script":{"id":"b002867a-4b94-4a9e-a155-3a4e1da863b4","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"processId\", jsonData.content.processId);","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"80371772-42db-40e3-a5db-b1a44a10f3bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"43258335900109\",\n \"thirdpartyCode\": \"TEST3\",\n \"dossierReference\": \"TEST#3\",\n \"description\": \"Dossier\",\n \"purchasingCategory\": \"Dog\",\n \"expirationDate\": \"2020-05-31\",\n \"requiredDocuments\": [\"JUSTIF_IMM\"],\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"],\n \"userInCharge\": [\"nobody@e-attestations.com\"]\n}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers","description":"

Creates a new dossier with a lot of requirement and details.

This is an asynchronous process, so this request return a processId. With this ID, you can check the state of the dossier creation with another endpoint ( see \"Dossier creation : state\" )

With this Postman collection, we automatically set the processId variable, so that you can directly call \"Dossier creation : get process by id\" endpoint (you do not have to copy/paste the processId )

You can use some or all of the attributes depending of your needs and your use cases.

The body contains several attributes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
companyIdType*	String	Three possible values : - CIT001 for a SIRET number (french companies), composed of 14 numbers. Ex : 50382936800045 - CIT002 for an intra-community VAT number, composed of two letters (country code), followed by numbers. Ex : FR69503829368 - CIT003 for a DUNS number, composed of 9 numbers. Ex : 260004250. Or you can use an encrypted DUNS, found by using the `_Thirdparties Search for new thirdparty_` endpoint
companyIdValue*	String	SIRET, TVA or DUNS value
companyIdEncrypted*	Boolean	`true` for encrypted DUNS, fetched with `Thirdparties Search for new thirdparty` endpoint. This parameter is optional and is `false` by default. If you know the DUNS number, skip this parameter. `companyIdType` must be `CIT003`
thirdpartyCode*	String	A reference code from an external system or database. If a third party code already exists (set in another dossier), let this field empty
dossierReference*	String	A dossier that identifies this dossier and that could come from an external system or database for instance
description	String	A free text field for description, or any other use
purchasingCategory	String	Another free text field for dossiers category, or any other use
expirationDate	YYYY-MM-DD	If given this date will be the end of this dossier. The third party won't be monitored with this dossier after this date
requiredDocuments	String[]	This array sets the required documents for this third party managed with this dossier. Each item in the list is a document code (to find it, use this endpoint `Requirements Requirements for the account`
dossierTypeCode	String	If you have enable dossier types on your account, you can specify a dossier type when you create your dossier
thirdpartyEmail	String[]	third party email addresses. Persons will receive an email.
usersInCharge	String[]	A list of emails of users from your organisation that will receive ownership for this dossier management. Will invite them or send an email.

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"8dea095f-7139-494e-ab7d-9262a419a650","name":"Create new dossier with more details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"43258335900109\",\n \"thirdpartyCode\": \"TEST3\",\n \"dossierReference\": \"TEST#3\",\n \"description\": \"Dossier\",\n \"purchasingCategory\": \"Dog\",\n \"expirationDate\": \"2020-05-31\",\n \"requiredDocuments\": [\"JUSTIF_IMM\"],\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"],\n \"userInCharge\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\"\n }\n}"},{"id":"2d9c1d61-76b0-4f59-ade9-aad7744b8d5e","name":"Create new dossier with a dossier type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"43258335900109\",\n \"thirdpartyCode\": \"TEST3\",\n \"dossierReference\": \"TEST#3\",\n \"dossierTypeCode\": \"SECU\",\n \"description\": \"Dossier\",\n \"purchasingCategory\": \"Dog\",\n \"expirationDate\": \"2020-05-31\",\n \"requiredDocuments\": [\"JUSTIF_IMM\"],\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"],\n \"userInCharge\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\"\n }\n}"},{"id":"2f0c622a-a3b7-46e1-bc89-dddbfba9be02","name":"Create dossier (minimal)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\": \"CIT001\",\n \"companyIdValue\": \"49384180300056\",\n \"dossierReference\": \"TEST#7\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\"\n }\n}"},{"id":"5c95d2d1-0755-4c19-9d67-f5d107c036be","name":"Create dossier : non french third party","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyIdType\": \"CIT002\",\n \"companyIdValue\": \"FR69503829368\",\n \"thirdpartyCode\": \"\",\n \"dossierReference\": \"DOSSIER_REST_TVA#1\",\n \"description\": \"Dossier avec TVA\",\n \"purchasingCategory\": \"\",\n \"expirationDate\": \"2020-05-31\",\n \"requiredDocuments\": [ \"JUSTIF_IMM\" ],\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"],\n \"userInCharge\": [\n \"nobody@e-attestations.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"80371772-42db-40e3-a5db-b1a44a10f3bf"},{"name":"Dossier creation : get process by id","event":[{"listen":"test","script":{"id":"ab11ac64-1030-4e3e-8ba2-310201f10231","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"a985fd92-33ce-4fc5-bc32-f124c1f67bcf","exec":[""],"type":"text/javascript","packages":{}}}],"id":"51bf797c-b7dd-42e5-9b57-c67f977ffdcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/process/8af2b4a592fc4d0701930b248bc20000","description":"

Get dossier creation result for a given id.

When the dossier creation is completed (complete=true in the response) :

dossier successfully created (sucess=true in the response). You can find the dossier ID in the response : \"dossierId\": 123456789
dossier not created : at least one error has occured during the creation (errors in the response). You can find the list in the Error codes section
complete : true if the dossier is created
success : true if the dossier is created without errors

\n\n

List of possible errors :

Error code	Error description
E001	Missing parameter
E002	Unknown parameter
E003	Empty parameter
E010	Wrong format
E021	Expiration date is in the past
E022	Date in future
E030	Invalid E-mail domain
E101	Error qualifying the company
E102	Company does not exist
E103	Company is closed
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.
E201	Dossier disabled
E202	Reference exists for third party
E204	Dossier already enabled
E206	Dossier type not found
E207	Updating documents is forbidden on a typed dossier
E301	Requirement disabled
E302	Requirement not allowed
E1002	SIREN or SIRET type must be used with FR countryCode
E1003	Impossible to import a french third party with a VAT number. Use SIRET or SIREN instead
E1004	Impossible to import a french third party with local ID. Use SIRET or SIREN instead

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","process","8af2b4a592fc4d0701930b248bc20000"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"2dde8f52-c860-4c26-a8ac-8d3e8a8e1f6d","name":"Dossier creation succeed","originalRequest":{"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/process/{{processId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"4028818379e5c78b0179e606c12b0001\",\n \"creation\": \"2021-06-07T10:31:12.895+00:00\",\n \"complete\": true,\n \"success\": true,\n \"isComplete\": \"true\",\n \"isSuccessful\": \"true\",\n \"dossierId\": 123456789,\n \"errors\": [],\n \"params\": {\n \"requiredDocuments\": null,\n \"companyIDValue\": \"ESA79973681\",\n \"companyIDType\": \"CIT002\",\n \"purchasingCategory\": null,\n \"userInCharge\": null,\n \"supplierCode\": null,\n \"supplierEmail\": null,\n \"expirationDate\": null,\n \"description\": null,\n \"dossierReference\": \"az2\"\n }\n }\n}"},{"id":"21bd7975-156f-4330-b85b-7cbcf1a9d1ed","name":"Dossier creation failed","originalRequest":{"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/process/{{processId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"processId\": \"402881837983edd8017983f01a5e0001\",\n \"creation\": \"2021-05-19T09:23:41.254+00:00\",\n \"complete\": true,\n \"success\": false,\n \"isComplete\": \"true\",\n \"isSuccessful\": \"false\",\n \"errors\": [\n {\n \"code\": \"E202\",\n \"message\": \"Reference exists for third party (AZ1)\",\n \"request\": null,\n \"reason\": null\n }\n ],\n \"params\": {\n \"requiredDocuments\": null,\n \"companyIDValue\": \"ESA79973681\",\n \"companyIDType\": \"CIT002\",\n \"purchasingCategory\": null,\n \"userInCharge\": null,\n \"supplierCode\": null,\n \"supplierEmail\": null,\n \"expirationDate\": null,\n \"description\": null,\n \"dossierReference\": \"az1\"\n }\n }\n}"}],"_postman_id":"51bf797c-b7dd-42e5-9b57-c67f977ffdcc"},{"name":"Dossier creation : get processes","event":[{"listen":"test","script":{"id":"5739fa92-8566-4e24-888f-9f791fdebbe0","exec":["var jsonData = JSON.parse(responseBody);","const content = jsonData.content","pm.environment.set(\"processId\", content[content.length - 1].processId);","","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"9e165701-a0be-432c-8598-59632589576f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/processes","description":"

Get all dossier creation results (called processes)

By default, we fetch all processes from today's date.

\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
fromDate	YYYY-MM-DD	get all processes from this specified date

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","processes"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"10b62d92-1876-43ac-b104-50f7228eebc6","name":"Import dossier - Get Processes","originalRequest":{"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/processes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\",\n \"creation\": \"2021-06-07T08:46:55.619+00:00\",\n \"complete\": true,\n \"success\": false,\n \"isComplete\": \"true\",\n \"isSuccessful\": \"false\",\n \"dossierId\": 123456789,\n \"errors\": [\n {\n \"code\": \"E202\",\n \"message\": \"Reference exists for third party (TEST#7)\",\n \"request\": null,\n \"reason\": null\n }\n ],\n \"params\": {\n \"requiredDocuments\": null,\n \"companyIDValue\": \"49384180300056\",\n \"companyIDType\": \"CIT001\",\n \"purchasingCategory\": null,\n \"userInCharge\": null,\n \"supplierCode\": null,\n \"supplierEmail\": null,\n \"expirationDate\": null,\n \"description\": null,\n \"dossierReference\": \"TEST#7\"\n }\n },\n {\n \"processId\": \"8af2b416790d53c201790d57eee50000\",\n \"creation\": \"2021-04-26T08:42:17.099+00:00\",\n \"complete\": true,\n \"success\": true,\n \"isComplete\": \"true\",\n \"isSuccessful\": \"true\",\n \"errors\": [],\n \"params\": {\n \"requiredDocuments\": null,\n \"companyIDValue\": \"RS100870578\",\n \"companyIDType\": \"CIT002\",\n \"purchasingCategory\": null,\n \"userInCharge\": null,\n \"supplierCode\": null,\n \"supplierEmail\": null,\n \"expirationDate\": null,\n \"description\": null,\n \"dossierReference\": \"TEST#7\"\n }\n }\n ]\n}"},{"id":"1ebabfc3-dbbd-4261-b4f8-f8d045cdabca","name":"Import dossier - Get Processes from date","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/processes?fromDate=2019-01-01","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","dossiers","processes"],"query":[{"key":"fromDate","value":"2019-01-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"processId\": \"8af2b3c479d77a840179e5a7468401da\",\n \"creation\": \"2021-06-07T08:46:55.619+00:00\",\n \"complete\": true,\n \"success\": false,\n \"isComplete\": \"true\",\n \"isSuccessful\": \"false\",\n \"dossierId\": 123456789,\n \"errors\": [\n {\n \"code\": \"E202\",\n \"message\": \"Reference exists for third party (TEST#7)\",\n \"request\": null,\n \"reason\": null\n }\n ],\n \"params\": {\n \"requiredDocuments\": null,\n \"companyIDValue\": \"49384180300056\",\n \"companyIDType\": \"CIT001\",\n \"purchasingCategory\": null,\n \"userInCharge\": null,\n \"supplierCode\": null,\n \"supplierEmail\": null,\n \"expirationDate\": null,\n \"description\": null,\n \"dossierReference\": \"TEST#7\"\n }\n },\n {\n \"processId\": \"8af2b416790d53c201790d57eee50000\",\n \"creation\": \"2021-04-26T08:42:17.099+00:00\",\n \"complete\": true,\n \"success\": true,\n \"isComplete\": \"true\",\n \"isSuccessful\": \"true\",\n \"dossierId\": 123456789,\n \"errors\": [],\n \"params\": {\n \"requiredDocuments\": null,\n \"companyIDValue\": \"RS100870578\",\n \"companyIDType\": \"CIT002\",\n \"purchasingCategory\": null,\n \"userInCharge\": null,\n \"supplierCode\": null,\n \"supplierEmail\": null,\n \"expirationDate\": null,\n \"description\": null,\n \"dossierReference\": \"TEST#7\"\n }\n }\n ]\n}"}],"_postman_id":"9e165701-a0be-432c-8598-59632589576f"}],"id":"891e0145-6c4b-487a-9df8-192ebb5d353a","description":"

Dossier creation is an asynchronous process, you can find more details here

\n","_postman_id":"891e0145-6c4b-487a-9df8-192ebb5d353a","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Dossiers updates","item":[{"name":"Stop one dossier","event":[{"listen":"test","script":{"id":"ebe93615-ce7f-401b-ba56-7737a06fac10","exec":["// print environment","console.log(pm.globals.get(\"env\"));","","pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.response.to.not.be.error;","});","","// getting answer from response json","console.log(\"test\")","console.log(pm.response.json());","var dossierResponse = pm.response.json().content;","pm.test(\"Verify the contents of the response payload are correct with dossierId and accountId\", function () { "," pm.expect(dossierResponse.complete).to.eql(true);"," if(dossierResponse.success===false){"," console.log(\"The folder is already activated\")"," }"," else"," if(dossierResponse.success===true){"," console.log(\"You have activated the folder\")"," }",""," ","});",""],"type":"text/javascript","packages":{}}}],"id":"9a50aced-8288-4968-9834-3b16630fec1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/stop","description":"

Stop one dossier

The body may contains one attribute :

\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
deactivationReason	string	Reason for the stopped file

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","stop"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"6b4ed27e-c876-4bc2-b78c-6a9f480eccd1","name":"Error 404 : Dossier not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dossierReference\": \"EC7BJC6030/5920015318\",\n \"description\": \"NEW DESCRIPTION 1\",\n \"purchasingCategory\": \"NEW PURCHASSING CATEGORY 1\",\n \"expirationDate\": \"2021-03-15\",\n \"thirdpartyCode\": \"2133\",\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/stop"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:13:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/444444;client=10.114.1.144;user=aaa@e-attestations.com\",\n \"reason\": \"accountId-15601dossierId-444444\"\n }\n ]\n}"}],"_postman_id":"9a50aced-8288-4968-9834-3b16630fec1a"},{"name":"Activate one dossier","event":[{"listen":"test","script":{"id":"ebe93615-ce7f-401b-ba56-7737a06fac10","exec":["// print environment","console.log(pm.globals.get(\"env\"));","","pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.response.to.not.be.error;","});","","// getting answer from response json","console.log(\"test\")","console.log(pm.response.json());","var dossierResponse = pm.response.json().content;","pm.test(\"Verify the contents of the response payload are correct with dossierId and accountId\", function () { "," pm.expect(dossierResponse.complete).to.eql(true);"," if(dossierResponse.success===false){"," console.log(\"The folder is already activated\")"," }"," else"," if(dossierResponse.success===true){"," console.log(\"You have activated the folder\")"," }",""," ","});",""],"type":"text/javascript","packages":{}}}],"id":"e72b8a93-8846-4a05-9be6-daace2a51929","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \n}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/reactivate","description":"

Activate a stopped dossier

The body may contains one attribute :

\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
expirationDate	YYYY-MM-DD	A new expiration date, may be null

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","reactivate"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"554bcdb0-5b55-4ddc-a536-32a2c7dcc951","name":"Activate one dossier without expiration date","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/reactivate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"95a41df8-7156-46b7-9959-1f7c08bb7f5c","name":"Activate one dossier with expiration date","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"expirationDate\": \"2020-01-30\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/reactivate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"a4641723-7586-4267-974c-e28e8b445a06","name":"Error 404 : Dossier not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dossierReference\": \"EC7BJC6030/5920015318\",\n \"description\": \"NEW DESCRIPTION 1\",\n \"purchasingCategory\": \"NEW PURCHASSING CATEGORY 1\",\n \"expirationDate\": \"2021-03-15\",\n \"thirdpartyCode\": \"2133\",\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/reactivate"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:13:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/444444;client=10.114.1.144;user=aaa@e-attestations.com\",\n \"reason\": \"accountId-15601dossierId-444444\"\n }\n ]\n}"}],"_postman_id":"e72b8a93-8846-4a05-9be6-daace2a51929"},{"name":"Update details of one dossier","event":[{"listen":"test","script":{"id":"3b27335a-ae22-4988-b259-5e75df7b2108","exec":["// print environment","console.log(pm.globals.get(\"env\"));","pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.response.to.not.be.error;","});",""],"type":"text/javascript","packages":{}}}],"id":"53ed6624-80c3-445e-9c2a-6b7df6bb1c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dossierReference\": \"EC7BJC6030/5920015318-NEW\",\n \"description\": \"NEW DESCRIPTION 1\",\n \"purchasingCategory\": \"NEW PURCHASSING CATEGORY 1\",\n \"expirationDate\": \"2025-03-15\",\n \"thirdpartyCode\": \"2133\",\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"]\n}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}","description":"

Update active dossier informations.

The body may contains these attributes to update :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
dossierReference	String	A dossier that identifies this dossier and that could come from an external system or database for instance
description	String	A free text field for description, or any other use
purchasingCategory	String	Another free text field for dossiers category, or any other use
expirationDate	YYYY-MM-DD	If given this date will be the end of this dossier. The third party won't be monitored with this dossier after this date
thirdpartyCode	String	A reference code from an external system or database. If a value is present, the third party code will be updated for all dossiers (concerning this third party)
thirdpartyEmail	String[]	third party email addresses. Persons will receive an email.

List of possible 400 errors :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error code	Error description
E001	Missing parameter
E002	Unknown parameter
E003	Empty parameter
E010	Wrong format
E021	Expiration date is in the past
E022	Date in future
E030	Invalid E-mail domain
E111	Thirdparty code (supplierCode) is different regarding the existing one
E112	Thirdparty code (supplierCode) is already used for another thirdparty
E201	Dossier disabled
E202	Reference exists for third party
E206	Dossier type not found
E207	Updating documents is forbidden on a typed dossier

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"d829b8cb-8446-49f3-a002-052fbd3a03d1","name":"Update details of one dossier","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dossierReference\": \"EC7BJC6030/5920015318\",\n \"description\": \"NEW DESCRIPTION 1\",\n \"purchasingCategory\": \"NEW PURCHASSING CATEGORY 1\",\n \"expirationDate\": \"2021-03-15\",\n \"thirdpartyCode\": \"2133\",\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"ac29cfd7-0c8e-45a6-8c67-bffcdd875c4b","name":"Update description only","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"NEW DESCRIPTION 2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"6ee76bbd-a511-4ade-b5ea-ca23b96a037e","name":"Error 404 : Dossier not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dossierReference\": \"EC7BJC6030/5920015318\",\n \"description\": \"NEW DESCRIPTION 1\",\n \"purchasingCategory\": \"NEW PURCHASSING CATEGORY 1\",\n \"expirationDate\": \"2021-03-15\",\n \"thirdpartyCode\": \"2133\",\n \"thirdpartyEmail\": [\"nobody@e-attestations.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:13:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/444444;client=10.114.1.144;user=aaa@e-attestations.com\",\n \"reason\": \"accountId-15601dossierId-444444\"\n }\n ]\n}"}],"_postman_id":"53ed6624-80c3-445e-9c2a-6b7df6bb1c1d"},{"name":"Update requirements of one dossier","event":[{"listen":"test","script":{"id":"a6b63377-3ba5-4cad-8a89-59c6ad2f8392","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"7f40621e-009b-47d5-81b5-43faf02af57c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"newRequiredDocuments\":[\"JUSTIF_IMM\"]\n}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/requirements","description":"

Update requirements of one dossier

The body contains one attribute :

requiredDocuments

String[]

This array sets the new required documents for this third party managed with this dossier.
Each item in the list is a document code (to find it, use this endpoint Requirements Requirements for the account

\n\n

Possible 400 errors :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
E002	Unknown requirement
E201	Dossier disabled
E207	Updating documents is forbidden on a typed dossier
E003	Empty parameter
E301	Requirement disabled
E302	Requirement not allowed

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","requirements"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"e821c9db-13a2-4a16-b66f-d23596ba2968","name":"Add new required document","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"newRequiredDocuments\":[\"JUSTIF_IMM\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/requirements"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"e1f114d1-a772-4e98-8056-0ad37c266473","name":"Error 404 : dossier not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"newRequiredDocuments\":[\"JUSTIF_IMM\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/requirements"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 12:58:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/555/requirements;client=10.114.2.59;user=aaa@e-attestations.com\",\n \"reason\": \"accountId-15601dossierId-555\"\n }\n ]\n}"},{"id":"76781a99-81be-4186-87a5-54a093bcb330","name":"Error 400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"newRequiredDozcuments\":[\"JUSTIFAAA_IMM\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/requirements"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 13:01:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": {\n \"error\": [\n {\n \"code\": \"E002\",\n \"message\": \"Unknown parameter \",\n \"request\": null,\n \"reason\": null\n }\n ]\n }\n}"}],"_postman_id":"7f40621e-009b-47d5-81b5-43faf02af57c"},{"name":"Add or update a dossier attribute","id":"e7a467c9-74a2-4453-84e4-f64c38177e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"Supplier Due Diligence Procedure Workflow\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributes","description":"

Add or update a dossier attribute.

label : attribute name, you can find this name by using the following endpoint : Account attributes
\n
values : an array of values, multiples values can be added a list_multiple attribute type
\n

Il you want to set an empty value, you can set the following value : \"values\":[null]

Possible 400 errors codes :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Description
E001	Missing parameter
E011	For non multiple attribute, juste one value must be present in the values array

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","attributes"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"3f2d29e1-e3d5-465c-8202-e56b28ee0a6d","name":"Add or update a dossier attribute","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"Supplier Due Diligence Procedure Workflow\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"da676d7d-c059-49ee-bff4-266cf601430b","name":"Error 400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"test\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:12:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": {\n \"error\": [\n {\n \"code\": \"E010\",\n \"message\": \"Wrong format (values/Should be one or multiple of the following values [aaa, aaaa].)\",\n \"request\": null,\n \"reason\": null\n }\n ]\n }\n}"},{"id":"674e203f-cf85-4400-8edf-e528ff19521f","name":"Error 404 : Dossier or attribute label not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\":\"test\",\n \"values\":[\"yes\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/attributes"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 08 Nov 2024 10:13:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"origin,access-control-request-method,access-control-request-headers,accept-encoding"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Expires","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"The resource does not exist. Please check you search criteria and values.\",\n \"request\": \"ServletWebRequest: uri=/api/v1/account/15601/dossiers/1581809/attributes;client=10.114.1.144;user=aaa@e-attestations.com\",\n \"reason\": \"404 : [{\\\"timestamp\\\":\\\"2024-11-08T10:13:40.417+00:00\\\",\\\"status\\\":404,\\\"error\\\":\\\"Not Found\\\",\\\"message\\\":\\\"\\\",\\\"path\\\":\\\"/api/account/15601/dossier/1581809/attributes\\\"}]\"\n }\n ]\n}"}],"_postman_id":"e7a467c9-74a2-4453-84e4-f64c38177e4e"}],"id":"89530edc-0f0b-438c-83e3-12b543aca11b","_postman_id":"89530edc-0f0b-438c-83e3-12b543aca11b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Dossier's notes","item":[{"name":"Create a note","event":[{"listen":"test","script":{"id":"ebe93615-ce7f-401b-ba56-7737a06fac10","exec":["// print environment","console.log(pm.globals.get(\"env\"));","","pm.test(\"response is ok\", function () {"," pm.response.to.have.status(200);"," pm.response.to.not.be.error;","});",""],"type":"text/javascript","packages":{}}}],"id":"76bdaf77-eed2-4b43-bcda-562029c648d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"content\": \"Test note 1\"}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/note","description":"

Add a note on a dossier. The content must be a string. This note will be bvisible when you get a dossier, with information like the creation date and the creator's name.

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","note"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"abe9f48a-d2e5-4301-96b0-e548cad2a57b","name":"Create a note","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"content\": \"Test note 1\"}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/note"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"dateCreation\": \"2024-10-10T09:42:03.213+00:00\",\n \"prenomNom\": \"Jean Dupont\",\n \"userOid\": 1111,\n \"contenu\": \"Test note 1\",\n \"noteOId\": 1006,\n \"dateUpdate\": null,\n \"listMentionedUsers\": null\n }\n}"}],"_postman_id":"76bdaf77-eed2-4b43-bcda-562029c648d2"},{"name":"Delete a note by id","event":[{"listen":"test","script":{"id":"a6b63377-3ba5-4cad-8a89-59c6ad2f8392","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"1fddfa97-ab53-4be0-b3b3-0d1935d0789c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"newRequiredDocuments\":[\"JUSTIF_IMM\"]\n}"},"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/note/{{note_id}}","description":"

Delete a note by id

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","note","{{note_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fddfa97-ab53-4be0-b3b3-0d1935d0789c"}],"id":"8a73bf78-58c5-48c3-b5a8-e6993054221a","description":"

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

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7d0e1c27-d0b1-4ee7-a9aa-eaf4fa845998","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b51dd459-7110-4b84-803e-6f8db8d303c5","type":"text/javascript","exec":[""]}}],"_postman_id":"8a73bf78-58c5-48c3-b5a8-e6993054221a"},{"name":"Dossier's documents","item":[{"name":"Documents","event":[{"listen":"test","script":{"id":"2943ffba-ae36-44cd-ade0-1ae7f752a7ab","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});","","",""],"type":"text/javascript","packages":{}}}],"id":"6192c2c8-4f12-4de1-97c9-88e7b7ab3d2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents","description":"

GET dossier documents by its id for a specific account.

Each document can be a file uploaded, a form filled by a third party or the depositor may have refuse to submit a document (boolean hasRefusedToFile = true).

Some information is added in the response when a document has been completed by a third party :

present: true
evidences array is composed of informations about the form filled or file uploaded : uploaded date, file size, form datas...

\n\n

First example : two required document files (one is present, the other not)

Second axample : a completed form ( with all form datas in the evidences section in the response

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","documents"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"d9d1c447-09cc-4806-ae3c-cb638b6f28a0","name":"Account dossiers with one document uploaded","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"documentId\": 11078435,\n \"dossierId\": 1324073,\n \"documentCode\": \"LST_SAL_ETR\",\n \"documentName\": \"Liste nominative des salariés étrangers soumis à autorisation de travail\",\n \"documentNameEn\": \"List of names of posted workers subjected to work permit\",\n \"requestDate\": \"2020-02-12T18:07:56.974\",\n \"present\": true,\n \"isPresent\": \"true\",\n \"statusCode\": \"VALID\",\n \"evidences\": [\n {\n \"id\": 6876412,\n \"responseId\": 2238768,\n \"uploadDate\": \"2020-10-29T11:55:46.367\",\n \"fileUUID\": \"a4d8acd5-8254-477c-9019-fa85aef8d224\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2020-10-29T11:55:46.345\",\n \"fileSize\": 128790,\n \"expirationDate\": \"2021-04-29T23:59:59.999\",\n \"formdata\": [],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {}\n }\n ]\n },\n {\n \"documentId\": 11031065,\n \"dossierId\": 1324073,\n \"documentCode\": \"FAP2\",\n \"documentName\": \"Formulaire administratif PLURIAL 2020\",\n \"documentNameEn\": \"Formulaire administratif PLURIAL 2020\",\n \"requestDate\": \"2020-02-06T10:08:46.996\",\n \"present\": false,\n \"isPresent\": \"false\",\n \"evidences\": []\n }\n ]\n}"},{"id":"069785a3-5f3b-4ad6-9593-a57e42051844","name":"Account dossiers with one document (form filled)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"documentId\": 11078435,\n \"dossierId\": 1324073,\n \"documentCode\": \"LST_SAL_ETR\",\n \"documentName\": \"Liste nominative des salariés étrangers soumis à autorisation de travail\",\n \"documentNameEn\": \"List of names of posted workers subjected to work permit\",\n \"requestDate\": \"2020-02-12T18:07:56.974\",\n \"present\": true,\n \"isPresent\": \"true\",\n \"statusCode\": \"VALID\",\n \"evidences\": [\n {\n \"id\": 6876412,\n \"responseId\": 2238768,\n \"uploadDate\": \"2020-10-29T11:55:46.367\",\n \"fileUUID\": \"a4d8acd5-8254-477c-9019-fa85aef8d224\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2020-10-29T11:55:46.345\",\n \"fileSize\": 128790,\n \"expirationDate\": \"2021-04-29T23:59:59.999\",\n \"formdata\": [\n {\n \"type\": \"string\",\n \"key\": \"f_158_nmr_0\",\n \"title\": \"Nom ou référence de l'opération\",\n \"order\": 0,\n \"value\": \"TEST\"\n },\n {\n \"type\": \"string\",\n \"key\": \"f_158_nmdc_1\",\n \"title\": \"Nom du client\",\n \"order\": 1,\n \"value\": \"AZERT\"\n },\n {\n \"type\": \"date\",\n \"key\": \"f_158_dtd_2\",\n \"title\": \"Date de réalisation\",\n \"order\": 2,\n \"value\": \"07/04/2020\"\n }\n ],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {}\n }\n ]\n },\n {\n \"documentId\": 11031065,\n \"dossierId\": 1324073,\n \"documentCode\": \"FAP2\",\n \"documentName\": \"Formulaire administratif PLURIAL 2020\",\n \"documentNameEn\": \"Formulaire administratif PLURIAL 2020\",\n \"requestDate\": \"2020-02-06T10:08:46.996\",\n \"present\": false,\n \"isPresent\": \"false\",\n \"evidences\": []\n }\n ]\n}"}],"_postman_id":"6192c2c8-4f12-4de1-97c9-88e7b7ab3d2e"},{"name":"Document details","event":[{"listen":"test","script":{"id":"17b98c28-000c-4b4c-9a6b-c38de316acce","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"5e1ea490-568c-4139-abe7-b2487f56abf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}","description":"

GET one dossier's document details by its id

Each document can be a file uploaded or a form filled by a third party.

Some information is added in the response when a document has been completed by a third party :

present: true
evidences array is composed of informations about the form filled or file uploaded : uploaded date, file size, form datas...

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","documents","{{document_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"2ae79d77-e946-4809-8cbd-6871ecfd9148","name":"Account dossiers documents details (form filled)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"documentId\": 11424746,\n \"dossierId\": 1010976,\n \"documentCode\": \"RRC\",\n \"documentName\": \"Références réalisation client\",\n \"documentNameEn\": \"Références réalisation client\",\n \"requestDate\": \"2020-04-24T15:04:01.219\",\n \"present\": true,\n \"isPresent\": \"true\",\n \"statusCode\": \"VALID\",\n \"evidences\": [\n {\n \"id\": 6647765,\n \"responseId\": 2238768,\n \"uploadDate\": \"2020-04-24T15:05:11.150\",\n \"fileUUID\": \"79e4d784-4914-4d69-b4cb-b7a8d70b4fad\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2020-04-24T15:05:11.139\",\n \"fileSize\": 81896,\n \"expirationDate\": null,\n \"formdata\": [\n {\n \"type\": \"string\",\n \"key\": \"f_158_nmr_0\",\n \"title\": \"Nom ou référence de l'opération\",\n \"order\": 0,\n \"value\": \"TEST\"\n },\n {\n \"type\": \"string\",\n \"key\": \"f_158_nmdc_1\",\n \"title\": \"Nom du client\",\n \"order\": 1,\n \"value\": \"AZERT\"\n },\n {\n \"type\": \"date\",\n \"key\": \"f_158_dtd_2\",\n \"title\": \"Date de réalisation\",\n \"order\": 2,\n \"value\": \"07/04/2020\"\n }\n ],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}"},{"id":"7ff109a1-1b95-4ec1-be22-b2d84e7e808b","name":"Account dossiers documents details (file uploaded)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"documentId\": 11078435,\n \"dossierId\": 1324073,\n \"documentCode\": \"LST_SAL_ETR\",\n \"documentName\": \"Liste nominative des salariés étrangers soumis à autorisation de travail\",\n \"documentNameEn\": \"List of names of posted workers subjected to work permit\",\n \"requestDate\": \"2020-02-12T18:07:56.974\",\n \"present\": true,\n \"isPresent\": \"true\",\n \"statusCode\": \"VALID\",\n \"evidences\": [\n {\n \"id\": 6876412,\n \"responseId\": 2238768,\n \"uploadDate\": \"2020-10-29T11:55:46.367\",\n \"fileUUID\": \"a4d8acd5-8254-477c-9019-fa85aef8d224\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2020-10-29T11:55:46.345\",\n \"fileSize\": 128790,\n \"expirationDate\": \"2021-04-29T23:59:59.999\",\n \"formdata\": [],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {}\n }\n ]\n }\n ]\n}"}],"_postman_id":"5e1ea490-568c-4139-abe7-b2487f56abf0"},{"name":"Document refused","event":[{"listen":"test","script":{"id":"17b98c28-000c-4b4c-9a6b-c38de316acce","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4d91cced-ca7c-4a63-a213-6eead8ba1dd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}?withHistoric=true","description":"

GET one dossier's document details by its id

Retrieves details of a rejected document by its ID.

Each document can be a file uploaded or a form filled by a third party.

Some information is added in the response when a document has been completed by a third party :

present: true
historicEvidences array is composed of informations about the form filled or file uploaded : uploaded date, file size, form datas...

","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","documents","{{document_id}}"],"host":["{{ea_api_serv}}"],"query":[{"key":"withHistoric","value":"true"}],"variable":[]}},"response":[{"id":"fe855629-1c27-40ea-9cf2-4c42d5142d88","name":"Account dossiers document history","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}?withHistoric=true","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","documents","{{document_id}}"],"query":[{"key":"withHistoric","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"authorizingRoles\": [],\n \"documentId\": 12344775,\n \"dossierId\": 1591140,\n \"documentCode\": \"CBT\",\n \"typeDocumentId\": 1473,\n \"documentName\": \"Test Doc name\",\n \"documentNameEn\": null,\n \"requestDate\": \"2025-09-16T16:27:41.345\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"historicEvidences\": [\n {\n \"id\": 8104569,\n \"responseId\": 8338400,\n \"uploadDate\": \"2025-09-16T16:29:09.003\",\n \"fileUUID\": \"d93cd201-440c-4ec5-84e1-5774c0234975\",\n \"fileName\": \"xxx.pdf\",\n \"fileCreation\": \"2025-09-16T16:29:08.970\",\n \"fileSize\": 8624,\n \"validityStartDate\": null,\n \"expirationDate\": \"2025-12-22T14:17:13.791\",\n \"format\": \"NA\",\n \"issuer\": \"FOURNISSEUR\",\n \"transmitter\": \"FOURNISSEUR\",\n \"specificData\": null,\n \"metadata\": {\n \"ai_result\": \"false\",\n \"from_external_portal\": \"false\",\n \"depositor\": \"Florian Peuteuil\",\n \"smart_check_fail\": \"false\",\n \"code_securite_hand_written\": \"false\"\n },\n \"formdata\": [\n {\n \"type\": \"checkbox\",\n \"key\": \"f_1473_vc_0\",\n \"title\": \"Avec quelles équipes travailles tu ?\\n\\n\",\n \"fieldId\": \"791d4116-4228-4755-91fc-e15d77a660da\",\n \"order\": 0,\n \"hasPriority\": false,\n \"value\": \"Team Produit\"\n },\n {\n \"type\": \"unknown\",\n \"key\": \"f_1473_frf_3\",\n \"title\": \"Forfait annul est de :\\n\",\n \"fieldId\": \"e9f5b567-8d33-4862-8785-78e00b1f60c1\",\n \"order\": 3,\n \"hasPriority\": false,\n \"value\": \"5000 EUR - Euro\"\n },\n {\n \"type\": \"unknown\",\n \"key\": \"f_1473_ql_4\",\n \"title\": \"Quel sport préfères tu vraiment ?\\n\",\n \"fieldId\": \"b81cbc1d-99e8-42da-b699-8cf46f6a5254\",\n \"order\": 4,\n \"hasPriority\": false,\n \"value\": \"Aprovall Padel Club\"\n },\n {\n \"type\": \"string\",\n \"key\": \"f_1473_cmm_5\",\n \"title\": \"Comment s'appelle ton collègue ?\\n\\n\",\n \"fieldId\": \"0a0cfc9b-6762-4369-8950-88d60e95463a\",\n \"order\": 5,\n \"hasPriority\": false,\n \"value\": \"Elodie\"\n },\n {\n \"type\": \"email\",\n \"key\": \"f_1473_ql_6\",\n \"title\": \"Quel est ton email ?\\n\\n\",\n \"fieldId\": \"644bf080-9519-4352-97f6-f9abba4311ac\",\n \"order\": 6,\n \"hasPriority\": false,\n \"value\": \"bbb@aprovall.com\"\n },\n {\n \"type\": \"email\",\n \"key\": \"f_1473_qll_7\",\n \"title\": \"Quelle est l'adresse email de votre RSSI ? \\n\",\n \"fieldId\": \"b4d11bfa-044c-463a-a9d8-5526bb34d83d\",\n \"order\": 7,\n \"hasPriority\": false,\n \"value\": \"aaa@aprovall.com\"\n },\n {\n \"type\": \"checkbox\",\n \"key\": \"f_1473_qll_8\",\n \"title\": \"Quelles sont les actions que vous menez en matière d'éthique ? \\n\",\n \"fieldId\": \"93e96e87-e758-425e-be12-375e79c532ca\",\n \"order\": 8,\n \"hasPriority\": false,\n \"value\": \"Equité\"\n },\n {\n \"type\": \"checkbox\",\n \"key\": \"f_1473_qls_9\",\n \"title\": \"quels sont vos certif ?\\n\",\n \"fieldId\": \"8d5041c5-6edd-4921-9edd-0ffe87754915\",\n \"order\": 9,\n \"hasPriority\": false,\n \"value\": \"A\"\n }\n ],\n \"acquisition\": null,\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"enableBelowExpectationStatus\": false,\n \"hasRefusedToFile\": false\n }\n ],\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n }\n ]\n}"}],"_postman_id":"4d91cced-ca7c-4a63-a213-6eead8ba1dd7"}],"id":"628b01e4-a79b-43dd-a994-5ab74c8d7ec2","_postman_id":"628b01e4-a79b-43dd-a994-5ab74c8d7ec2","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Dossier's Evidences & Files","item":[{"name":"Evidences","event":[{"listen":"test","script":{"id":"e36569f5-4a9b-49a0-bfef-5cafafc9605c","exec":["var jsonData = JSON.parse(responseBody);","","pm.environment.set(\"fileId\", jsonData.content[0].fileId);","","pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"ba99d2d4-d329-4ea6-92ee-65fce6262fde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files","description":"

GET one dossier's document evidence ( file or form filled) by its id

This endpoint return all datas from completed form or uploaded files

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","documents","{{document_id}}","files"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"47867ec3-6d0f-47cf-9fa7-94e03dafb5bb","name":"Evidences (file uploaded)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{documentId}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 6876412,\n \"responseId\": 2238768,\n \"uploadDate\": \"2020-10-29T11:55:46.367\",\n \"fileUUID\": \"a4d8acd5-8254-477c-9019-fa85aef8d224\",\n \"fileCreation\": \"2020-10-29T11:55:46.345\",\n \"fileSize\": 128790,\n \"expirationDate\": \"2021-04-29T23:59:59.999\",\n \"formdata\": [],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {}\n }\n ]\n}"},{"id":"cf7e3ddd-520a-4343-b6f0-d97699ab0238","name":"Evidences (form filled)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{documentId}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 6647765,\n \"responseId\": 2238768,\n \"uploadDate\": \"2020-04-24T15:05:11.150\",\n \"fileUUID\": \"79e4d784-4914-4d69-b4cb-b7a8d70b4fad\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2020-04-24T15:05:11.139\",\n \"fileSize\": 81896,\n \"expirationDate\": null,\n \"formdata\": [\n {\n \"type\": \"string\",\n \"key\": \"f_158_nmr_0\",\n \"title\": \"Nom ou référence de l'opération\",\n \"order\": 0,\n \"value\": \"TEST\"\n },\n {\n \"type\": \"string\",\n \"key\": \"f_158_nmdc_1\",\n \"title\": \"Nom du client\",\n \"order\": 1,\n \"value\": \"AZERT\"\n },\n {\n \"type\": \"date\",\n \"key\": \"f_158_dtd_2\",\n \"title\": \"Date de réalisation\",\n \"order\": 2,\n \"value\": \"07/04/2020\"\n }\n ],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {}\n }\n ]\n}"},{"id":"1a63294e-211e-4091-8bcc-b329ed9cb7e3","name":"IBAN with SID-ID response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{documentId}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 8336764,\n \"responseId\": 2238768,\n \"uploadDate\": \"2021-02-15T09:59:50.395\",\n \"fileUUID\": \"b7252553-4474-40df-bf25-e185a3630738\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2021-02-15T09:59:50.392\",\n \"fileSize\": 43251,\n \"expirationDate\": null,\n \"formdata\": [\n {\n \"type\": \"iban\",\n \"key\": \"f_49_bn_0\",\n \"title\": \"IBAN\",\n \"order\": 0,\n \"value\": \"FR76 0000 0000 0000 0000 0000 000\"\n }\n ],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {\n \"bank_data_country_iso\": \"FR\",\n \"bank_data_bank\": \"CREDIT DU NORD\",\n \"sepa_data_cor1\": \"YES\",\n \"sis_id\": {\n \"createdBy\": \"503829368\",\n \"createdDate\": \"2021-06-22T18:00:53.593+00:00\",\n \"lastModifiedBy\": \"503829368\",\n \"lastModifiedDate\": \"2021-06-22T18:00:55.339+00:00\",\n \"id\": \"60d2255563245f2fa6d15231\",\n \"score\": 100,\n \"status\": \"SUCCEEDED\",\n \"entity\": {\n \"company\": {\n \"createdDate\": \"2021-06-22T18:00:53.535+00:00\",\n \"lastModifiedDate\": \"2021-06-22T18:00:53.535+00:00\",\n \"registrationId\": \"123456789\",\n \"name\": \"COMPANY NAME\",\n \"typeId\": \"4\"\n },\n \"createdDate\": \"2021-06-22T18:00:53.535+00:00\",\n \"lastModifiedDate\": \"2021-06-22T18:00:53.535+00:00\"\n },\n \"issuerCompany\": {\n \"createdDate\": \"2021-06-22T18:00:55.611+00:00\",\n \"lastModifiedDate\": \"2021-06-22T18:00:55.611+00:00\",\n \"id\": \"503829368\",\n \"registrationId\": \"503829368\",\n \"name\": \"E-ATTESTATIONS.COM\",\n \"typeId\": \"4\"\n },\n \"withDeferredResult\": true,\n \"byAPI\": true,\n \"workflow\": \"PING\",\n \"reasons\": [\n \"S-NR\",\n \"I-NR\",\n \"CLH-SINR\",\n \"COH-SR\",\n \"SD-V\"\n ],\n \"nbAudits\": 0,\n \"reasonLabels\": {\n \"sepamail.code.01001\": \"01001 (Compte existant et valide).\",\n \"sepamail.status.VERIFIED\": \"Les coordonnées bancaires et la société sont vérifiées par le service SEPAmail DIAMOND.\",\n \"sepamail.code.03001\": \"03001 (SIREN correct).\",\n \"sepamail.code.02001\": \"02001 (Type de titulaire du compte correct).\",\n \"reason.code.SD-V\": \"Les coordonnées bancaires et la société sont vérifiées par le service SEPAmail DIAMOND.\",\n \"reason.code.COH-SR\": \"Analyse de l'historique de paiement de la communauté : société connue mais coordonnées bancaires inconnues.\",\n \"reason.code.I-NR\": \"Coordonnées bancaires non ajoutées sur la plateforme.\",\n \"reason.code.CLH-SINR\": \"Analyse de votre historique de paiement : société et coordonnées bancaires inconnues.\",\n \"reason.code.S-NR\": \"Société non enrôlée sur la plateforme.\"\n }\n },\n \"verified\": \"true\",\n \"sepa_data_sct\": \"YES\",\n \"bank_data_country\": \"FRANCE\",\n \"bank_data_address\": \"240 244 AV PIERRE\",\n \"bank_data_account\": \"111111111\",\n \"bank_data_phone\": \"\",\n \"bank_data_zip\": \"75001\",\n \"bank_data_city\": \"PARIS\",\n \"bank_data_bic\": \"NORDXXXX\",\n \"bank_data_fax\": \"\",\n \"sepa_data_b2b\": \"YES\",\n \"bank_data_www\": \"\",\n \"sepa_data_scc\": \"YES\",\n \"sepa_data_sdd\": \"YES\",\n \"date_verification\": \"15/02/2021\",\n \"bank_data_email\": \"\"\n }\n }\n ]\n}"},{"id":"51b47b8b-e156-41c9-b8fc-2686cf547a7f","name":"IBAN with Trustpair response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{documentId}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 8336764,\n \"responseId\": 2238768,\n \"uploadDate\": \"2021-02-15T09:59:50.395\",\n \"fileUUID\": \"b7252553-4474-40df-bf25-e185a3630738\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2021-02-15T09:59:50.392\",\n \"fileSize\": 43251,\n \"expirationDate\": null,\n \"formdata\": [\n {\n \"type\": \"iban\",\n \"key\": \"f_49_bn_0\",\n \"title\": \"IBAN\",\n \"order\": 0,\n \"value\": \"FR76 0000 0000 0000 0000 0000 000\"\n }\n ],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {\n \"bank_data_country_iso\": \"FR\",\n \"bank_data_bank\": \"CREDIT DU NORD\",\n \"sepa_data_cor1\": \"YES\",\n \"trustpair\": {\n \"company_country_code\": \"FR\",\n \"company_registration\": \"123456789\",\n \"iban\": \"FR7600000000000000000000000\",\n \"bank_account_bic\": \"XXXXXXXXXXX\",\n \"state\": \"favorable\",\n \"state_reasons\": {\n \"company\": {\n \"state\": \"favorable\",\n \"state_reasons\": [\n \"La société est en activité\"\n ]\n },\n \"bank_account\": {\n \"state\": \"favorable\",\n \"state_reasons\": [\n \"Le compte bancaire est valide\"\n ]\n },\n \"correlation\": {\n \"state\": \"favorable\",\n \"state_reasons\": [\n \"Le compte bancaire appartient à la société\"\n ]\n }\n },\n \"created_at\": \"2021-05-19T15:45:52.128+00:00\",\n \"updated_at\": \"2021-05-19T16:18:38.208+00:00\"\n },\n \"verified\": \"true\",\n \"sepa_data_sct\": \"YES\",\n \"bank_data_country\": \"FRANCE\",\n \"bank_data_address\": \"240 244 AV PIERRE\",\n \"bank_data_account\": \"111111111\",\n \"bank_data_phone\": \"\",\n \"bank_data_zip\": \"75001\",\n \"bank_data_city\": \"PARIS\",\n \"bank_data_bic\": \"NORDXXXX\",\n \"bank_data_fax\": \"\",\n \"sepa_data_b2b\": \"YES\",\n \"bank_data_www\": \"\",\n \"sepa_data_scc\": \"YES\",\n \"sepa_data_sdd\": \"YES\",\n \"date_verification\": \"15/02/2021\",\n \"bank_data_email\": \"\"\n }\n }\n ]\n}"},{"id":"98f1a793-8d81-42d4-844d-3a86b9d06dcc","name":"Vigilance declaration response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{documentId}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 8709434,\n \"responseId\": 2238768,\n \"uploadDate\": \"2021-04-20T13:46:15.470\",\n \"fileUUID\": \"3d0c446a-21be-4a06-b272-0d23e4e8812c\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2021-04-20T13:46:15.466\",\n \"fileSize\": 56831,\n \"expirationDate\": \"2021-09-30T23:59:59.999\",\n \"formdata\": [],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {\n \"siren\": \"147258369\",\n \"derniere_periode_analysee_urssaf\": \"mois de mars 2021\",\n \"code_securite\": \"XXXXXXXXXXX\",\n \"verified\": \"true\",\n \"effectif_urssaf\": \"0\",\n \"date_verification\": \"20/04/2021\",\n \"siret\": \"[\\\"12345678912345\\\"]\",\n \"date_certification\": \"19/04/2021\",\n \"masse_salariale_urssaf\": \"999\"\n }\n }\n ]\n}"},{"id":"c12ae81a-818a-4c67-9ca7-7eabc3ff3cd1","name":"Registration Certificate response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{documentId}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 8192711,\n \"responseId\": 2238768,\n \"uploadDate\": \"2021-01-22T00:22:40.662\",\n \"fileUUID\": \"e4fc79fb-6a07-4242-885c-1f742916795a\",\n \"fileName\": \"filename.pdf\",\n \"fileCreation\": \"2021-01-22T00:22:40.654\",\n \"fileSize\": 81388,\n \"expirationDate\": \"2021-07-22T23:59:59.999\",\n \"formdata\": [],\n \"format\": \"ORIGINALNUMERIQUE\",\n \"issuer\": \"DO\",\n \"transmitter\": \"FOURNISSEUR\",\n \"metadata\": {\n \"siren\": \"123456789\",\n \"date_certification\": \"21/01/2021\"\n }\n }\n ]\n}"}],"_postman_id":"ba99d2d4-d329-4ea6-92ee-65fce6262fde"},{"name":"File download (binary format)","event":[{"listen":"test","script":{"id":"c77d159a-38a3-4212-9372-940d55957acf","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"75f79178-da30-487b-a3e7-9400e3627907","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/{{file_id}}","description":"

GET one file content from the given dossierId, documentId and fileId

The content is a PDF file to download. With Postman you can see the content.

For a form filled, e-Attestations produces a PDF with all third party's responses

You can see the document directly in Postman :

\n\n

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","documents","{{document_id}}","files","{{file_id}}"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"75f79178-da30-487b-a3e7-9400e3627907"},{"name":"File download Copy (auto signed URL)","event":[{"listen":"test","script":{"id":"c77d159a-38a3-4212-9372-940d55957acf","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"784a4ebe-e3c6-4c1e-a2a8-bef3df1878ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/{{file_id}}/link","description":"

Generate an auto signed URL for downloading the evidence file

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","documents","{{document_id}}","files","{{file_id}}","link"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"9a4498ca-7b2d-4b5f-94e5-a73ad6af7474","name":"File download Copy (auto signed URL)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/documents/{{document_id}}/files/{{file_id}}/link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": \"https://AUTO_SIGNED_URL.COM\"\n}"}],"_postman_id":"784a4ebe-e3c6-4c1e-a2a8-bef3df1878ae"},{"name":"File download all files for this dossier","event":[{"listen":"test","script":{"id":"c77d159a-38a3-4212-9372-940d55957acf","exec":["pm.test(\"Verify if response is HTTP 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{}}}],"id":"2c3800d4-66d4-4a6a-bda4-48931a2117a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/files/download","description":"

GET all files for a dossier.

The content is an url to download a zip file containing the files.

\n","urlObject":{"path":["api","v1","account","{{account_id}}","dossiers","{{dossier_id}}","files","download"],"host":["{{ea_api_serv}}"],"query":[],"variable":[]}},"response":[{"id":"cd0df01f-2708-46ad-a801-13cb2ad49f14","name":"File download all files for this dossier","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/octet-stream","type":"text"}],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/{{dossier_id}}/files/download"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": \"\\\"https://ea-test-application-data.s3.eu-west-1.amazonaws.com/35586982-6fcc-4cf6-8cb6-dd436ffd5cdb.zip?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMH%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJGMEQCIExUp1KIjm0Tji%2Fjbn32I7nSds3T%2FfxGQHxGGZHKFHfkAiAbPBZfxwUrGCw%2Bo7FivAIMfG0ZP5NGxQRwvdK3ITHDPSrzAwhKEAIaDDA4ODc4MjM5MjQ4MSIMGmy74eqYfQgclpJCKtADz7v9Hfn1V8PXPjDRkSfH1emXo6WHa7WPa5c1sB%2Bi49YqY2sPb0EEUZFXZ7%2BLimiY7pJJAzMznee7z6VH2uCdOCjdoKm9%2FSHdu8yps4WFk7XiA1HIfeEReZ%2B43a2yA%2FdxNB9Fdhl5A%2Fq4jx2udkwwPt58gwfzl3ilkQTgVwml6JGVWwfPotB0g18p3vdr3Sz%2FYEY%2Ba52A2EvjucMZ3hpr8l26wOaKhdFqXSjf5HKafKL9DasYNWkTKw3SZIW1fjgqa13Sa%2FBpCemsGEzkqqa08nWvf1%2BVkT281gxd5wfxpUu5i4a0FuOZ3lFmCh%2FT4I1B5oTfZqzeeD5nP6NS9hMeFcDzSi3hBZsLEhhRcppSLK4R%2Fge4g7qqdCG8ptVXonu0jh%2BxtGUeg8h2R3A7YIrWD1lRSt4pVEPFS6uNd%2FGzbcWar51wtiTc4QgXqM5gIxYbZO7%2F85ASzSdlE6vQpPWkgfBCL%2BqTrBxkw%2BeQhu%2Frkgy6BJOTr5RMMWc%2BNr%2BchEFNVAvXI4y7TGiS9UbWIuVqXQjWka1GjMcl3pW5TLXqbQ9i9xqj52s1MMCUPTiVqyxDXQBpJ8SkPbQdTSC%2F2AIRVKrgisUqs1RkOfTunJV%2BH%2BAww5PtkQY6pgFpaBWquCwVMFdgpR28WVcLSBQC%2FDXtFRNxlVTHRGijy%2BmJJNHv5JDNmQ2FMPeMfl7yOCHVvy9jZHfWM0kVSCpqQja3RTkxHfTNqBqKItQdtApsro81pKQ%2FTv0vYzF%2FZ7NS83cjjFxLRfCYB0N2Im5Be%2BUKYxOoVBp%2Fhs9asAb%2B6kXr00FPvQKRokLgI3ZNYu59GK8dIGUg4qaOULeVoKFNTy7VgLOG&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220323T164931Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=ASIARJK6XZSQWCWT3QMV%2F20220323%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=974ec0f7ab1c8e9eccc044e5fdd725ab02eaa8e86549cd9af0209f7c5447c7fa\\\"\"\n}"}],"_postman_id":"2c3800d4-66d4-4a6a-bda4-48931a2117a5"}],"id":"0bdb4142-fd35-46ac-a2ed-0412ab71957b","description":"

get all evidences :

a form filled
a document fetched
a document uploaded

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

\n","_postman_id":"0bdb4142-fd35-46ac-a2ed-0412ab71957b","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Documents","item":[{"name":"Get documents informations","id":"c6a7a89d-6952-4058-a4b0-4c0c22372a33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/documents/search?page=0&pageSize=10&documentCode=RIB_IBAN","description":"

Search for documents by criteria and events

Search for documents by criteria and events.

This endpoint allows you to retrieve a filtered list of documents based on various criteria including third party, dossier, document code, and event history.

It provides a global search across all documents in your account, without requiring you to navigate through individual dossiers. The response contains document information with detailed evidence data.

The result is paginated with 10 entries per page by default.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`thirdPartyId`	integer	No	Filter documents by third party identifier
`dossierId`	integer	No	Filter documents by dossier identifier
`documentCode`	string	No	Filter documents by document code (e.g., \"KBIS\", \"RC_PRO\"). List of codes available with this endpoint : Requirements for the account
`page`	integer	No	The number of the page you want to access (default is 0)
`pageSize`	integer	No	The number of results returned per page (default is 10)
`eventNames`	array of strings	No	Filter documents that have specific events in their history. You can specify one or more event types separated by commas. See available event types here : https://developers.aprovall.com/guides/dictionary/events
`eventOccurrenceStartDate`	datetime (ISO-8601)	No	Start date for filtering events. Format: `yyyy-MM-dd'T'HH:mm:ss` (e.g., \"2024-01-01T00:00:00\")
`eventOccurrenceEndDate`	datetime (ISO-8601)	No	End date for filtering events. Format: `yyyy-MM-dd'T'HH:mm:ss` (e.g., \"2024-12-31T23:59:59\")

","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}},"urlObject":{"path":["api","v1","account","{{account_id}}","documents","search"],"host":["{{ea_api_serv}}"],"query":[{"key":"page","value":"0"},{"key":"pageSize","value":"10"},{"key":"documentCode","value":"RIB_IBAN"}],"variable":[]}},"response":[{"id":"3100735c-bdb9-4d8a-a058-fa9c6f9a832d","name":"Get documents informations","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/documents/search?page=0&rowPerPage=10&documentCode=RIB_IBAN","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","documents","search"],"query":[{"key":"page","value":"0"},{"key":"rowPerPage","value":"10"},{"key":"documentCode","value":"RIB_IBAN"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"content\": [\n {\n \"authorizingRoles\": [],\n \"documentId\": 12171882,\n \"dossierId\": 1500943,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-10-21T09:03:38.882\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"MISSING\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169533,\n \"dossierId\": 1578488,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:56:55.506\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169535,\n \"dossierId\": 1578573,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:57:06.898\",\n \"requestEndDate\": \"2025-08-15T22:00:15.391\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 11727976,\n \"dossierId\": 1510900,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2021-08-03T11:53:14.330\",\n \"requestEndDate\": \"2021-11-16T10:01:15.022\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"MISSING\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169538,\n \"dossierId\": 1575716,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:57:21.768\",\n \"requestEndDate\": \"2025-03-04T15:55:42.054\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"ACTION_REQUIRED\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169537,\n \"dossierId\": 1523631,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:57:16.481\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169526,\n \"dossierId\": 1541475,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:56:06.761\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169530,\n \"dossierId\": 1532067,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:56:38.702\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169540,\n \"dossierId\": 1534888,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:57:31.690\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n },\n {\n \"authorizingRoles\": [],\n \"documentId\": 12169527,\n \"dossierId\": 1542728,\n \"documentCode\": \"RIB_IBAN\",\n \"typeDocumentId\": 49,\n \"documentName\": \"Coordonnées bancaires\",\n \"documentNameEn\": \"International Bank Account Number (IBAN)\",\n \"requestDate\": \"2024-09-23T15:56:15.807\",\n \"present\": false,\n \"hasRefusedToFile\": false,\n \"isPresent\": \"false\",\n \"depositor\": null,\n \"evidences\": [],\n \"statusCode\": \"NOT_VALID\",\n \"smartControlActivated\": false,\n \"smartControlV2\": false,\n \"acquisition\": null\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 83\n}"}],"_postman_id":"c6a7a89d-6952-4058-a4b0-4c0c22372a33"}],"id":"8f8fca16-aa34-4bd4-b991-3d72b32eeddb","_postman_id":"8f8fca16-aa34-4bd4-b991-3d72b32eeddb","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Documents actions","item":[{"name":"Approve a document","id":"b7cee031-32f6-4c9e-9b9c-8acab47e2af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"comment\":\"OK\"\n}","options":{"raw":{"language":"json"}}},"url":"https://edge.qa-e-attestations.com/api/v1/account/{{account_id}}/responses/{{responseId}}/approve","description":"

If the document status is \"action required\", you can approve it with an optional reason.

URL parameter : responseId is present in the evidences JSON part

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Mandatory	Type	Description
comment	no	String	optional reason

If the document status is \"action required\", you can refuse it with an optional reason.

URL parameter : responseId is present in the evidences JSON part

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Mandatory	Type	Description
comment	no	String	optional reason
shareRejectionReason	yes	Boolean	If set to true, the third party will be notified by email of the document rejection.

Paginated and filtered search of third parties for an account with filters on countries, custom attributes, indicators, and scores. Allows retrieval of detailed information including rating data (ESG scores, financial, security, etc.) and business attributes.

Endpoint: POST /api/v1/account/{accountId}/thirdparties/advanced-search

Parameters

Path Parameters

accountId (Long, required) - Unique identifier of the prime contractor account

Query Parameters

page (int, optional, default: 0) - Page number (starts at 0)

rowPerPage (int, optional, default: 50) - Number of results per page

onboarded (Boolean, optional) - Filter on onboarded third parties (true) or archived (false)

Request Body

Main Structure

filters (Object, required) - Object containing filtering criteria

filters.thirdparties (Array, required) - List of third party search filters

Available Filters in thirdparties[]

🔍 Identification

name (String) - Third party name (partial search, case-insensitive)

code (String) - Custom third party code

companyIdType (String) - Company identifier type. Possible values:

\"CIT001\" : Identifier (SIREN or SIRET)
\n
\"CIT002\" : VAT number
\n
\"CIT003\" : DUNS
\n

identifier (String) - Company identifier value (used with companyIdType)

🌍 Geography and Activity

countries (Array) - List of ISO Alpha-2 country codes (\"FR\", \"DE\", \"IT\", etc.)

departments (Array) - French department codes (\"75\", \"92\", \"2A\", \"2B\", etc.)

majorActivities (Array) - Main activity sector codes (major APE codes)

📊 Status and Qualification

contacts (Array) - ⚠️ WARNING: Despite its name, this parameter filters on the third party's registration status. Possible values (lowercase):

\"subscribed\" : Registered third party
\n
\"invited\" : Invited third party
\n
\"not_invited\" : Not invited third party
\n

complete (Boolean) - Third party with complete data

true : Third party in COMPLET state
\n
false : Third party in INCOMPLET or SANS_CONTRAT_EN_COURS state
\n

unmanaged (Boolean) - Filter on data origin

true : Unmanaged third parties (origin UNMANAGED)
\n
false : Managed third parties (origin DNB or ALTARES)
\n

🏷️ Business Attributes and Indicators

attributes (Map>) - Filters on custom attributes

Key: Attribute name (label)
\n
Value: List of accepted values (OR operator between values)
\n

calculatedAttributes (Map>) - Filters on calculated attributes

Key: Calculated attribute name
\n
Value: List of values
\n

indicators (Map>) - Filters on calculated indicators

Key: Indicator name
\n
Value: List of values or ranges (e.g., [\"0-50\", \"51-100\"])
\n

⭐ Scores and Ratings

scores (Object, optional) - Filters on rating scores

Transparency Scores

transparency (Array) - Transparency level by country

Values: \"HIGH\", \"MEDIUM\", \"LOW\", \"NP\" (not published)

Financial Scores

financialStrengthScore (Array) - Financial risk segment

Values: \"LOW_RISK\", \"MEDIUM_RISK\", \"HIGH_RISK\"

financialStrengthRating (Array) - Financial rating (e.g., [\"N1\", \"N2\"])

\n\n

esgScore (Array) - Overall ESG scores (0-100)

esgDepth (Array) - ESG data depth

Values: \"A\", \"B\", \"C\", \"D\"

esgRiskEnvironment (Array) - Environmental risk score (0-100)

esgRiskSocial (Array) - Social risk score (0-100)

esgRiskGovernance (Array) - Governance risk score (0-100)

Other Scores

indued (Map>) - Indued scores (due diligence)

Key: Indued score identifier
\n
Value: List of severities
\n

ecovadis (Map>) - EcoVadis scores (CSR)

Key: EcoVadis score identifier
\n
Value: List of performances
\n

securityRating (Map>) - Cybersecurity scores

Key: Score identifier
\n
Value: List of values
\n

creditsafe (Map>) - Creditsafe scores (credit)

Key: Creditsafe score identifier
\n
Value: List of values
\n

🔌 External Sources

dataHub (Map>) - Filters on external DataHub data

Key: DataHub field ID (as string)
\n
Value: List of accepted values
\n

🔧 Sorting and Display Options

sort (Map, optional) - Result sorting

Key: Field name to sort by
\n
Value: Sort direction (\"asc\" or \"desc\")
\n
Example: {\"followingDate\": \"desc\", \"name\": \"asc\"}
\n
Special supports:
\n
- \"attribute-{label}\" : Sort by custom attribute
  \n
- \"indicator-{label}\" : Sort by indicator
  \n
- \"calculatedAttribute-{label}\" : Sort by calculated attribute
  \n
\n

outputs (Array, optional) - Additional data to include in response

Possible values:
\n
- \"scores\" : Include all rating scores
  \n
- \"attributes\" : Include detailed attribute values
  \n
- \"calculatedAttributes\" : Include calculated attributes
  \n
- \"indicators\" : Include indicators
  \n
\n
Important: Without this option, only basic data is returned
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}},"urlObject":{"path":["api","v1","account","{{account_id}}","thirdparties","advanced-search"],"host":["{{ea_api_serv}}"],"query":[{"key":"page","value":"0"},{"key":"rowPerPage","value":"50"},{"key":"onboarded","value":"true"}],"variable":[]}},"response":[{"id":"c693c509-2c99-47a2-a3c8-33b256f492ab","name":"Third parties","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filters\":{\n \"thirdparties\":[\n {\n \"scores\":{\n \n },\n \"countries\":[\n \"FR\"\n ],\n \"attributes\":{\n \"E. Intervention on site\":[\n \"true\"\n ],\n \"F. Third party statuts\":[\n \"Customer\"\n ]\n }\n }\n ]\n },\n \"sort\":{\n \"followingDate\":\"desc\"\n },\n \"outputs\":[\n \"scores\",\n \"attributes\",\n \"calculatedAttributes\",\n \"indicators\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{ea_api_serv}}/api/v1/account/{{account_id}}/thirdparties/advanced-search?onboarded=true&page=0&rowPerPage=50","host":["{{ea_api_serv}}"],"path":["api","v1","account","{{account_id}}","thirdparties","advanced-search"],"query":[{"key":"onboarded","value":"true"},{"key":"page","value":"0"},{"key":"rowPerPage","value":"50"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"content\": [\n {\n \"authorizingRoles\": [],\n \"thirdpartyId\": 12345,\n \"accountId\": 100001,\n \"companyIdType\": \"CIT001\",\n \"siret\": \"12345678900012\",\n \"siren\": \"123456789\",\n \"tva\": \"FR12123456789\",\n \"legalCategoryLabel\": \"SASU Société par actions simplifiée à associé unique\",\n \"legalCategoryCode\": null,\n \"activityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"activityCode\": \"7022Z\",\n \"etabActivityCode\": \"7022Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Conseil pour les affaires et autres conseils de gestion\",\n \"principals\": null,\n \"workforce\": 1072,\n \"monitored\": true,\n \"onboarded\": true,\n \"unmanaged\": false,\n \"headquarter\": true,\n \"companyIdValue\": \"12345678900012\",\n \"thirdpartyCode\": null,\n \"name\": \"ACME CONSULTING SAS\",\n \"address\": \"123 RUE DE LA PAIX\",\n \"addressCity\": \"PARIS\",\n \"addressPostCode\": \"75001\",\n \"addressCountryCode\": \"FR\",\n \"registered\": true,\n \"registrationStatus\": \"subscribed\",\n \"active\": true,\n \"followingDate\": \"2024-11-21\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"complete\": true,\n \"thirdpartyUsers\": null,\n \"listRegistrationNumber\": [],\n \"attributeValues\": [\n {\n \"id\": 1001,\n \"attributeId\": 1086,\n \"label\": \"C. Criticité\",\n \"type\": \"boolean\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": \"2024-11-21T10:41:57.153+00:00\",\n \"updateDate\": \"2024-11-21T10:45:44.071+00:00\",\n \"isRequired\": null,\n \"values\": [\n \"true\"\n ],\n \"ctxModelId\": null,\n \"referencingCalculations\": null\n }\n ],\n \"majorFr\": \"Services\",\n \"majorEn\": \"Services\",\n \"majorCode\": \"I\",\n \"scores\": {\n \"datablocks_financial_strength\": {\n \"rating\": \"N2\",\n \"riskLevel\": \"low\"\n },\n \"datablocks_esg\": {\n \"score\": \"2\",\n \"esgDataDepth\": \"A\",\n \"environmentalRankingScore\": 2,\n \"socialRankingScore\": 3,\n \"governanceRankingScore\": 2,\n \"noDataAvailable\": false\n },\n \"security_rating\": {\n \"reference\": null,\n \"account_reference\": null,\n \"company_reference\": null,\n \"cartography_reference\": null,\n \"date\": null,\n \"activity_v3\": null,\n \"audit_type\": null,\n \"asset_count\": null,\n \"score\": null,\n \"attack_surface_score\": null,\n \"mail_score\": null,\n \"web_score\": null,\n \"vulnerability_score\": null,\n \"vulnerability_snapshot_score\": null,\n \"security_control_score\": null,\n \"security_incident_score\": null,\n \"global_score\": null,\n \"sector_score\": null,\n \"rating_period\": null,\n \"ip_providers\": null,\n \"activity_ip_providers\": null,\n \"all_ip_providers\": null,\n \"segments\": null,\n \"asset_size\": null,\n \"maturity_level\": null\n },\n \"ecovadis\": {\n \"ev_data\": null,\n \"error\": null,\n \"error_message\": null,\n \"main_integration_id\": null\n },\n \"creditsafe\": {\n \"companyId\": null,\n \"date\": null,\n \"internationalScore\": null,\n \"previousInternationalScore\": null,\n \"nationalScoreValue\": null,\n \"nationalScoreMax\": null,\n \"creditLimit\": null,\n \"creditLimitValue\": null,\n \"creditLimitCurrency\": null,\n \"companyExposure\": null,\n \"activityExposure\": null,\n \"preferentialStatus\": null,\n \"dbt\": null,\n \"financialStrength\": null,\n \"countryCode\": null,\n \"error\": null\n },\n \"indued\": {\n \"due_diligence_id\": \"1234567\",\n \"due_diligence\": {\n \"status\": \"fpm_in_progress\",\n \"fpm_url\": \"https://...\",\n \"compliance_score\": 7,\n \"country_score\": 1,\n \"activity_score\": 2,\n \"state\": \"active\",\n \"pep_score\": 1,\n \"sanctions_score\": 1,\n \"adverse_media_score\": 3,\n \"risk_event_score\": 3,\n \"report_url\": null,\n \"risk_level\": 3,\n \"workflow_status\": null,\n \"failure_score\": null,\n \"creation_time\": \"2024-11-21T10:41:59.895+00:00\",\n \"report_time\": null,\n \"screening_time\": \"2024-11-21T10:42:17.482+00:00\",\n \"enrichment_time\": \"2024-11-21T10:42:10.340+00:00\"\n },\n \"report_id\": null,\n \"report_data\": null,\n \"created_date\": \"2024-11-21T10:41:59.451+00:00\",\n \"error\": null\n }\n },\n \"calculatedAttributes\": [\n {\n \"id\": 4001,\n \"calculationId\": 99,\n \"name\": \"Profil de Risque\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"Risque Moyen\",\n \"resultColorCode\": \"#fcb900\",\n \"resultLastUpdateDate\": \"2024-11-21T10:41:57.308+00:00\",\n \"nature\": \"CALCULATED_ATTRIBUTE\",\n \"targetResourceType\": \"THIRD_PARTY\",\n \"targetResourceId\": 12345\n }\n ],\n \"indicators\": [\n {\n \"id\": 5001,\n \"calculationId\": 101,\n \"name\": \"Risque Financier\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"Risque Faible\",\n \"resultColorCode\": \"#00d084\",\n \"resultLastUpdateDate\": \"2024-11-21T10:45:45.975+00:00\",\n \"nature\": \"INDICATOR\",\n \"targetResourceType\": \"THIRD_PARTY\",\n \"targetResourceId\": 12345\n }\n ],\n \"transparencyScore\": 67,\n \"duns\": \"123456789\",\n \"dateCreation\": \"2012-02-29\",\n \"companyStartDate\": \"2002-08-01\",\n \"companyClosedDate\": null,\n \"acronym\": null,\n \"brandName\": null,\n \"addressingName\": \"ACME CONSULTING SAS\",\n \"capital\": 14300000,\n \"capitalCurrency\": \"EUR\",\n \"ceo\": null,\n \"turnover\": 224524062,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2024-12-31\",\n \"addressStreet\": \"123 RUE DE LA PAIX\",\n \"etabPhoneNumber\": \"0123456789\",\n \"website\": null,\n \"category\": \"ETI\",\n \"subCategory\": \"AE\",\n \"hasRestrictedDisclosure\": false,\n \"dunsEncrypted\": false\n },\n {\n \"authorizingRoles\": [],\n \"thirdpartyId\": 67890,\n \"accountId\": 100001,\n \"companyIdType\": \"CIT001\",\n \"siret\": \"98765432100012\",\n \"siren\": \"987654321\",\n \"tva\": \"FR98987654321\",\n \"legalCategoryLabel\": \"Société par actions simplifiée\",\n \"legalCategoryCode\": null,\n \"activityLabel\": \"Activités des agences de travail temporaire\",\n \"activityCode\": \"7820Z\",\n \"etabActivityCode\": \"7820Z\",\n \"etabActivityType\": \"CODE_APE\",\n \"etabActivityLabel\": \"Activités des agences de travail temporaire\",\n \"principals\": null,\n \"workforce\": 75055,\n \"monitored\": true,\n \"onboarded\": true,\n \"unmanaged\": false,\n \"headquarter\": true,\n \"companyIdValue\": \"98765432100012\",\n \"thirdpartyCode\": null,\n \"name\": \"GLOBAL SERVICES FRANCE\",\n \"address\": \"456 AVENUE DES CHAMPS\",\n \"addressCity\": \"LYON\",\n \"addressPostCode\": \"69001\",\n \"addressCountryCode\": \"FR\",\n \"registered\": true,\n \"registrationStatus\": \"subscribed\",\n \"active\": true,\n \"followingDate\": \"2024-02-27\",\n \"thirdpartyAlerts\": \"NEANT\",\n \"complete\": false,\n \"thirdpartyUsers\": null,\n \"listRegistrationNumber\": [],\n \"attributeValues\": [\n {\n \"id\": 2001,\n \"attributeId\": 1026,\n \"label\": \"E. Intervention sur site\",\n \"type\": \"boolean\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": \"2024-02-27T16:38:48.251+00:00\",\n \"updateDate\": null,\n \"isRequired\": null,\n \"values\": [\n \"true\"\n ],\n \"ctxModelId\": null,\n \"referencingCalculations\": null\n },\n {\n \"id\": 2007,\n \"attributeId\": 1024,\n \"label\": \"D. Dépenses\",\n \"type\": \"integer\",\n \"bondType\": \"thirdparty\",\n \"creationDate\": \"2024-02-27T16:38:41.131+00:00\",\n \"updateDate\": null,\n \"isRequired\": null,\n \"values\": [\n \"100000\"\n ],\n \"ctxModelId\": null,\n \"referencingCalculations\": null\n }\n ],\n \"majorFr\": \"Services\",\n \"majorEn\": \"Services\",\n \"majorCode\": \"I\",\n \"scores\": {\n \"datablocks_financial_strength\": {\n \"rating\": \"5A1\",\n \"riskLevel\": \"very_low\"\n },\n \"datablocks_esg\": {\n \"score\": \"2\",\n \"esgDataDepth\": \"C\",\n \"environmentalRankingScore\": 3,\n \"socialRankingScore\": 2,\n \"governanceRankingScore\": 1,\n \"noDataAvailable\": false\n },\n \"security_rating\": null,\n \"ecovadis\": null,\n \"creditsafe\": null,\n \"indued\": {\n \"due_diligence_id\": \"12234\",\n \"due_diligence\": {\n \"status\": \"fpm_in_progress\",\n \"fpm_url\": \"https://...\",\n \"compliance_score\": 9,\n \"country_score\": 1,\n \"activity_score\": 2,\n \"state\": \"active\",\n \"pep_score\": 3,\n \"sanctions_score\": 1,\n \"adverse_media_score\": 3,\n \"risk_event_score\": 3,\n \"report_url\": null,\n \"risk_level\": 3,\n \"workflow_status\": null,\n \"failure_score\": null,\n \"creation_time\": \"2024-02-27T16:29:52.625+00:00\",\n \"report_time\": null,\n \"screening_time\": \"2024-02-27T16:30:21.468+00:00\",\n \"enrichment_time\": \"2024-02-27T16:30:16.629+00:00\"\n },\n \"report_id\": null,\n \"report_data\": null,\n \"created_date\": \"2024-02-27T16:29:50.960+00:00\",\n \"error\": null\n }\n },\n \"calculatedAttributes\": [\n {\n \"id\": 6001,\n \"calculationId\": 99,\n \"name\": \"Profil de Risque\",\n \"resultType\": \"STRING\",\n \"resultValue\": \"Risque Moyen\",\n \"resultColorCode\": \"#fcb900\",\n \"resultLastUpdateDate\": \"2024-02-27T16:29:50.330+00:00\",\n \"nature\": \"CALCULATED_ATTRIBUTE\",\n \"targetResourceType\": \"THIRD_PARTY\",\n \"targetResourceId\": 67890\n }\n ],\n \"transparencyScore\": 67,\n \"duns\": \"987654321\",\n \"dateCreation\": \"2012-01-12\",\n \"companyStartDate\": \"2000-03-01\",\n \"companyClosedDate\": null,\n \"acronym\": null,\n \"brandName\": \"GLOBAL SERVICES\",\n \"addressingName\": \"GLOBAL SERVICES FRANCE\",\n \"capital\": 50000000,\n \"capitalCurrency\": \"EUR\",\n \"ceo\": null,\n \"turnover\": 3199354000,\n \"turnoverCurrency\": \"EUR\",\n \"lastBalanceSheetDate\": \"2024-12-31\",\n \"addressStreet\": \"456 AVENUE DES CHAMPS\",\n \"etabPhoneNumber\": \"0498765432\",\n \"website\": null,\n \"category\": \"GE\",\n \"subCategory\": null,\n \"hasRestrictedDisclosure\": false,\n \"dunsEncrypted\": false\n }\n ],\n \"page\": 0,\n \"size\": 2,\n \"totalElements\": 9,\n \"globalCount\": 122\n}"}],"_postman_id":"86fbb2f4-5bcb-442a-bf0e-b6bf4bd6ec13"},{"name":"Dossiers","id":"cb2e8535-1541-46c7-b8d4-faa73f7a427a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{ea_api_serv}}/api/v1/account/{{account_id}}/dossiers/advanced-search?page=0&rowPerPage=50&onboarded=true","description":"

This endpoint allows you to perform an advanced multi-criteria search on dossiers within an account. It supports multiple filters on dossier information, associated third party information, custom attributes, calculated attributes, and indicators.

📌 URL Parameters

accountId (required): The account identifier
\n
monitored (optional): Filter on dossier status
\n
- true: Active/monitored dossiers
  \n
- false: Archived/inactive dossiers
  \n
- null (omitted): All dossiers (active and archived)
  \n
\n
onboarded (optional): Filter on third party integration status
\n
- true: Dossiers with onboarded third parties
  \n
- false: Dossiers with non-onboarded third parties
  \n
- null (omitted): All dossiers (onboarded or not)
  \n
\n
page (optional): Page number (default: 0)
\n
rowPerPage (optional): Number of results per page (default: 50)
\n

📦 Request Body (searchParams)

🔍 Dossier Identification

dossierType: Dossier type code (string). Use \"FREE\" for dossiers without a type
\n
reference: Dossier reference (case-insensitive search)
\n

🏢 Third Party Identification (inherited filters)

These parameters allow filtering by information from the third party associated with the dossier:

name: Third party name (case-insensitive search)
\n
code: Third party code (case-insensitive search)
\n
identifier: Third party identifier (SIREN/SIRET, VAT, or DUNS) - must be combined with companyIdType
\n
companyIdType: Type of identifier used. Possible values:
\n
- CIT001: National identifier (SIREN/SIRET for France)
  \n
- CIT002: VAT number
  \n
- CIT003: DUNS number
  \n
\n

📅 Creation Period

start: Dossier creation start date (ISO 8601 format: YYYY-MM-DD)
\n
end: Dossier creation end date (ISO 8601 format: YYYY-MM-DD)
\n

📊 Status

status: Global dossier status. Possible values (English codes):
\n
- MISSING: Incomplete
  \n
- IN_PROGRESS: Acquisition in progress
  \n
- NOT_VALID: Not compliant
  \n
- ACTION_REQUIRED: Action required
  \n
- VALID: Compliant
  \n
- BELOW_EXPECTATION: Insufficient
  \n
\n

🎯 Custom Attributes

attributes: Object containing filters on dossier custom attributes
\n
- Structure: { \"attribute_name\": [\"value1\", \"value2\"], ... }
  \n
- Multiple values for the same attribute are linked by an OR operator
  \n
- Different attributes are linked by an AND operator
  \n
\n

📈 Calculated Attributes

calculatedAttributes: Object containing filters on dossier calculated attributes
\n
- Structure: { \"calculated_attribute_name\": [\"value1\", \"value2\"], ... }
  \n
- Multiple values for the same calculated attribute are linked by an OR operator
  \n
- Different calculated attributes are linked by an AND operator
  \n
\n

🔢 Indicators

indicators: Object containing filters on dossier indicators
\n
- Structure: { \"indicator_name\": [\"value1\", \"value2\"], ... }
  \n
- Multiple values for the same indicator are linked by an OR operator
  \n
- Different indicators are linked by an AND operator
  \n
\n

⚙️ Search Configuration

sort: Object defining result sorting
\n
- Structure: { \"field\": \"direction\" }
  \n
- Possible directions: \"asc\" or \"desc\"
  \n
- Example: { \"creationDate\": \"desc\" }
  \n
\n

This endpoint allows you to perform an advanced multi-criteria search on documents within an account. It supports filters on document type, validity period, status, and acquisition channel.

Important: This endpoint automatically filters documents to show only those from onboarded third parties and active dossiers. These filters are not configurable.

📌 URL Parameters

accountId (required): The account identifier
\n
page (optional): Page number (default: 0)
\n
rowPerPage (optional): Number of results per page (default: 50)
\n

📦 Request Body (searchParams)

🔍 Document Filters

documents: Array of document search criteria. Each object can contain:
\n
- documentCode: Document code (string)
  \n
- start: Validity start date (ISO 8601 format: YYYY-MM-DD)
  \n
- end: Validity end date (ISO 8601 format: YYYY-MM-DD)
  \n
- status: Document status. Possible values (English codes):
  \n
  - MISSING: Incomplete
    \n
  - IN_PROGRESS: Acquisition in progress
    \n
  - NOT_VALID: Not compliant
    \n
  - ACTION_REQUIRED: Action required
    \n
  - VALID: Compliant
    \n
  - BELOW_EXPECTATION: Insufficient
    \n
  \n
\n

⚙️ Search Configuration

sort: Object defining result sorting
\n
- Structure: { \"field\": \"direction\" }
  \n
- Possible directions: \"asc\" or \"desc\"
  \n
- Example: { \"depositDate\": \"desc\" }
  \n
\n

🔍 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
\n
- A result must match ALL specified criteria
\n
Between multiple criteria objects: Results are combined with OR logic
\n
- A result must match ANY of the criteria objects
\n

Example:

{\n  \"filter\": {\n    \"dossiers\": [\n      {\n        \"dossierType\": \"SUPPLY_CONTRACT\",\n        \"status\": \"VALID\"\n      },\n      {\n        \"dossierType\": \"PARTNERSHIP\",\n        \"status\": \"IN_PROGRESS\"\n      }\n    ]\n  }\n}\n\n

This searches for:

Dossiers that are (type = SUPPLY_CONTRACT AND status = VALID)
\n
OR
\n
Dossiers that are (type = PARTNERSHIP AND status = IN_PROGRESS)
\n

This flexible approach allows you to build complex queries that match your specific business needs.

\n","_postman_id":"ac866f4e-bacb-428d-805d-e54827b6f947","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}},{"name":"Errors codes","item":[],"id":"5fe3ba64-0d4d-400f-bc10-d0e1038e33d8","description":"

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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

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

","_postman_id":"5fe3ba64-0d4d-400f-bc10-d0e1038e33d8","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"09c3026f-15d2-437f-98f1-db710241baa9","id":"09c3026f-15d2-437f-98f1-db710241baa9","name":"Aprovall EDGE API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"790fb14e-b6e8-40de-845d-da24df293e3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e0a19e6-c8fe-4f31-a842-e736649a5231","type":"text/javascript","exec":[""]}}]}

Aprovall 'EDGE' API, the restful API

Postman collection

Requests and Scenarios

Postman environment and variables

Quick start

Authenticate to the API

Security

Get a JWT access token

Use the token

Refresh the token

Parameters

Path Parameters

Query Parameters

Request Body

Main Structure

Available Filters in thirdparties[]

🔍 Identification

🌍 Geography and Activity

📊 Status and Qualification

🏷️ Business Attributes and Indicators

⭐ Scores and Ratings

Transparency Scores

Financial Scores

ESG Scores (Environment, Social, Governance)

Other Scores

🔌 External Sources

🔧 Sorting and Display Options

📌 URL Parameters

📦 Request Body (searchParams)

🔍 Dossier Identification

🏢 Third Party Identification (inherited filters)

📅 Creation Period

📊 Status

🎯 Custom Attributes

📈 Calculated Attributes

🔢 Indicators

⚙️ Search Configuration

📌 URL Parameters

📦 Request Body (searchParams)

🔍 Document Filters

⚙️ Search Configuration

🔍 Advanced Search Endpoints