{"openapi":"3.0.0","info":{"description":"Service web permettant d'acheter ou de renouveler des signatures numériques Infocert ou Aruba, et d'obtenir des identités numériques.","version":"1.0.0","title":"Firma Digitale","termsOfService":"https://openapi.it/en/terms-and-conditions","contact":{"url":"https://openapi.it/en/support","name":"Support"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://ws.firmadigitale.com","description":"Production"},{"url":"https://test.ws.firmadigitale.com","description":"Sandbox"}],"tags":[{"name":"Firma elettronica","description":"Méthodes permettant de signer numériquement des documents PDF à l'aide d'API REST."}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"FesBaseResponse":{"allOf":[{"$ref":"#/components/schemas/FesCallbackContent"},{"type":"object","properties":{"callback_status":{"type":"string"},"callback":{"type":"object","properties":{"method":{"type":"string"},"field":{"type":"string"},"url":{"type":"string"}}}}}]},"FesStatus":{"type":"string","description":"La demande renvoie l'un des états suivants.","enum":["created","started","finished","refused","expired","request failed","file validation failed","error"]},"FesCallbackContent":{"type":"object","properties":{"id":{"type":"string"},"filename":{"type":"string","default":"fes_{timestamp}.pdf"},"title":{"type":"string"},"description":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"sign_link":{"type":"string"}}}},"status":{"$ref":"#/components/schemas/FesStatus"},"download_link":{"type":"string","nullable":true}}}}},"paths":{"/firma_elettronica":{"get":{"tags":["Firma elettronica"],"summary":"Liste de toutes vos demandes passées et en cours","description":"","responses":{"200":{"description":"Un fichier PDF","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FesBaseResponse"}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"string","example":"Invalid id"}}}}},"security":[{"bearerAuth":[]}]}},"/firma_elettronica/{id}":{"get":{"tags":["Firma elettronica"],"summary":"Obtenir des informations sur une demande de panneau","description":"","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"923j90n02n1w51504b6ea145"}}],"responses":{"200":{"description":"Un fichier PDF","content":{"application/pdf":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FesBaseResponse"},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"string","example":"Invalid id"}}}}},"security":[{"bearerAuth":[]}]}},"/firma_elettronica/{id}/download":{"get":{"tags":["Firma elettronica"],"summary":"Téléchargez votre document signé","description":"Une fois que le processus de signature est terminé, vous pouvez utiliser ce point de terminaison pour obtenir une sortie encodée en base64 de votre fichier PDF.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"923j90n02n1w51504b6ea145"}}],"responses":{"200":{"description":"Un fichier PDF encodé en base64","content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","example":"aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==","description":"Un encodage base64 de votre fichier PDF SIGNÉ."},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string","example":"Invalid id"}}}},"404":{"description":"Mauvais identifiant ou fichier non prêt","content":{"application/json":{}}}},"security":[{"bearerAuth":[]}]}},"/firma_elettronica/{id}/audit":{"get":{"tags":["Firma elettronica"],"summary":"Récupérer la piste d'audit d'un document signé","description":"Récupérer la piste d'audit pour la signature électronique spécifiée.\n\n### Paramètres\n- **id** (paramètre de chemin) : L'identifiant unique du document signé.\n\n### Exemple\n```bash\n# Télécharger la piste d'audit au format JSON\ncurl -X GET https://ws.firmadigitale.com/firma_elettronica/923j90n02n1w51504b6ea145/audit\n\n\nLa réponse contiendra les informations de la piste d'audit pour la signature électronique.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"923j90n02n1w51504b6ea145"}}],"responses":{"200":{"description":"statut ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"object","properties":{"firstname":{"type":"string","description":"Prénom de la personne à l'origine de la signature électronique."},"lastname":{"type":"string","description":"Nom de famille de la personne à l'origine de la signature électronique."},"email":{"type":"string","format":"email","description":"Adresse électronique de la personne à l'origine de la signature électronique."},"phone":{"type":"string","description":"Numéro de téléphone de la personne à l'origine de la signature électronique."},"status":{"type":"string","description":"Statut de la procédure de signature électronique."},"position":{"type":"integer","description":"Position de l'individu dans l'ordre de signature."},"createdAt":{"type":"string","format":"string","description":"Date à laquelle la demande de signature électronique a été initiée."},"updatedAt":{"type":"string","format":"string","description":"Date de la dernière mise à jour de la demande de signature électronique."},"sign_link":{"type":"string","format":"uri","description":"Lien permettant à l'individu d'accéder au document électronique et de le signer."},"audit_trail":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique du fichier signé électroniquement."},"name":{"type":"string","description":"Nom du document signé électroniquement."},"sha256":{"type":"string","description":"Le hachage SHA256 du document signé électroniquement."},"revisions":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","description":"Motif de la révision du document signé électroniquement."},"sha256":{"type":"string","description":"Le hachage SHA256 de la révision."},"timestamp":{"type":"boolean","description":"Indique si la révision possède un horodatage."},"certificate":{"type":"object","properties":{"dn":{"type":"string","description":"Nom distinctif dans le certificat de signature électronique."},"content":{"type":"string","description":"Contenu du certificat de signature électronique."},"country":{"type":"string","description":"Pays dans le certificat de signature électronique."},"lastname":{"type":"string","description":"Nom de famille dans le certificat de signature électronique."},"firstname":{"type":"string","description":"Prénom dans le certificat de signature électronique."},"generatedAt":{"type":"string","format":"string","description":"Date à laquelle le certificat de signature électronique a été généré."}}},"reason_source":{"type":"string","description":"Source du motif de la révision de la signature électronique."}}}},"contentType":{"type":"string","description":"Type de contenu du document signé électroniquement."},"consentProcesses":{"type":"array","items":{"type":"string","description":"Les processus de consentement liés au document signé électroniquement."}}}}},"member":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique du membre impliqué dans la signature électronique."},"ip":{"type":"string","description":"Adresse IP du membre impliqué dans la signature électronique."},"email":{"type":"string","description":"Adresse électronique du membre impliqué dans la signature électronique."},"phone":{"type":"string","description":"Numéro de téléphone du membre impliqué dans la signature électronique."},"lastname":{"type":"string","description":"Nom de famille du membre impliqué dans la signature électronique."},"signedAt":{"type":"string","description":"Horodatage de la signature du document électronique par le membre."},"firstname":{"type":"string","description":"Prénom du membre impliqué dans la signature électronique."},"operationLevel":{"type":"string","description":"Niveau de fonctionnement du membre dans la signature électronique (personnalisé dans ce cas)."},"authentications":{"type":"array","items":{"type":"object","properties":{"mode":{"type":"string","description":"Mode d'authentification utilisé par le membre (sms dans ce cas)."},"sha256":{"type":"string","description":"Le hachage SHA256 des données d'authentification."},"channel":{"type":"string","description":"Canal de communication utilisé pour l'authentification (texte dans ce cas)."},"content":{"type":"string","description":"Contenu du message d'authentification."},"validatedAt":{"type":"string","description":"Date à laquelle l'authentification a été validée."}}}}}},"procedure":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique pour la procédure de signature électronique."},"name":{"type":"string","description":"Nom de la procédure de signature électronique."},"createdAt":{"type":"string","format":"string","description":"Horodatage de la création de la procédure de signature électronique."},"expiredAt":{"type":"string","description":"Date d'expiration de la procédure de signature électronique (null si elle n'a pas expiré)."},"startedAt":{"type":"string","format":"string","description":"Horodatage du début de la procédure de signature électronique."},"workspace":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de l'espace de travail associé à la procédure."},"name":{"type":"string","description":"Nom de l'espace de travail associé à la procédure."}}},"description":{"type":"string","description":"Description de la procédure de signature électronique."},"organization":{"type":"object","properties":{"id":{"type":"string","description":"Identifiant unique de l'organisation associée à la procédure."},"ip":{"type":"string","description":"Adresse IP de l'organisation associée à la procédure."},"name":{"type":"string","description":"Nom de l'organisation associée à la procédure."}}},"coolingOffPeriodEndsAt":{"type":"string","description":"Horodatage de la fin du délai de réflexion (nul si non applicable)."}}},"consentProcesses":{"type":"array","items":{"type":"string","description":"Les processus de consentement liés à la procédure de signature électronique."}}}}}}}},"success":{"type":"boolean","description":"Indique si l'opération de signature électronique a réussi."},"message":{"type":"string","description":"Un message relatif à l'opération de signature électronique."},"error":{"type":"object","description":"Détails de l'erreur liée à l'opération de signature électronique."}}},"examples":{"json":{"summary":"Piste d'audit au format JSON","value":{"data":{"111111e9-a48d-4a59-b256-111111fc7e6b":{"firstname":"franco","lastname":"rossi","email":"prova@gmail.com.com","phone":"+39333333333","status":"done","position":1,"createdAt":"2024-02-13T11:03:40+01:00","updatedAt":"2024-02-13T11:04:13+01:00","sign_link":"https://staging-app.yousign.com/procedure/sign?members=/members/173900e9-a48d-4a59-b256-66843afc7e6b&signatureUi=/signature_uis/1111111-****-4fee-994b-2222222222","audit_trail":{"files":[{"id":"111111111-25c2-481e-8156-********","name":"The best name for my file.pdf","sha256":"akjsgafakjsfakjfaldhgaslòdfkagòfag141ògfaòfsgasfk","revisions":[{"reason":"Signed by Franco Rossi","sha256":"54e150d9030a4ba8f2f4a2f33e46c916a3ecc6e7ecc55c81bfefcce975273b17","timestamp":false,"certificate":{"dn":"CN=[TEST] YOUSIGN cachet, C=FR, O=YOUSIGN, 2.5.4.97=NTRFR-794513986, OU=002 794513986, serialNumber=2023-10-02 09:28:10:989","content":"-----BEGIN CERTIFICATE-----\nMIIHGTCCBQGgAwIBAgIIDPL2eNqLfaowDQYJKoZIhvcNAQELBQAwgYExKTAnBgNV\nBAMMIFlPVVNJR04gU0FTIC0gUVVBTElGSUVEIFNFQUwyIENBMRcwFQYDVQQLDA4w\nMDAyIDc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxGDAWBgNVBGEMD05U\nUkZSLTc5NDUxMzk4NjELMAkGA1UEBhMCRlIwHhcNMjMxMDAyMDcxODExWhcNMjYx\nMDAyMDcxODExWjBZMR4wHAYDVQQDDBVbVEVTVF0gWU9VU0lHTiBjYWNoZXQxEDAO\nBgNVBAoMB1lPVVNJR04xGDAWBgNVBGEMD05UUkZSLTc5NDUxMzk4NjELMAkGA1UE\nBhMCRlIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDr5vXSGOS7ulB7\nY3JsL3lvdXNpZ25zYXNxdWFsaWZzZWFsY2EuY3JsMDugOaA3hjVodHRwOi8vY3Js\nMy55b3VzaWduLmZyL2NybC95b3VzaWduc2FzcXVhbGlmc2VhbGNhLmNybDAdBgNV\nHQ4EFgQUPoTlZvgDNKmMcCBDYhZ3y/1Qs6EwDgYDVR0PAQH/BAQDAgZAMC0GCCsG\nAQUFBwEDBCEwHzAIBgYEAI5GAQEwEwYGBACORgEGMAkGBwQAjkYBBgEwDQYJKoZI\nhvcNAQELBQADggIBAG0+VQ8+wm6pco6OHQ7wQ9g2BFmDInkYhmNsDc5k3B44HHvN\nkxzp1WcbdYjPfhfhbosSA5EaOAMdmwvQMIPMpj0N+FiAWX7mR7dCxzCr1Ox0zNSh\n5B5XhjG3+imtudTB4taQvMzeRbJU8o4mSEZfezezOgTD0uFo9kRbtdeAW61rff2h\ngLzP9WPjR3Md8AWGIEzY+K3HhY0WBlxrw7w3MIt2I0U9qZfHshqKcIQt4yAD/rUS\nEJZL4WUjvxJHOAlAX2ilpJ5Jfb4AeQK/Isr3ZZV6jMAGHvYp+r65jqpAoBSfOWeM\nOHOQMtMAvuWblWy/kyKS3Mw+zqnt55V3hK/aFNFiB8cjEloyDmuub0dhi5XAFksd\n1RjD15N72TIjNp7tMBDi0f/faB8xCK2XjPvk7daRwJkkFbi0lD4Uvsq8ptmCCoKK\n2bnY9seMLuv5YtXyKzu/xaDcdIqn3zWkxxxJGAf6EY6IcGAScc7OlZswB1nAEGIO\ntcIeSUHjKydzLnKeWYBwLVwqafm8H38YwYrbk2cWSgGyf0MmQKIfk0zhd7m2JmYj\nCbiNBwYiqVlI8Gq1lrPTpBj3F/K+lN4DFoVUucXImYO9HrBRk9Ow6e2LqiUGrcB1\nbgEhXsWL9ElVlXWqsBkON8515yQN+yBKrBHZSUk20UZ4UaJ07v8xxccbpg+7\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIHXzCCBUegAwIBAgIIaub8zjro4vMwDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI\nDAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTgxMDAzMTMyNjQ0WhcNMjgxMDAz\nMTMyNjQ0WjCBgTEpMCcGA1UEAwwgWU9VU0lHTiBTQVMgLSBRVUFMSUZJRUQgU0VB\nTDIgQ0ExFzAVBgNVBAsMDjAwMDIgNzk0NTEzOTg2MRQwEgYDVQQKDAtZT1VTSUdO\nIFNBUzEYMBYGA1UEYQwPTlRSRlItNzk0NTEzOTg2MQswCQYDVQQGEwJGUjCCAiIw\nML3OLMAeFKMITuqAW7XWmVlUQXHbblyFN6wKdp6YNY5mbK3dev+KQnGXijdyPO/u\nMbrVJ+SddvyrAbAXsrvR0RvwZYM3GxxPbeUGXIiYKYP+V33sTZiRemofQGoByf03\nN0602/6Q8hqZE8PeiFv4wnvfu7lpxL9a0TkAD7Ow/Vu60aok+aZbGwvaIygdcuN8\nox+FR0dsdExx7GuqNQO+tTOySwRIAHybZIJeXUwFn8mtweNc2lQ07ver1QSJH6YX\nc8eqYnizxIY+LePdiVZIJcsuC/vkUOmCIQrXLZeJZNDvPrcV7+H3EYLcAnbEn8Ia\nM0Z9jcfpHPW9iO+5jYvW3G+BLI88oF3OgZAt85cjrVaG8ViSp2yHN49Voo99LlTx\neQxQpk7dpwqHwXz1YY9Rv/d4Ta7Cc1UCho6IpEfHviJCbfCvLJZj/Bn9jfZD+7TM\naqsApD6H5Ls/bmV2UGt4LkSpLA==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIGnDCCBISgAwIBAgIIT0TY3eM9ut0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nNKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj\nYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z\nYXNyb290MmNhLmNybDAdBgNVHQ4EFgQUZcQVpO5GVb7OvXVHwDRARhwa+5EwDgYD\nVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQCuxOXQDSYF0RpYQWonRDlU\nZ64IaGJ5buU4tGzf7rAgIQdXbO/VjjfF9UsjnLopNwWkuSJvINm21obYHcoSwvpz\nlwS/3uJCLxaw5q4SVJ4x5rajh/2qtFzcThSh48rcXcqoxAmc6BzQuIOm9cFUD2Ri\nqUJmg5O+CoLuE1b4i+CsCFL3AoWnBHFZ4YtInQBFIRBhMNPICvYOCF6jjgmMxkWU\nM8SEp7FSFfsy/oPI1dt+k9JjHCXhtWO9ndLvvwvLcjqRO3ItiF9IazsNcNLhaIMA\nlvYiQ+jLpckAuTxj7XHQyJSEofTMPr+ZSgQwUc337MJyxPhTDkch5cQBfnC20Usk\nyjdwwaeiwnNMhESwgDa4Oqw5IOmq+VmqtR+9F9yxACrpyph593F1zYwv7ikik5dI\nIYACb2fKLQrcnCfhm0k1Nt9UXoc9mQzFUK0DWJNLeGJo0rfRQh5ZqhcBG2U0KZFQ\nRtQQEf3zXJxQJGlCn1UMZMJswAzfhMTdGPNzyDI2u+9Q8WT7M2f59Idiae2m79uG\nuStRwN7Vnrpa399YXixOpNTz6d0NFBOAq1Nfwy5cnQDCnT9JkrKidrFKyA21b67m\nSfJIpMSPfFbt3g0h7JPWK7OC4Ydydh92e7/IUhtkudKMoazlwSJ7484dE7NyTpol\n62H0sW/1gmFzE6/QmCUR+w==\n-----END CERTIFICATE-----\n","country":"IT","lastname":null,"firstname":null,"generatedAt":"2023-10-02T09:28:11+02:00"},"reason_source":"Default value added by Yousign"}],"contentType":"application/pdf","consentProcesses":[]}],"member":{"id":"111111111-25c2-481e-7156-********","ip":"00.111.111.111","email":"prova@gmail.com.com","phone":"+39333333333","lastname":"ROSSI","signedAt":"2024-02-13T11:04:13","firstname":"Franco","operationLevel":"custom","authentications":[{"mode":"sms","sha256":"adfaDFADFASDFASDFASDFASDFWEEWQFSDAFADSFASafaedvafafeae","channel":"text","content":"eSIGNATURE: {{code}} is your security code to confirm the signature of your documents.","validatedAt":"2024-02-13T11:04:12"}]},"procedure":{"id":"6f89bd7d-2409-4e4a-8676-942834249539","name":"A test prova","createdAt":"2024-02-13T11:03:40","expiredAt":null,"startedAt":"2024-02-13T11:03:40","workspace":{"id":"/workspaces/d27e41f8-24f1-439d-a0ef-be6aae15fa44","name":"openapi.it"},"description":"Description du test","organization":{"id":"/organizations/0a85ecfa-cfad-4290-af81-1c68c0222c99","ip":"1.11.111.111","name":"openapi.it"},"coolingOffPeriodEndsAt":null},"consentProcesses":[]}}},"success":true,"message":"","error":null}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string","example":"Invalid id"}}}},"404":{"description":"Mauvais identifiant ou fichier non prêt","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"data":{"type":"object"},"trace":{"type":"string"}},"example":{"success":false,"message":"missing or invalid ID, required","error":470,"data":null,"trace":"WyJpbmRleC5waHBAMTE3OCIsImNsYXNzLkF2V3MucGhwQDI0MiIsImluZGV4LnBocEAxNDM5Il0="}}}}}},"security":[{"bearerAuth":[]}]}},"/firma_elettronica_ui":{"post":{"tags":["Firma elettronica"],"deprecated":true,"summary":"[DEPRECATED] Créer une interface utilisateur personnalisée pour les signatures électroniques","description":"**Ce point d'accès est obsolète et n'est plus pris en charge**.","requestBody":{"content":{"application/json":{}}},"responses":{"200":{"description":"","content":{}},"400":{"description":""}},"security":[{"bearerAuth":[]}]},"get":{"tags":["Firma elettronica"],"deprecated":true,"summary":"[DEPRECATED] Liste de toutes les interfaces utilisateur personnalisées","responses":{"200":{"description":"","content":{"application/json":{}}},"400":{"description":""}},"security":[{"bearerAuth":[]}]}}},"externalDocs":{"description":"C'est la première fois que vous venez ici ? Générer un nouveau jeton d'accès","url":"https://console.openapi.com/fr/oauth"}}