Skip to main content

Signer Read

API di lettura per il servizio dei firmatari per Agyo Firma

Swagger ambienti

Descrizione API

Signer Search
POST​ /v1​/rest​/signers​/search

Permette di recuperare i firmatari di una data azienda

Query Params

  • itemId  identificativo dell'azienda di cui si vuole avere i firmatari
  • page numero di pagina
  • size numero di elementi per pagina
  • fullText permette di fare una ricerca filtrata per alcuni dati dei firmatari

La ricerca fullText viene fatta su questi dati dei firmatari

  • firstName  
  • lastName 
  • fiscalCode 
  • ownerTaxId codice fiscale dell'azienda su cui il firmatario e stato assegnato 
  • ownerVatNumber partita iva dell'azienda su cui il firmatario e stato assegnato 
  • ownerDescription ragione sociale dell'azienda su cui il firmatario e stato assegnato 

 

Retrive Signer 
GET​/v1​/rest​/signers​/{id}
Permette di recuperare tutte le info riguardanti uno specifico firmatario

id  identificativo del firmatario

 
UpdateRetrive If Signer Exist into Item
GET​ 


















1




PATCH//v1/rest/signer/{signerId}signers/searchByFiscalCode










Permette 
di 
verificare 
se 
un determinato firmatario esiste già per un'azienda







Query 




Permette di aggiornare i dati di un determinato firmatario










In questo momento vanno passati di nuovo anche i dati obbligatori senza modificarli oltre ai nuovi dati che vanno inseriti, in futuro i dati obbligatori non dovranno essere passati


Esempio




Params











    



itemId  
identificativo 
dell'azienda 
di 
cui 
si 
vuole 
1
avere 
i 
{
firmatari



fiscalCode 
codice 
2
fiscale 
del 
firmatario "fiscalCode":che "MEOMRA80A01I829T",
si 
sta 
controllando



3




    "firstName": "Mara",








4




    "lastName": "Meo",








5




    "sex": "M",








6




    "birthCity": "Sondrio",








7




    "birthCountry": "IT",








8




    "birthDate": "1980-01-01T00:00:00.000+0000",








9




    "email": "rmainini@modora.com",








10




    "cellNumber": "3483247964",








11




    "itemId": "MNNRFL96D21I829W",








12




​








13




​








14




    "documentIssuer": "Comune",








15




    "documentNumber": "AX134444",








16




    "documentEndDate": "2020-02-20T00:00:00.000+0000",








17




    "documentType": "Carta d'identità",








18




​








19




​








20




}
































 


CreateDownload FEAFilled/Signed Document






















GET​ 


















1




POST/v1/rest/extra-signature/create/fea​/v1​/rest​/utils​/download​/document






























Permette di effettuare l'adesione FEA (firma elettronica avanzata) per un determinato firmatario














































1




 {








2




  "documentSignType": "string", //FEA remota o FEA grafometrica








3




  "imagesContent": [








4




    "string" 








5




    //base64 delle immagini del documento e codice fiscale del firmatario. Non obbligatorio








6




    //.pdf,.jpg,.jpeg,.jpe,.png,.tiff,.tif








7




  ],








8




  "itemData": { //dati aggiuntivi dell'azienda








9




    "address": "string",








10




    "city": "string",








11




    "description": "string", //ragione sociale dell’azienda








12




    "fullAddress": "string",








13




    "itemCellNumber": "string",








14




    "jurisdictionPlace": "string",








15




    "policyNumber": "string", //AXA XL IT00020931EO19A di default








16




    "vatNumber": "string",








17




    "webSite": "string"








18




  },








19




  "mainSignerId": "string", // Codice fiscale del firmatario con certificato FEQ automatica che sigillerà il documento








20




  "signerId": 0,








21




  "transmitterId": "string" //Identificativo dell’azienda a cui fa riferimento il firmatario a cui verrà fatta l’adesione








22




}
































 


Creazione FES












































1




POST/v1/rest/extra-signature/create/fes


































Permette di attivarescaricare lail tipologiacontratto laper FESi certificati FRM/FSM (firmaFirma elettronica semplice)qualificata adautomatica/Firma unelettronica determinatoqualificata firmatarioremota) sia solamente pre compilato sia quello pre compilato e firmato











Query Params












    



signerId  
identificativo 
del 
firmatario 
di 
cui 
si 
vuole 
recuperare 
1
il 
contratto

{


certType 
tipologia 
di 
2
certificato 
FRM 
o "signerId":FSM
219


documentType 
tipo 
documento 
3
FILLED 
o 
}
SIGNED


































Delete ExtraSignature


















































1




DELETE/v1/rest/extra-signature/delete


































Permette di eliminare le extraSignature (FEA, FES) di un determinato firmatario.








































1




{








2




    "signerId": 219,








3




    "extraSignatureId": 12,








4




}






























 


Initialize








































1




POST/v1/rest/certificate/frm/initialize








2




POST/v1/rest/certificate/fsm/initialize
































Permette di inizializzare la richiesta per i certificati FRM o FSM (Firma elettronica qualificata automatica, Firma elettronica qualificata remota) che poi sarà mandata alla CA






Richiesta per FRM






































1




{








2




  "itemId": "string", 








3




  "pin": "string", //8 caratteri alfanumerici








4




  "savePin": true,








5




  "serviceName": "string", //SIGNATURE-FLOW








6




  "signerId": 0








7




}




























Richiesta per FSM






































1




{








2




  "itemId": "string", 








3




  "serviceName": "string", //SIGNATURE-FLOW








4




  "signerId": 0








5




}






























 


Submit








































1




POST/v1/rest/certificate/frm/ca/submit








2




POST/v1/rest/certificate/fsm/ca/submit
































Permette di finalizzare la richiesta del certificato mandando alla CA il documento fillato e firmato












































1




{








2




  "file": "string", //base64 del contratto fillato e firmato








3




  "signerId": 0








4




}






























 


AssignCertificate








































1




POST/v1/rest/certificate/frm/assign-certificate








2




POST/v1/rest/certificate/fsm/assign-certificate
































Permette di assegnare ad un firmatario un certificato già creato in precedenza da un altra azienda. 






Nome
Cognome
Codice fiscale
ItemId
CertificateId
 


Utente1
Utente1
CF1
ITEM1
CERT1
 


Utente1
Utente1
CF1
ITEM2
 
 


l'api si occupa di collegare il certificato se il firmatario è lo stesso ma per diverse aziende






Nome
Cognome
Codice fiscale
ItemId
CertificateId
 


Utente1
Utente1
CF1
ITEM1
CERT1
 


Utente1
Utente1
CF1
ITEM2
CERT1
 













































1




{








2




  "certificateId": 0,








3




  "itemId": "string",








4




  "serviceName": "string", //SIGNATURE-FLOW








5




  "signerId": 0








6




}






























 


UnAssignCertificate








































1




DELETE/v1/rest/certificate/frm/unassign-certificate








2




DELETE/v1/rest/certificate/fsm/unassign-certificate
































Scollega un certificato da un firmatario










































1




{








2




  "certificateId": 0,








3




  "signerId": 0








4




}



































 








 

    
        

    


            

        

    


    


    
    

        

             Back to top