{"openapi":"3.1.0","info":{"title":"ZYNYO Signing Service REST API","description":"The Zynyo Signing Service allows you to submit PDF documents to be signed by one or multiple signatories, query the current documents, cancel a document, send reminders to signatories and retrieve the signed PDF document after the signing authenticationMethod is complete.\n\nThe service supports multiple authenticating methods for signatories. A detailed explanation of the supported authentication methods can be found in the developers documentation.\n\nThis documentation is intended for developers who want to incorporate the Signing Service into their own (web) application via this REST API. Getting started is easy: contact info@zynyo.com for a API test key on which you start right away.\n\nThe API is based on OpenAPI Specification for RESTful APIs. For more information on OpenAPI, please go to <a href=\"https://www.openapis.org/\">www.openapis.org</a> standards.\n\nFor any help, please don't hesitate and contact Zynyo support at <a href=\"mailto:support@zynyo.com\">support@zynyo.com</a>. We will contact you as soon as possible. \n\n","contact":{"name":"Zynyo","url":"https://zynyo.com","email":"support@zynyo.com"},"version":"3"},"servers":[{"url":"https://signingservice.zynyo.com/api/rest/v3"}],"tags":[{"name":"Templates","description":"Endpoints for document templates (used by the document template authentication method)"},{"name":"eDelivery","description":"Endpoints for eDelivery requests"},{"name":"Documents","description":"Endpoints for document and document states"},{"name":"Statelog","description":"Endpoints for retrieving statelogs"},{"name":"Signing","description":"Endpoints for sign requests"},{"name":"Emails","description":"Endpoints for managing emails (for sending emails using your own mailserver)"},{"name":"eSeal","description":"Endpoints used for sealing documents"},{"name":"Usage","description":"Endpoints for viewing resource usage"}],"paths":{"/sign/editdocument":{"put":{"tags":["Signing"],"summary":"Edit the signatories of a document","description":"Signatories can be edited when they are not in a finished state.","operationId":"editDocument","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDocumentResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/sign/canceldocument":{"put":{"tags":["Signing"],"summary":"Cancel the document","description":"Documents can be cancelled when they are not in a finite state.","operationId":"cancelDocument","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelDocumentResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/documenttemplates":{"get":{"tags":["Templates"],"summary":"Get the list of document templates","description":"Document templates can be created in the Zynyo portal.","operationId":"getDocumentTemplates","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelDocumentTemplate"}}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}},"put":{"tags":["Templates"],"summary":"Update a document template","description":"Update the document template with the corresponding UUID.","operationId":"updateDocumentTemplate","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelDocumentTemplate"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"404":{"description":"Document template not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}},"post":{"tags":["Templates"],"summary":"Create a document template","description":"Create a document template.","operationId":"createDocumentTemplate","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTemplateCreationRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelDocumentTemplate"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/sign/signdocumentrequest":{"post":{"tags":["Signing"],"summary":"Create a document sign request","description":"Create a sign request for a single document with multiple signatories.","operationId":"signDocumentRequest","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignDocumentResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}},"callbacks":{"":{"https://postman-echo.com/post":{"post":{"description":"Callback for document status changes","responses":{"200":{"description":"Return this code if the callback was received and processed successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentCallback"}}}}}}}}}}}},"/sign/sendreminder":{"post":{"tags":["Signing"],"summary":"Send a reminder for a signatory","description":"You can send a reminder with email or SMS, if you have added SMS-TAN as authentication for a signatory. Depending on you API settings, reminders can also be sent automatic periodically.","operationId":"sendReminder","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/sign/multi/signdocumentrequest":{"post":{"tags":["Signing"],"summary":"Create a document sign request with multiple documents","description":"Documents can be merged into a single PDF or send as a separate document signing requests.","operationId":"signMultiDocumentRequest","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignMultiDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignDocumentResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}},"callbacks":{"":{"https://postman-echo.com/post":{"post":{"description":"Callback for document status changes","responses":{"200":{"description":"Return this code if the callback was received and processed successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentCallback"}}}}}}}}}}}},"/quicksign":{"post":{"tags":["eSeal"],"summary":"Seal a PDF document with a digital signature","description":"Seal documents instantly with a digital signature. This can be done with a Zynyo certificate or with your organization certificate.","operationId":"quickSignDocument","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickSignDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickSignDocumentResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/quicksign/hash":{"post":{"tags":["eSeal"],"summary":"Sign the hash of a document","description":"Signs the hash of a document using the eSeal provider registered for the API key.","operationId":"signHash","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignHashRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignHashResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"404":{"description":"No eSeal provider associated with this API-key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"409":{"description":"The certificate has expired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateExpiredResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/emails/sent":{"post":{"tags":["Emails"],"summary":"Mark emails as sent","description":"Mark email as sent when you have sent them with your own mail or message server. Marked email wil not appear in the process list any more.","operationId":"markEmails","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"The id's of the email you want to mark","items":{"type":"integer","format":"int64"}}}},"required":true},"responses":{"200":{"description":"Message to confirm successful mark","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/delivery/deliveryrequest":{"post":{"tags":["eDelivery"],"summary":"Create a delivery request","description":"Create a delivery request.","operationId":"deliveryRequest","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryRequest"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SignDocumentResponse"}}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}},"callbacks":{"":{"https://postman-echo.com/post":{"post":{"description":"Callback for document status changes","responses":{"200":{"description":"Return this code if the callback was received and processed successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentCallback"}}}}}}}}}}}},"/usage":{"get":{"tags":["Usage"],"summary":"Get the usage for a given period","operationId":"getUsage","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"The start month / year (yyyyMM)","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end month / year including (yyyyMM)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Usage"}}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/statelog/signatory":{"get":{"tags":["Statelog"],"summary":"Get the signatory state logs","description":"With this endpoint you can get the state logs for the signatories currently in the system","operationId":"getSignatoryStateLog","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SignatoryStateLog"}}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/statelog/document":{"get":{"tags":["Statelog"],"summary":"Get the document state logs","description":"With this endpoint you can get the state logs for the documents currently in the system","operationId":"getDocumentStateLog","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentStateLog"}}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/sign/getsigned/{documentUUID}":{"get":{"tags":["Signing"],"summary":"Get the signed document content","description":"If the audit log is separated from the document, the content of this is in a separate field.","operationId":"getSignedDocument","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}},{"name":"documentUUID","in":"path","description":"The Zynyo document identifier (UUID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedDocumentResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/quicksign/certificate":{"get":{"tags":["eSeal"],"summary":"Get the certificate that belongs to the API-key","description":"Get the certificate that belongs to the API-key. This certificate is based on the eSeal provider registered for the API account","operationId":"getCertificate","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"404":{"description":"No eSeal provider associated with this API-key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/emails":{"get":{"tags":["Emails"],"summary":"Get the list of stored emails to process","description":"Only available when private email server is enabled in the portal.","operationId":"getEmails","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Email"}}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/documenttemplates/{documentTemplateUUID}":{"get":{"tags":["Templates"],"summary":"Get a document template by UUID","description":"Document templates can be created in the Zynyo portal.","operationId":"getDocumentTemplate","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}},{"name":"documentTemplateUUID","in":"path","description":"The document template UUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelDocumentTemplate"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"404":{"description":"Document template not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}},"delete":{"tags":["Templates"],"summary":"Delete a document template","description":"Delete the document template with the corresponding UUID.","operationId":"deleteDocumentTemplate","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}},{"name":"documentTemplateUUID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"404":{"description":"Document template not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/documentssummary/{states}":{"get":{"tags":["Documents"],"summary":"Get the summary, with the number of document and average duration, for the current documents filtered by the given states","description":"Multiple status values can be provided with comma separated strings.","operationId":"getDocumentSummary","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}},{"name":"states","in":"path","description":"The document state to query documents for, use comma for string separation","required":true,"schema":{"type":"string"},"example":"NOT_VALIDATED,PARTIALLY_VALIDATED,VALIDATED,DELIVERY_EXPIRED,AUDITLOG,DISPATCHED,SIGNED,SIGNED_DELIVERY_REJECTED,SIGNED_DELIVERY_EXPIRED,EXPIRED,ARCHIVED,AUTHENTICATION_FAILED,CANCELLED,REJECTED,ERROR"},{"name":"types","in":"query","description":"Types of signrequests to retrieve, use comma for string separation, defaults to SIGN,DELIVERY","required":false,"schema":{"type":"string"},"example":"SIGN,DELIVERY"},{"name":"reference","in":"query","description":"Query documents on reference","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Search documents on name, description, signatory name or signatory email address","required":false,"schema":{"type":"string"}},{"name":"submitters","in":"query","description":"The document submitter email to query documents for, use comma for string separation","required":false,"schema":{"type":"string"}},{"name":"recipients","in":"query","description":"The document recipient email to query documents for, use comma for string separation","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSummary"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/documents/{states}/{startPosition}/{maxResults}":{"get":{"tags":["Documents"],"summary":"Get the list of current documents","description":"Multiple status values can be provided with comma separated strings.","operationId":"getDocuments","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}},{"name":"states","in":"path","description":"The document state to query documents for, use comma for string separation","required":true,"schema":{"type":"string"},"example":"NOT_VALIDATED,PARTIALLY_VALIDATED,VALIDATED,DELIVERY_EXPIRED,AUDITLOG,DISPATCHED,SIGNED,SIGNED_DELIVERY_REJECTED,SIGNED_DELIVERY_EXPIRED,EXPIRED,ARCHIVED,AUTHENTICATION_FAILED,CANCELLED,REJECTED,ERROR"},{"name":"startPosition","in":"path","description":"Startposition for the result list","required":true,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"maxResults","in":"path","description":"Max number of documents to query","required":true,"schema":{"type":"integer","format":"int32"},"example":10},{"name":"types","in":"query","description":"Types of signrequests to retrieve, use comma for string separation, defaults to SIGN,DELIVERY","required":false,"schema":{"type":"string"},"example":"SIGN,DELIVERY"},{"name":"reference","in":"query","description":"Search documents on reference","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Search documents on name, description, signatory name or signatory email address","required":false,"schema":{"type":"string"}},{"name":"submitters","in":"query","description":"The document submitter email to query documents for, use comma for string separation","required":false,"schema":{"type":"string"}},{"name":"recipients","in":"query","description":"The document recipient email to query documents for, use comma for string separation","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelDocument"}}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/document/{uuid}":{"get":{"tags":["Documents"],"summary":"Get a single document","description":"With this endpoint you can get information about a single document","operationId":"getDocument","parameters":[{"name":"apikey","in":"header","description":"Your Zynyo API key","required":true,"schema":{"type":"string"}},{"name":"uuid","in":"path","description":"The document uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelDocument"}}}},"400":{"description":"Invalid parameters provided. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"500":{"description":"Internal failure. See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Incorrect or inactive API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}}},"components":{"schemas":{"CancelDocumentResponse":{"type":"object","description":"Model for the response of cancelling a document","properties":{"message":{"type":"string","description":"Success message"}}},"EditDocumentResponse":{"type":"object","description":"Model for the response of editing a document","properties":{"message":{"type":"string","description":"Success message"}}},"MessageResponse":{"type":"object","description":"Response with a (error) message","properties":{"message":{"type":"string","description":"The (error) message"}}},"AuthenticationMethod":{"type":"object","description":"Choose one of the following implementing models by specifying the type property: mouse -> MouseSignatureAuthenticationMethod, sso -> SSOAuthenticationMethod, smstan -> SMSTANAuthenticationMethod, idin -> IDINAuthenticationMethod, irma -> IRMAAuthenticationMethod, csc -> CSCAuthenticationMethod, documentanchor -> DocumentTemplateAuthenticationMethod, documenttemplate -> DocumentTemplateAuthenticationMethod, checkedid -> CheckedIDAuthenticationMethod, certificate -> CertificateAuthenticationMethod, digid -> DigiDAuthenticationMethod","discriminator":{"propertyName":"type","mapping":{"mouse":"#/components/schemas/MouseSignatureAuthenticationMethod","sso":"#/components/schemas/SSOAuthenticationMethod","smstan":"#/components/schemas/SMSTANAuthenticationMethod","idin":"#/components/schemas/IDINAuthenticationMethod","irma":"#/components/schemas/IRMAAuthenticationMethod","csc":"#/components/schemas/CSCAuthenticationMethod","documentanchor":"#/components/schemas/DocumentAnchorAuthenticationMethod","documenttemplate":"#/components/schemas/DocumentTemplateAuthenticationMethod","checkedid":"#/components/schemas/CheckedIDAuthenticationMethod","certificate":"#/components/schemas/CertificateAuthenticationMethod","digid":"#/components/schemas/DigiDAuthenticationMethod"}},"properties":{"ordernumber":{"type":"integer","format":"int32","description":"The order in which the authentication methods should appear (numbered from low to high)","example":1},"type":{"type":"string"}},"required":["type"]},"CSCAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"csc"},"authtype":{"type":"string","description":"The authorization type to use for CSC authentication: AFTERVIEW -> Sign the document using CSC, PREVIEW -> The signatory has to complete CSC identification to view the document","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"},"allowedCSCProviders":{"type":"array","description":"Limit the choice of providers to this list. If empty or missing, all providers are allowed. Supported CSC providers are \"Vidua\", \"Cleverbase\", \"KPN\", \"Itsme\", \"Digidentity-global\", \"primesign\"","example":["Cleverbase","Itsme"],"items":{"type":"string"}},"visualSignatureRequired":{"type":"boolean","default":false,"description":"When set to true, the signatory will be asked to place a signature that will be added as a visual representation for their qualified signature."},"givenName":{"type":"string","description":"The given name, used for automatic validation (only required for PREVIEW)","example":"John Doo","maxLength":200,"minLength":1},"surName":{"type":"string","description":"The surname, used for automatic validation (only required for PREVIEW)","example":"Smith","maxLength":200,"minLength":1},"birthDate":{"type":"string","format":"date","description":"The date of birth (YYYY-MM-DD), used for automatic validation (only required for PREVIEW)","example":"1950-01-20","pattern":"^\\d\\d\\d\\d-\\d\\d-\\d\\d$"}}}],"description":"Authentication method for singing the document with a (personal) cloud based certificate"},"CertificateAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"certificate"},"slot":{"type":"integer","format":"int32","description":"Your Zynyo certificate partition slot number","example":1,"maximum":100,"minimum":0}}}],"description":"Authentication method for singing the document with a (personal) Zynyo managed certificate","required":["slot"]},"CheckedIDAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"checkedid"},"hideBsn":{"type":"boolean","description":"Whether the BSN should be hidden"}}}],"description":"Authentication method for a signatory to get a CheckedID validation for ID document validation with real time owner verification"},"DigiDAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"digid"},"authtype":{"type":"string","enum":["PREVIEW","AFTERVIEW"]}}}],"description":"Authentication method for validating a signatory using DigiD"},"DocumentAnchorAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"documentanchor"}}}],"description":"Authentication method for signatory to fill the template fields from the document template generated through documentanchors."},"DocumentTemplateAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"documenttemplate"}}}],"description":"Authentication method for signatory to fill the template fields from the document template"},"EditDocumentRequest":{"type":"object","description":"Model for editing the signatories of a document","properties":{"documentUUID":{"type":"string","description":"The Zynyo document identifier (UUID)","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"signatoryUpdates":{"type":"array","description":"The signatories to update","items":{"$ref":"#/components/schemas/SignatoryUpdate"},"maxItems":2147483647,"minItems":1}},"required":["documentUUID","signatoryUpdates"]},"IDINAuthenticationMethod":{"type":"object","description":"Authentication method for validating a signatory based on iDIN (bank) data. All  automatic validation fields are optional.","properties":{"ordernumber":{"type":"integer","format":"int32","description":"The order in which the authentication methods should appear (numbered from low to high)","example":1},"type":{"type":"string","description":"The type of authentication method","example":"idin"},"legalLastname":{"type":"string","description":"The legal last name for automatic validation","example":"Smith","maxLength":200,"minLength":1},"legalLastnamePrefix":{"type":"string","description":"The prefix for the last name for automatic validation","example":"Doo","maxLength":10,"minLength":0},"initials":{"type":"string","description":"The initials (without dots) for automatic validation","example":"JD","maxLength":24,"minLength":1},"dateofbirth":{"type":"string","format":"date-time","description":"The date of birth (YYYY-MM-DD) for automatic validation","example":"1950-01-20","pattern":"^\\d\\d\\d\\d-\\d\\d-\\d\\d$"},"houseno":{"type":"integer","format":"int32","description":"The house number of the signatory address for automatic validation","example":1,"maximum":99999},"housenosuf":{"type":"string","description":"The house number suffix of the signatory address for automatic validation","example":"a","maxLength":6,"minLength":0},"postalcode":{"type":"string","description":"The postalcode of the signatory address for automatic validation","example":"1111AA","maxLength":6,"minLength":4},"city":{"type":"string","description":"The city of the signatory address for automatic validation","example":"Haarlem","maxLength":24,"minLength":4},"phoneNumber":{"type":"string","description":"The phone number for automatic validation","example":"0612345678"},"email":{"type":"string","format":"email","description":"The email address for automatic validation","example":"john.doe@example.com"},"authtype":{"type":"string","description":"The authorization type to use for iDIN authentication: AFTERVIEW -> Sign the document using iDIN, PREVIEW -> The signatory has to complete iDIN validation to view the document","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"}}},"IRMAAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"irma"},"authtype":{"type":"string","description":"The authorization type to use for IRMA authentication: AFTERVIEW -> Sign the document using IRMA, PREVIEW -> The signatory has to complete IRMA validation to view the document","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"},"initials":{"type":"string","description":"The initials (without dots), used for automatic validation (only required for PREVIEW)","example":"JD","maxLength":200,"minLength":1},"surname":{"type":"string","description":"The surname, used for automatic validation (only required for PREVIEW)","example":"Smith","maxLength":200,"minLength":1},"dateofbirth":{"type":"string","format":"date-time","description":"The date of birth (YYYY-MM-DD) for automatic validation","example":"1950-01-20","pattern":"^\\d\\d\\d\\d-\\d\\d-\\d\\d$"}}}],"description":"Authentication method for validating a signatory based on IRMA data"},"MouseSignatureAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"mouse"},"authtype":{"type":"string","description":"The authorization type to use for mouse signature authentication: AFTERVIEW -> Sign the document using a mouse signature, PREVIEW -> The signatory has enter a mouse signature to view the document","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"}}}],"description":"Authentication method for a signatory to add a mouse signature (drawing) to the document"},"SMSTANAuthenticationMethod":{"type":"object","description":"Authentication method for validating phone numbers with a SMS TAN code","properties":{"ordernumber":{"type":"integer","format":"int32","description":"The order in which the authentication methods should appear (numbered from low to high)","example":1},"type":{"type":"string","description":"The type of authentication method","example":"smstan"},"mobilePhone":{"type":"string","description":"A valid mobile phone number to validate a SMS TAN code for the signatory","example":"0612345678"},"authtype":{"type":"string","description":"The authorization type to use for SMS-TAN authentication: AFTERVIEW -> Sign the document using SMS-TAN, PREVIEW -> The signatory has to complete SMS-TAN validation to view the document","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"}},"required":["mobilePhone"]},"SSOAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/AuthenticationMethod"},{"type":"object","properties":{"type":{"type":"string","description":"The type of authentication method","example":"sso"},"authtype":{"type":"string","description":"The authorization type to use for SSO authentication: AFTERVIEW -> Sign the document using SSO, PREVIEW -> The signatory has to complete SSO validation to view the document","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"}}}],"description":"Authentication method for validating users by SSO"},"SignatoryUpdate":{"type":"object","properties":{"signatoryPublicUUID":{"type":"string","description":"Unique id (UUID format) for a signatory","example":"1eea3187-e62d-41e7-a5f7-7272c4f50f23"},"name":{"type":"string","description":"The full name of the signatory","example":"John Doo Smith","maxLength":250,"minLength":2},"email":{"type":"string","format":"email","description":"The email address of the signatory","example":"john.doo.smith@zynyo.com","maxLength":250,"minLength":5},"authenticationMethods":{"type":"array","description":"The authentication methods of the signatory","items":{"oneOf":[{"$ref":"#/components/schemas/CSCAuthenticationMethod"},{"$ref":"#/components/schemas/CertificateAuthenticationMethod"},{"$ref":"#/components/schemas/CheckedIDAuthenticationMethod"},{"$ref":"#/components/schemas/DigiDAuthenticationMethod"},{"$ref":"#/components/schemas/DocumentAnchorAuthenticationMethod"},{"$ref":"#/components/schemas/DocumentTemplateAuthenticationMethod"},{"$ref":"#/components/schemas/IDINAuthenticationMethod"},{"$ref":"#/components/schemas/IRMAAuthenticationMethod"},{"$ref":"#/components/schemas/MouseSignatureAuthenticationMethod"},{"$ref":"#/components/schemas/SMSTANAuthenticationMethod"},{"$ref":"#/components/schemas/SSOAuthenticationMethod"}]}},"smstanAuthenticationMethod":{"$ref":"#/components/schemas/SMSTANAuthenticationMethod","deprecated":true},"idinAuthenticationMethod":{"$ref":"#/components/schemas/IDINAuthenticationMethod","deprecated":true},"previewSmstanAuthenticationMethod":{"$ref":"#/components/schemas/SMSTANAuthenticationMethod","deprecated":true},"previewIdinAuthenticationMethod":{"$ref":"#/components/schemas/IDINAuthenticationMethod","deprecated":true}},"required":["signatoryPublicUUID"]},"CancelDocumentRequest":{"type":"object","description":"Model for cancelling a document","properties":{"documentUUID":{"type":"string","description":"The Zynyo document identifier (UUID)","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"}},"required":["documentUUID"]},"ModelDocumentTemplate":{"type":"object","description":"Model of a document template created in the Zynyo portal","properties":{"name":{"type":"string","description":"Name of the document template","example":"Rental contract 123 template","maxLength":250,"minLength":1},"filename":{"type":"string","description":"Name of the file the template is based upon","example":"contract_123.pdf"},"description":{"type":"string","description":"Description of the document template","example":"Template for rental contracts"},"documentTemplateUUID":{"type":"string","description":"Unique id (UUID format) that can be used as reference in a DocumentSignRequest","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"maxSignatories":{"type":"integer","format":"int32","description":"Maximum number of signatories that can sign with this template","example":2,"maximum":20,"minimum":1},"content":{"type":"string","format":"byte"},"templateLabels":{"type":"array","items":{"$ref":"#/components/schemas/ModelTemplateLabel"}},"documentTemplateSource":{"type":"string","description":"Source of where the document template is created in","enum":["DOCUMENT","BACKOFFICE","API","ANCHOR","ONBOARDING"],"example":"BACKOFFICE"},"activeDocumentsCount":{"type":"integer","format":"int32","description":"The number of documents in the system that used this template for signing","example":5},"dateCreated":{"type":"string","format":"date-time","description":"Date the template was created"}},"required":["documentTemplateSource","name"],"title":"DocumentTemplate"},"ModelTemplateLabel":{"type":"object","description":"Model of a label added to a document template","properties":{"identifier":{"type":"string","description":"Unique identifier for a document template label in UUID format","example":"3bfbf6e6-4f28-11ea-b77f-2e728ce88125"},"x":{"type":"number","format":"double","description":"X coordinate for the label","example":20.0},"y":{"type":"number","format":"double","description":"Y coordinate for the label","example":30.0},"width":{"type":"number","format":"double","description":"Label width","example":220.0},"height":{"type":"number","format":"double","description":"Label height","example":50.0},"minWidth":{"type":"number","format":"double","description":"Minimum label with","example":60.0},"minHeight":{"type":"number","format":"double","description":"Minimum label height","example":12.0},"pageIndex":{"type":"integer","format":"int32","description":"Page index for label, if 0 then the label is places on the last page","example":0},"signatoryIndex":{"type":"integer","format":"int32","description":"Index for signatory, label is displayed and filled by signatory with this index","example":1},"repeat":{"type":"boolean","description":"When true, label is repeated on every page","example":false},"notLastPage":{"type":"boolean","description":"When true, label is not on last page","example":false},"onlyLastPage":{"type":"boolean","description":"When true, label is only placed on last page","example":false},"required":{"type":"boolean","description":"When true, (input field label) is required for signatory","example":true},"name":{"type":"string","description":"The name of the label"},"templateLabelType":{"type":"string","description":"Label type","enum":["PARAPH","SIGNATURE","SIGNATURE_BLOCK","DATE","NAME","EMAIL","CERTIFICATE","TEXT","TEXTAREA","CHECKBOX","RADIO","SELECT","IDIN_FULLNAME","IDIN_LASTNAME","IDIN_INITIALS","IDIN_POSTALCODE","IDIN_STREET","IDIN_HOUSENUMBER","IDIN_HOUSENUMBER_SUFFIX","IDIN_CITY","IDIN_GENDER","IDIN_DAYOFBIRTH","IDIN_18OROLDER","LABEL"],"example":"SIGNATURE"},"defaultValue":{"type":"string","description":"Default value for input field label","example":"John Doo"},"placeholder":{"type":"string","description":"Placeholder value for input field label","example":"your name"},"characterLimit":{"type":"integer","format":"int32","description":"Max amount of characters for input field label","example":100},"characterRegex":{"type":"string","description":"Character regex validation for input field label","example":"[a-zA-Z0-9]"},"options":{"type":"array","description":"List of options for select/radio field label","items":{"type":"string"}}},"title":"TemplateLabel"},"DocumentTemplateUpdateRequest":{"type":"object","description":"Model for updating document templates","properties":{"name":{"type":"string","description":"Name of the document template","example":"Rental contract 123 template","maxLength":250,"minLength":1},"description":{"type":"string","description":"Description of the document template","example":"Template for rental contracts"},"maxSignatories":{"type":"integer","format":"int32","description":"Maximum number of signatories that can sign with this template","example":2,"maximum":10,"minimum":1},"filename":{"type":"string","description":"Name of the file","example":"filename.pdf"},"content":{"type":"string","format":"byte","description":"Contents of the pdf","example":"JVBERi0xLjQNJeLjz9MNCjc4IDAgb2JqDTw8L0xp......E2DQolJUVPRg0K"},"documentTemplateUUID":{"type":"string","description":"Unique id (UUID format) that can be used as reference in a DocumentSignRequest","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"templateLabels":{"type":"array","description":"The template items you want to add to the document","items":{"$ref":"#/components/schemas/ModelTemplateLabel"}}},"required":["documentTemplateUUID","templateLabels"]},"SignDocumentResponse":{"type":"object","description":"Model for response on a sign document request","properties":{"documentUUID":{"type":"string","description":"Unique identifier of the document","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"signatoryLink":{"type":"array","description":"Optional document signing links for signatories","items":{"$ref":"#/components/schemas/SignatoryLink"}}}},"SignatoryLink":{"type":"object","description":"Model for representing a link for signing a document for a signatory","properties":{"sequence":{"type":"integer","description":"Signing order for the signatory","example":1},"email":{"type":"string","description":"Email of the signatory","example":"john.doo.smith@zynyo.com"},"role":{"type":"string","description":"Role of the signatory","enum":["ACCEPTANCE","SIGN","DELIVERY","CC"],"example":"SIGN"},"signatoryUUID":{"type":"string","description":"Unique id (UUID format) for a signatory","example":"1eea3187-e62d-41e7-a5f7-7272c4f50f23"},"documentLink":{"type":"string","description":"Document sign link","example":"https://signingservice.zynyo.com/sign/1eea3187-e62d-41e7-a5f7-7272c4f50f23"}},"required":["email","role","sequence"]},"DocumentInfo":{"type":"object","description":"Model for providing document information","properties":{"name":{"type":"string","description":"The name for the document, this field is visible to the signatories","example":"Contract ABC","maxLength":255,"minLength":0},"description":{"type":"string","description":"A description of the document, this field is visible to the signatories and communicated in the (optional) invitation email","example":"Please sign the contract","maxLength":4000,"minLength":0}},"required":["name"]},"DocumentTemplateReference":{"type":"object","description":"Model for adding a reference to document template","properties":{"documentTemplateUUID":{"type":"string","description":"The UUID of a document template that you created in the Zynyo portal","example":"b222e244-4dd9-42a1-ae0a-af957b1650b7"}},"required":["documentTemplateUUID"]},"SignDocumentRequest":{"type":"object","description":"Model for signing a single document","properties":{"documentInfo":{"$ref":"#/components/schemas/DocumentInfo","description":"Properties for document info"},"signatories":{"type":"array","description":"The signatories for the document","items":{"$ref":"#/components/schemas/Signatory"},"maxItems":20,"minItems":1},"documentTemplate":{"$ref":"#/components/schemas/DocumentTemplateReference","description":"Use a specific document template (available at the portal)"},"useTimeStamp":{"type":"boolean","description":"Use a timestamp for the document","example":true},"expireAfter":{"type":"integer","format":"int32","description":"Time in days to expire documents, default is 30.","example":30,"maximum":90,"minimum":7},"enableLTV":{"type":"boolean","description":"Enable long term validation","example":true},"separateAuditlog":{"type":"boolean","description":"Separate the audit log from the document","example":false},"disableEmail":{"type":"boolean","description":"When true, no signed document email will be sent","example":false},"disableAttachment":{"type":"boolean","description":"When true, signed documents are not attached to the email","example":false},"signatureLabel":{"$ref":"#/components/schemas/SignatureLabel","description":"Optional label field for placing Zynyo signature label on a different location in the document"},"reference":{"type":"string","description":"Your document reference","example":"Document_12345","maxLength":500,"minLength":0},"submitter":{"type":"string","description":"The email address of the submitter","example":"john.smith@zynyo.com","maxLength":254,"minLength":0},"submitterName":{"type":"string","description":"The name of the submitter","example":"John Smith","maxLength":254,"minLength":0},"callbackURL":{"type":"string","description":"The url to post document status change callbacks, this overrides the url configured at API key level","example":"https://postman-echo.com/post","maxLength":2048,"minLength":0},"applicationVersion":{"type":"string","description":"The name and version of the application used to create this sign request","example":"MyApplication v1.0"},"sendDate":{"type":"string","description":"Send date to add to the audit log. The send date can be the number of days after signing or an absolute date in the format dd-mm-yyyy","example":7,"pattern":"^(\\d+|\\d\\d-\\d\\d-\\d\\d\\d\\d)$"},"parallel":{"type":"boolean","description":"Boolean that indicates whether the flow of signatories for this signrequest should be sequential or parallel.","example":false},"signrequestMetaData":{"type":"array","description":"The metadata for the sing request","items":{"$ref":"#/components/schemas/SignrequestMetaData"},"maxItems":100,"minItems":0},"content":{"type":"string","format":"byte","description":"Base64 encoded document (only PDF documents allowed)","example":"JVBERi0xLjQNJeLjz9MNCjc4IDAgb2JqDTw8L0xp......E2DQolJUVPRg0K"}},"required":["content","documentInfo","signatories"]},"Signatory":{"type":"object","description":"Model for signing signatories","properties":{"name":{"type":"string","description":"The full name of the signatory","example":"John Doo Smith","maxLength":250,"minLength":2},"email":{"type":"string","format":"email","description":"The email address of the signatory","example":"john.doo.smith@zynyo.com","maxLength":250,"minLength":5},"locale":{"type":"string","description":"The default locale (language) for the signatory","enum":["nl","en","de","fr","es","tr","nl_NL","en_US","de_DE","fr_FR","es_ES","tr_TR"],"example":"en_US"},"authenticationMethods":{"type":"array","description":"The methods of authentication for the signatory","items":{"oneOf":[{"$ref":"#/components/schemas/CSCAuthenticationMethod"},{"$ref":"#/components/schemas/CertificateAuthenticationMethod"},{"$ref":"#/components/schemas/CheckedIDAuthenticationMethod"},{"$ref":"#/components/schemas/DigiDAuthenticationMethod"},{"$ref":"#/components/schemas/DocumentAnchorAuthenticationMethod"},{"$ref":"#/components/schemas/DocumentTemplateAuthenticationMethod"},{"$ref":"#/components/schemas/IDINAuthenticationMethod"},{"$ref":"#/components/schemas/IRMAAuthenticationMethod"},{"$ref":"#/components/schemas/MouseSignatureAuthenticationMethod"},{"$ref":"#/components/schemas/SMSTANAuthenticationMethod"},{"$ref":"#/components/schemas/SSOAuthenticationMethod"}]}},"priority":{"type":"string","description":"The signatory priority; with 'HIGH_PRIORITY' invitations are send immediately even for signatories with aggregated invitation option enabled","enum":["DEFAULT","HIGH_PRIORITY"],"example":"DEFAULT"},"signatoryRole":{"type":"string","description":"The role of the signatory: \n\nSIGN -> The signatory has to sign the document\n\n ACCEPTANCE -> The signatory has to accept the document before the signing process is started (and therefore is not included in the auditlog)\n\n CC -> The signatory receives a copy of the signed document (without signing themselves)","enum":["ACCEPTANCE","SIGN","DELIVERY","CC"],"example":"SIGN"},"returnUrl":{"type":"string","description":"The url to redirect to when the signatory has finished signing","example":"http://link.to.yourportal/signatory1"},"disableInvitation":{"type":"boolean","description":"When true, no invitation emails will be sent","example":false},"disableStatusChange":{"type":"boolean","description":"When true, no status update emails will be sent","example":false},"disableEmail":{"type":"boolean","description":"When true, no signed document emails will be sent","example":false}},"required":["email","name","signatoryRole"]},"SignatureLabel":{"type":"object","description":"Model for changing the position of a signature label","properties":{"xcoordinate":{"type":"number","format":"double","description":"X coordinate for the label (i.e. on A4 20 = position left with padding, 475 = position right with padding)","example":20},"ycoordinate":{"type":"number","format":"double","description":"Y coordinate for the label (i.e. on A4 30 = position on bottom with padding, 725 = position on top with padding)","example":30},"height":{"type":"number","format":"double","description":"Label height, default = 50","example":50},"width":{"type":"number","format":"double","description":"Label width, default = 220","example":220},"pageIndex":{"type":"integer","format":"int32","description":"Page index to place label on, if 0 then the label is places on the last page","example":0},"stampImage":{"type":"string","description":"Base64 encoded content of your stampimage, container needs to be png within maximum dimensions of 200 by 200 pixels","example":"JVBERi0xLjQNJeLjz9MNCjc4IDAgb2JqDTw8L0xp......E2DQolJUVPRg0K"}},"required":["height","pageIndex","width","xcoordinate","ycoordinate"]},"SignrequestMetaData":{"type":"object","description":"Model for the sign request metadata values","properties":{"group":{"type":"string","description":"The group value for the data","example":"Pricing"},"key":{"type":"string","description":"The key data","example":"Cost group"},"value":{"type":"string","description":"The value data","example":"Internal"},"role":{"type":"string","description":"The optional required role","example":"admin"}}},"DocumentCallback":{"type":"object","description":"Callback received when document or signatory status change occurs","properties":{"documentUUID":{"type":"string","description":"Unique identifier of the document","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"currentState":{"type":"string","description":"Current state of the document","enum":["NOT_VALIDATED","PARTIALLY_VALIDATED","VALIDATED","DELIVERY_EXPIRED","AUDITLOG","DISPATCHED","SIGNED","SIGNED_DELIVERY_EXPIRED","SIGNED_DELIVERY_REJECTED","EXPIRED","ARCHIVED","AUTHENTICATION_FAILED","CANCELLED","REJECTED","ERROR"],"example":"VALIDATED"},"previousDocumentState":{"type":"string","description":"Previous state of the document","enum":["NOT_VALIDATED","PARTIALLY_VALIDATED","VALIDATED","DELIVERY_EXPIRED","AUDITLOG","DISPATCHED","SIGNED","SIGNED_DELIVERY_EXPIRED","SIGNED_DELIVERY_REJECTED","EXPIRED","ARCHIVED","AUTHENTICATION_FAILED","CANCELLED","REJECTED","ERROR"],"example":"NOT_VALIDATED"},"reference":{"type":"string","description":"Your document reference","example":"Document_12345"},"signatoryStatusList":{"type":"array","description":"List of signatory statuses","items":{"$ref":"#/components/schemas/SignatoryStatus"}}}},"SignatoryStatus":{"type":"object","description":"Status of a signatory","properties":{"email":{"type":"string","description":"The email address of the signatory","example":"john.doo.smith@zynyo.com"},"state":{"type":"string","description":"The current signatory state","enum":["CC","REPLACEMENT_CANDIDATE","AUTHORIZATION_CANDIDATE","REPLACED","DELEGATED","GROUP_COMPLETED","NOT_INVITED","AWAIT_EMAIL","EMAIL_SENT","UUID_ACCESSED","VIEWING","VIEWED","VALIDATED","DOWNLOAD_ACCESSED","DOWNLOADED","AUTHENTICATION_FAILED","REJECTED","E_EMAIL","ERROR"],"example":"VALIDATED"},"rejectReason":{"type":"string","description":"The signatory's reason for rejecting the document. Only available if the signatory has the REJECTED state.","example":"I rejected the contract because it is not the latest version"},"date":{"type":"string","format":"int64","description":"Timestamp of latest signatory state change","example":1577836800000}}},"ReminderResponse":{"type":"object","description":"Model for the response of a reminder request","properties":{"timesSent":{"type":"integer","description":"Amount of times a reminder is sent","example":2},"maxTimesAllowed":{"type":"integer","description":"Maximum amount of times a reminder can be sent","example":3},"reminderType":{"type":"string","description":"Reminder type sent","enum":["EMAIL","SMS"],"example":"EMAIL"}}},"ReminderRequest":{"type":"object","description":"Model for requesting a reminder","properties":{"documentUUID":{"type":"string","description":"The Zynyo document identifier (UUID)","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"signatoryEmail":{"type":"string","description":"The email of the signatory you want to send a reminder to","example":"john.doo.smith@zyny.com"},"reminderType":{"type":"string","description":"The type of reminder you want to send, SMS is only available when authentication method SMS-TAN is added","enum":["EMAIL","SMS"],"example":"EMAIL"}},"required":["documentUUID","reminderType","signatoryEmail"]},"SignMultiDocumentRequest":{"type":"object","description":"Model for signing multiple documents","properties":{"documentInfo":{"$ref":"#/components/schemas/DocumentInfo","description":"Properties for document info"},"signatories":{"type":"array","description":"The signatories for the document","items":{"$ref":"#/components/schemas/Signatory"},"maxItems":20,"minItems":1},"documentTemplate":{"$ref":"#/components/schemas/DocumentTemplateReference","description":"Use a specific document template (available at the portal)"},"useTimeStamp":{"type":"boolean","description":"Use a timestamp for the document","example":true},"expireAfter":{"type":"integer","format":"int32","description":"Time in days to expire documents, default is 30.","example":30,"maximum":90,"minimum":7},"enableLTV":{"type":"boolean","description":"Enable long term validation","example":true},"separateAuditlog":{"type":"boolean","description":"Separate the audit log from the document","example":false},"disableEmail":{"type":"boolean","description":"When true, no signed document email will be sent","example":false},"disableAttachment":{"type":"boolean","description":"When true, signed documents are not attached to the email","example":false},"signatureLabel":{"$ref":"#/components/schemas/SignatureLabel","description":"Optional label field for placing Zynyo signature label on a different location in the document"},"reference":{"type":"string","description":"Your document reference","example":"Document_12345","maxLength":500,"minLength":0},"submitter":{"type":"string","description":"The email address of the submitter","example":"john.smith@zynyo.com","maxLength":254,"minLength":0},"submitterName":{"type":"string","description":"The name of the submitter","example":"John Smith","maxLength":254,"minLength":0},"callbackURL":{"type":"string","description":"The url to post document status change callbacks, this overrides the url configured at API key level","example":"https://postman-echo.com/post","maxLength":2048,"minLength":0},"applicationVersion":{"type":"string","description":"The name and version of the application used to create this sign request","example":"MyApplication v1.0"},"sendDate":{"type":"string","description":"Send date to add to the audit log. The send date can be the number of days after signing or an absolute date in the format dd-mm-yyyy","example":7,"pattern":"^(\\d+|\\d\\d-\\d\\d-\\d\\d\\d\\d)$"},"parallel":{"type":"boolean","description":"Boolean that indicates whether the flow of signatories for this signrequest should be sequential or parallel.","example":false},"signrequestMetaData":{"type":"array","description":"The metadata for the sing request","items":{"$ref":"#/components/schemas/SignrequestMetaData"},"maxItems":100,"minItems":0},"content":{"type":"array","description":"Base64 encoded documents (only PDF documents allowed)","example":["JVBERi0xLjQNJeLjz9MNCjc4IDAgb2JqDTw8L0xp......E2DQolJUVPRg0K","JVBERi0xLjQNJeLjz9MNCjc4IDAgb2JqDTw8L0xp......E2DQolJUVPRg0K"],"items":{"type":"string","format":"byte"},"maxItems":2147483647,"minItems":1},"documentNames":{"type":"array","description":"Alternate document names for `SEPARATE_REQUESTS` documents","example":["document1.pdf","document2.pdf"],"items":{"type":"string"},"maxItems":2147483647,"minItems":1},"mergeType":{"type":"string","description":"The merge type for the documents, choose 'MERGE' to merge all content to a single document, choose 'SEPARATE_REQUESTS' to create a sign request for every document","enum":["MERGE","SEPARATE_REQUESTS"],"example":"MERGE"}},"required":["content","documentInfo","mergeType","signatories"]},"QuickSignDocumentResponse":{"type":"object","description":"Model of the response when quick signing documents","properties":{"content":{"type":"string","format":"byte","description":"Signed document bytes encoded with base64","example":"JVBERi0xLjQKNM19898CFMA....yKLMI178K7l9GCg=="},"fileName":{"type":"string","description":"Name of the file","example":"document.pdf"}}},"Certificate":{"type":"object","description":"Model of a certificate reference","properties":{"slot":{"type":"integer","format":"int32","description":"Your Zynyo HSM partition slot","example":2},"partitionPassword":{"type":"string","description":"Your Zynyo HSM partition password","example":"*****"},"certificateAccessToken":{"type":"string","description":"Your Zynyo HSM partition access token","example":"<token>"}},"required":["certificateAccessToken","partitionPassword","slot"]},"QuickSignDocumentRequest":{"type":"object","description":"Model of request for quick singing documents","properties":{"filename":{"type":"string","description":"Name of the file","example":"document.pdf"},"useTimeStamp":{"type":"boolean","description":"Use a timestamp for the document","example":true},"enableLTV":{"type":"boolean","description":"Enable long term validation","example":true},"content":{"type":"string","format":"byte","description":"Document bytes encoded with base64 (max 25MB)","example":"JVBERi0xLjQKNM19898CFMA....yKLMI178K7l9GCg=="},"certificate":{"$ref":"#/components/schemas/Certificate","deprecated":true,"description":"A certificate model if you want to use your own certificate from a Zynyo HSM partition"},"password":{"type":"string","description":"Optional PDF password","example":"MySecretPassword"}},"required":["content","filename"]},"SignHashResponse":{"type":"object","description":"Model of the response when signing a document hash","properties":{"signature":{"type":"string","description":"The resulting signature in base64"}}},"CertificateExpiredResponse":{"type":"object","description":"Model of the response when sealing a document and the certificate has expired","properties":{"message":{"type":"string","description":"The (error) message"},"newCertificate":{"type":"string","description":"The certificate in base64"}}},"SignHashRequest":{"type":"object","description":"Model of the request when signing a document hash","properties":{"documentHash":{"type":"string","description":"The base64 encoded hash of the document","maxLength":44,"minLength":44,"pattern":"[A-Za-z0-9+/]{43}={0,2}"}},"required":["documentHash"]},"DocumentTemplateCreationRequest":{"type":"object","description":"Model for creating document templates","properties":{"name":{"type":"string","description":"Name of the document template","example":"Rental contract 123 template","maxLength":250,"minLength":1},"filename":{"type":"string","description":"Name of the file the template is based upon","example":"contract_123.pdf"},"description":{"type":"string","description":"Description of the document template","example":"Template for rental contracts"},"maxSignatories":{"type":"integer","format":"int32","description":"Maximum number of signatories that can sign with this template","example":2,"maximum":10,"minimum":1},"content":{"type":"string","format":"byte","description":"Contents of the pdf","example":"JVBERi0xLjQNJeLjz9MNCjc4IDAgb2JqDTw8L0xp......E2DQolJUVPRg0K"},"documentTemplateSource":{"type":"string","description":"Source of the documentTemplate, should be left out or 'API'","example":"API"},"templateLabels":{"type":"array","description":"The template items you want to add to the document","items":{"$ref":"#/components/schemas/ModelTemplateLabel"}}},"required":["content","filename","name"]},"DeliveryAttachment":{"type":"object","description":"Model for delivery request attachments","properties":{"filename":{"type":"string","description":"Filename of the attachment","example":"MyAttachment.zip"},"content":{"type":"string","format":"byte","description":"Base64 encoded attachment content (max 50MB)","example":"JVBERi0xLjQKNM19898CFMA....yKLMI178K7l9GCg=="}},"required":["content","filename"]},"DeliveryRequest":{"type":"object","description":"Model for a delivery request","properties":{"subject":{"type":"string","description":"The subject of the message, this field is visible to the recipients","example":"Document ABC"},"message":{"type":"string","description":"The body of the message, this field is visible to authenticated recipients","example":"Please accept this document"},"submitter":{"$ref":"#/components/schemas/Recipient","description":"The submitter for the document"},"recipients":{"type":"array","description":"The recipients for the document","items":{"$ref":"#/components/schemas/Recipient"},"maxItems":2147483647,"minItems":1},"attachments":{"type":"array","description":"Attachments of the message","items":{"$ref":"#/components/schemas/DeliveryAttachment"},"maxItems":25,"minItems":1},"useTimeStamp":{"type":"boolean","description":"Use a timestamp for the message","example":true},"expireAfter":{"type":"integer","format":"int32","description":"Time in days to expire message, default is 30.","example":30,"maximum":90,"minimum":7},"enableLTV":{"type":"boolean","description":"Enable long term validation","example":true},"disableEmail":{"type":"boolean","description":"When true, no auditlog email is send","example":false},"signatureLabel":{"$ref":"#/components/schemas/SignatureLabel","description":"Optional label field for placing Zynyo signature label on a different location in the auditlog"},"reference":{"type":"string","description":"Your document reference","example":"Document_12345","maxLength":500,"minLength":0},"callbackURL":{"type":"string","description":"The url to post status change callbacks, this overrides the url configured at API key level","example":"https://postman-echo.com/post","maxLength":2048,"minLength":0},"applicationVersion":{"type":"string","description":"The name and version of the application used to create this delivery request","example":"MyApplication v1.0"},"sendDate":{"type":"string","description":"Send date to add to the audit log. The send date can be the number of days after signing or an absolute date in the format dd-mm-yyyy","example":7,"pattern":"^(\\d+|\\d\\d-\\d\\d-\\d\\d\\d\\d)$"}},"required":["recipients","subject","submitter"]},"Recipient":{"type":"object","description":"Model for delivery recipients","properties":{"name":{"type":"string","description":"The full name of the recipient","example":"John Doo Smith","maxLength":250,"minLength":2},"email":{"type":"string","format":"email","description":"The email address of the recipient","example":"john.doo.smith@zynyo.com","maxLength":250,"minLength":5},"locale":{"type":"string","description":"The default locale (language) for the recipient","enum":["nl","en","de","fr","es","tr","nl_NL","en_US","de_DE","fr_FR","es_ES","tr_TR"],"example":"en_US"},"authenticationMethods":{"type":"array","description":"The authentication methods for the recipient","items":{"oneOf":[{"$ref":"#/components/schemas/CSCAuthenticationMethod"},{"$ref":"#/components/schemas/CertificateAuthenticationMethod"},{"$ref":"#/components/schemas/CheckedIDAuthenticationMethod"},{"$ref":"#/components/schemas/DigiDAuthenticationMethod"},{"$ref":"#/components/schemas/DocumentAnchorAuthenticationMethod"},{"$ref":"#/components/schemas/DocumentTemplateAuthenticationMethod"},{"$ref":"#/components/schemas/IDINAuthenticationMethod"},{"$ref":"#/components/schemas/IRMAAuthenticationMethod"},{"$ref":"#/components/schemas/MouseSignatureAuthenticationMethod"},{"$ref":"#/components/schemas/SMSTANAuthenticationMethod"},{"$ref":"#/components/schemas/SSOAuthenticationMethod"}]}},"priority":{"type":"string","description":"The recipient priority; with 'HIGH_PRIORITY' invitations are send immediately even for recipients with aggregated invitation option enabled","enum":["DEFAULT","HIGH_PRIORITY"],"example":"DEFAULT"},"recipientRole":{"type":"string","description":"The role of the recipient: DELIVERY -> The recipient has to read the message, CC -> The recipient receives a copy of auditlog","enum":["DELIVERY","CC"],"example":"DELIVERY"},"disableInvitation":{"type":"boolean","description":"When true, no invitation email is send","example":false},"disableStatusChange":{"type":"boolean","description":"When true, no status update email is send","example":false},"disableEmail":{"type":"boolean","description":"When true, no signed document email is send","example":false}},"required":["email","name"]},"Usage":{"type":"object","properties":{"count":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["AUDITLOG","CHECKEDID","CSC","DELIVERY","DIGID","DIGIDENTITY","EMAIL","IDIN","ISMS","YIVI","PREVIEW","QUICKSIGN","SIGNATORY","SIGN","SMS","SSO","TIMESTAMP"]}}},"SignatoryStateLog":{"type":"object","properties":{"documentUUID":{"type":"string"},"signatoryEmail":{"type":"string"},"signatoryName":{"type":"string"},"signatoryState":{"type":"string","enum":["CC","REPLACEMENT_CANDIDATE","AUTHORIZATION_CANDIDATE","REPLACED","DELEGATED","GROUP_COMPLETED","NOT_INVITED","AWAIT_EMAIL","EMAIL_SENT","UUID_ACCESSED","VIEWING","VIEWED","VALIDATED","DOWNLOAD_ACCESSED","DOWNLOADED","AUTHENTICATION_FAILED","REJECTED","E_EMAIL","ERROR"]},"signatoryRole":{"type":"string","enum":["ACCEPTANCE","SIGN","SIGN_OPTION","SIGN_AUTHORIZED","SIGN_REPLACEMENT","DELIVERY","CC"]},"info":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}},"DocumentStateLog":{"type":"object","properties":{"documentUUID":{"type":"string"},"documentName":{"type":"string"},"documentState":{"type":"string","enum":["NOT_VALIDATED","PARTIALLY_VALIDATED","VALIDATED","DELIVERY_EXPIRED","AUDITLOG","DISPATCHED","SIGNED","SIGNED_DELIVERY_EXPIRED","SIGNED_DELIVERY_REJECTED","EXPIRED","ARCHIVED","AUTHENTICATION_FAILED","CANCELLED","REJECTED","ERROR"]},"info":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}},"SignedDocumentResponse":{"type":"object","description":"Model for document content","properties":{"documentContent":{"type":"string","format":"byte","description":"Document bytes encoded as base64","example":"JVBERi0xLjQNJeLjz9MNCjc4IDAgb2JqDTw8L0xp......E2DQolJUVPRg0K<"},"auditlogContent":{"type":"string","format":"byte","description":"Audit log bytes encoded as base64","example":"JKJJIioju9khjKJjzKKLSDSIDDAgbJKAJKjlkjos......KOJihjlahsdIKL"}}},"CertificateResponse":{"type":"object","description":"Model of the response when requesting a certificate","properties":{"certificate":{"type":"string","description":"The certificate in base64"}}},"Attachment":{"type":"object","description":"Model of an email attachment","properties":{"id":{"type":"integer","format":"int64","description":"Identifier of the attachment","example":1},"filename":{"type":"string","description":"Filename of the attachment","example":"contract.pdf"},"type":{"type":"string","description":"Mimetype of the attachment","example":"application/pdf"},"disposition":{"type":"string","description":"Disposition of the attachment in the email","example":"inline"},"contents":{"type":"string","description":"Base64 representation of the file bytes","example":"..."}}},"Email":{"type":"object","description":"Model of an email message for the signingservice","properties":{"id":{"type":"integer","format":"int64","description":"Email identifier","example":1},"externalId":{"type":"string","description":"External mail identifier"},"added":{"type":"string","format":"int64","description":"Timestamp for email creation","example":1577836800000},"state":{"type":"string","description":"Current email state","enum":["NOT_SENT","STORED","SENT","ERROR","CLEANED","PROCESSED","DEFERRED","DELIVERED","OPEN","CLICK","BOUNCE","DROPPED","SPAMREPORT"],"example":"NOT_SEND"},"subject":{"type":"string","description":"Email subject","example":"Invitation to sign the document"},"to":{"type":"array","description":"List of receiver addresses","items":{"$ref":"#/components/schemas/ModelAddress"}},"html":{"type":"string","description":"Html representation of the email message","example":"<html>...</html>"},"plainText":{"type":"string","description":"Plain text representation of the email message","example":"Please sign the document, ..."},"errorMessage":{"type":"string","description":"Error message if there is an error sending the email","example":"Bounced address"},"attachments":{"type":"array","description":"List of attachments added to the email","items":{"$ref":"#/components/schemas/Attachment"}}}},"ModelAddress":{"type":"object","description":"Model of an email receiver address","properties":{"id":{"type":"integer","format":"int64","description":"Address identifier","example":1},"name":{"type":"string","description":"Name of the receiver","example":"John Doo Smith"},"address":{"type":"string","description":"Email address of the receiver","example":"john.doo.smith@zynyo.com"}},"title":"Address"},"DocumentSummary":{"type":"object","description":"Summary of the number of documents and the average duration to sign them","properties":{"documentsCount":{"type":"integer","format":"int32","description":"The number of documents","example":1234},"avgDuration":{"type":"string","format":"double","description":"The average duration to sign a document","example":169570.335}}},"DocumentFile":{"type":"object","description":"Model for eDelivery files","properties":{"name":{"type":"string","description":"Name of the file","example":"delivery.zip"},"fileUUID":{"type":"string","description":"Unique identifier of the file","example":"ef141763-6417-4043-8a79-7f3269338d00"}}},"EmailStateReport":{"type":"object","description":"Model of an email state report","properties":{"added":{"type":"string","format":"int64","description":"Timestamp for email creation","example":1577836800000},"state":{"type":"string","description":"Current email state","enum":["NOT_SENT","STORED","SENT","ERROR","CLEANED","PROCESSED","DEFERRED","DELIVERED","OPEN","CLICK","BOUNCE","DROPPED","SPAMREPORT"],"example":"NOT_SEND"},"subject":{"type":"string","description":"The subject of the send email","example":"Invitation to sign"},"toAddress":{"type":"string","description":"Email address of the receiver","example":"john.doo.smith@zynyo.com"},"errorMessage":{"type":"string","description":"Error message if there is an error sending the email","example":"Bounced address"}}},"ModelAuthenticationMethod":{"type":"object","description":"The methods of authentication for the signatory","discriminator":{"propertyName":"authenticationMethods","mapping":{"SMSTAN":"#/components/schemas/ModelSMSTANAuthenticationMethod","SMSTAN_PREVIEW":"#/components/schemas/ModelSMSTANAuthenticationMethod","MOUSE":"#/components/schemas/ModelMouseSignatureAuthenticationMethod","MOUSE_PREVIEW":"#/components/schemas/ModelMouseSignatureAuthenticationMethod","IDIN":"#/components/schemas/ModelIDINAuthenticationMethod","IDIN_PREVIEW":"#/components/schemas/ModelIDINAuthenticationMethod","DOCUMENT_TEMPLATE":"#/components/schemas/ModelDocumentTemplateAuthenticationMethod","DOCUMENT_ANCHORS":"#/components/schemas/ModelDocumentAnchorAuthenticationMethod","CSC":"#/components/schemas/ModelCSCAuthenticationMethod","CSC_PREVIEW":"#/components/schemas/ModelCSCAuthenticationMethod","IRMA":"#/components/schemas/ModelIRMAAuthenticationMethod","IRMA_PREVIEW":"#/components/schemas/ModelIRMAAuthenticationMethod","DIGID":"#/components/schemas/ModelDigiDAuthenticationMethod","DIGID_PREVIEW":"#/components/schemas/ModelDigiDAuthenticationMethod","CHECKEDID":"#/components/schemas/ModelCheckedIDAuthenticationMethod","SSO":"#/components/schemas/ModelSSOAuthenticationMethod","SSO_PREVIEW":"#/components/schemas/ModelSSOAuthenticationMethod"}},"properties":{"dateStarted":{"type":"string","format":"int64","description":"Timestamp of start of authentication","example":1577836800000},"dateEnded":{"type":"string","format":"int64","description":"Timestamp of authentication finished","example":1577836800000},"ordernumber":{"type":"integer","format":"int32","description":"Setting the order of the authentication methods","example":1},"authenticationMethods":{"type":"string"}},"required":["authenticationMethods"],"title":"AuthenticationMethod"},"ModelCSCAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"providerName":{"type":"string"},"allowedCSCProviders":{"type":"array","items":{"type":"string"}},"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","PROVIDER_SELECTED","SERVICE_AUTHENTICATED","CREDENTIAL_RETRIEVED","SAD_CREATED","SAD_ASYNC","SIGN_ASYNC","VALIDATED","VALIDATION_FAILED","ERROR"]},"visualSignature":{"$ref":"#/components/schemas/ModelSignatureLabel"},"visualSignatureRequired":{"type":"boolean"},"authType":{"type":"string","description":"The authorization type to use for CSC authentication: AFTERVIEW -> Sign the document using CSC, PREVIEW -> The signatory had to complete CSC validation to view the document","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"},"givenName":{"type":"string","maxLength":200,"minLength":1},"surName":{"type":"string","maxLength":200,"minLength":1},"birthDate":{"type":"string","format":"date"}}}],"description":"Model for validating a person with CSC","title":"CSCAuthenticationMethod"},"ModelCheckedIDAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"hideBsn":{"type":"boolean","description":"Whether the BSN should be hidden"},"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","APPSTART","VERIFYSTART","RESEND","INVITED","COMPLETED","REPORT_FINISHED","VALIDATED","FAILED","ERROR","CANCELLED","TIMEOUT"]},"customerReference":{"type":"string","description":"The customer reference"},"validity":{"type":"integer","format":"int32","description":"The time in hours for the validity of the invitation","maximum":48,"minimum":6},"preferredLanguage":{"type":"string","description":"Preferred language ('nl' or 'en')"},"dossierNumber":{"type":"string"},"details":{"type":"string"},"detailsMessageCode":{"type":"string"},"status":{"type":"string"}}}],"description":"Model for validating a person with CheckedID","title":"CheckedIDAuthenticationMethod"},"ModelDigiDAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","AUTHENTICATION_REQUEST","VALIDATED","CANCELLED","ERROR"]},"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"authType":{"type":"string","description":"The current authorization type","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"}}}],"description":"Model for validating a person with DigiD","title":"DigiDAuthenticationMethod"},"ModelDocument":{"type":"object","description":"Model for documents","properties":{"documentUUID":{"type":"string","description":"Unique identifier of the document","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"name":{"type":"string","description":"Name of the document","example":"Contract ABC"},"description":{"type":"string","description":"Description readable for signatories","example":"Please sign the contract"},"documentState":{"type":"string","description":"The current document state","enum":["NOT_VALIDATED","PARTIALLY_VALIDATED","VALIDATED","DELIVERY_EXPIRED","AUDITLOG","DISPATCHED","SIGNED","SIGNED_DELIVERY_EXPIRED","SIGNED_DELIVERY_REJECTED","EXPIRED","ARCHIVED","AUTHENTICATION_FAILED","CANCELLED","REJECTED","ERROR"],"example":"PARTIALLY_VALIDATED"},"previousState":{"type":"string","description":"The previous document state","enum":["NOT_VALIDATED","PARTIALLY_VALIDATED","VALIDATED","DELIVERY_EXPIRED","AUDITLOG","DISPATCHED","SIGNED","SIGNED_DELIVERY_EXPIRED","SIGNED_DELIVERY_REJECTED","EXPIRED","ARCHIVED","AUTHENTICATION_FAILED","CANCELLED","REJECTED","ERROR"],"example":"NOT_VALIDATED"},"stateChangedDate":{"type":"string","format":"int64","description":"Timestamp of latest document state change","example":1577836800000},"documentGroup":{"$ref":"#/components/schemas/ModelDocumentGroup","description":"Document requests can be grouped together"},"signRequest":{"$ref":"#/components/schemas/ModelSignRequest","description":"The values for the document sign request"},"signatories":{"type":"array","description":"The signatories for the document","items":{"$ref":"#/components/schemas/ModelSignatory"}},"ltvEnabled":{"type":"boolean","description":"When true, document long term validation is enabled","example":true},"useTimeStamp":{"type":"boolean","description":"When true, a timestamp is added in the signature","example":true},"numberOfPages":{"type":"integer","format":"int32","description":"The number of pages for the document","example":5},"changesAllowed":{"type":"boolean","description":"Whether the document is allowed to be modified (i.e. placing a mouse signature or appending the auditlog)","example":true},"documentTemplate":{"$ref":"#/components/schemas/ModelDocumentTemplate","description":"When a document template for the sign request is added, this model displays the document template data"},"files":{"type":"array","description":"File attachments for delivery requests, empty for sign requests","items":{"$ref":"#/components/schemas/DocumentFile"}},"rejectReason":{"type":"string","description":"The reason for rejection of a signatory","example":"The contract is the wrong version"}},"required":["signatories"],"title":"Document"},"ModelDocumentAnchorAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]}}}],"description":"Model for authentication using a document template generated via document anchors"},"ModelDocumentGroup":{"type":"object","description":"Model for document groups","properties":{"documentGroupId":{"type":"string","description":"Unique id for a document group","example":"3eea8987-e33d-43e7-a1f7-7272c4f50f23"},"documentCount":{"type":"integer","format":"int32","description":"The number of document in the group","example":4}},"title":"DocumentGroup"},"ModelDocumentTemplateAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","DRAW","VALIDATED"]}}}],"description":"Model for authentication using a document template","title":"DocumentTemplateAuthenticationMethod"},"ModelIDINAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"legalLastname":{"type":"string","maxLength":200,"minLength":1},"legalLastnamePrefix":{"type":"string","maxLength":10,"minLength":0},"initials":{"type":"string","maxLength":24,"minLength":1},"dateofbirth":{"type":"string","pattern":"\\d{2}-\\d{2}-\\d{4}"},"houseno":{"type":"integer","format":"int32","maximum":99999},"housenosuf":{"type":"string","maxLength":6,"minLength":0},"postalcode":{"type":"string","maxLength":6,"minLength":0},"city":{"type":"string","maxLength":24,"minLength":0},"email":{"type":"string"},"phoneNumber":{"type":"string"},"authType":{"type":"string","description":"The current authorization type","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"},"processState":{"type":"string","enum":["START","AUTHENTICATION_REQUEST","OPEN","PENDING","EXPIRED","RETURN_SUCCESS","VALIDATED","CANCELLED","FAILURE","FAILED"]}}}],"description":"Model for authentication with iDIN","title":"IDINAuthenticationMethod"},"ModelIRMAAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","LOADING","MEDIUMCONTEMPLATION","SHOWINGQRCODE","CONTINUEON2NDDEVICE","SHOWINGIRMABUTTON","SHOWINGQRCODEINSTEAD","CONTINUEINIRMAAPP","DATARECEIVED","CANCELLED","TIMEDOUT","ERROR","BROWSERNOTSUPPORTED","ATTRIBUTE_MISMATCH","VALIDATED","ABORTED"]},"authType":{"type":"string","description":"The current authorization type","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"},"initials":{"type":"string","maxLength":200,"minLength":1},"surname":{"type":"string","maxLength":200,"minLength":1},"dateOfBirth":{"type":"string","pattern":"\\d{2}-\\d{2}-\\d{4}"}}}],"description":"Model for validating a person with IRMA attributes","title":"IRMAAuthenticationMethod"},"ModelMouseSignatureAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","DRAW","VALIDATED"]},"authType":{"type":"string","description":"The current authorization type","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"}}}],"description":"Model for mouse authentication","title":"MouseSignatureAuthenticationMethod"},"ModelSMSTANAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","AWAIT_TAN","VALIDATED","CANCELLED","FAILED","E_SMS_DELIVERY_FAILURE","E_SMS_DISPATCH_FAILURE","E_TAN_EXPIRED","E_TAN_MAX_TIMES_REQUESTED"]},"stateReason":{"type":"string"},"mobilePhone":{"type":"string","description":"The mobile phone to validate"},"authType":{"type":"string","description":"The current authorization type","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"}}}],"description":"Model for validating a phone number with a SMS TAN code","title":"SMSTANAuthenticationMethod"},"ModelSSOAuthenticationMethod":{"allOf":[{"$ref":"#/components/schemas/ModelAuthenticationMethod"},{"type":"object","properties":{"authLevel":{"type":"string","description":"The eIDAS signature level","enum":["SIMPLE","ADVANCED","QUALIFIED"]},"processState":{"type":"string","description":"Current process state for the authentication","enum":["START","LOGIN","LOGGED_IN","VALIDATED"]},"authType":{"type":"string","description":"The current authorization type","enum":["PREVIEW","AFTERVIEW"],"example":"AFTERVIEW"},"oauthProvider":{"type":"string","description":"The ID of the oauth provider","example":"zynyowebappclient-accountname"},"oauthProviderName":{"type":"string","description":"The name of the oauth provider","example":"Account Name"}}}],"description":"Model for sso authentication","title":"SSOAuthenticationMethod"},"ModelSignRequest":{"type":"object","description":"Model for the sign request values","properties":{"apiAccountName":{"type":"string","description":"The name of the api on which the sign request was submitted","example":"testapikey"},"apiAccountDisplayName":{"type":"string","description":"The display name of the api on which the sign request was submitted","example":"api"},"allowTextSignature":{"type":"boolean","description":"When true, signatories are allowed to sign using a text-based signature","example":true},"signingRequested":{"type":"string","format":"int64","description":"Timestamp for the document sign request","example":1577836800000},"separateAuditlog":{"type":"boolean","description":"When true, the audit log is separated of the document","example":false},"disableEmail":{"type":"boolean","description":"When true, no signed document email is sent","example":false},"disableAttachment":{"type":"boolean","description":"When true, signed documents are not attached to the email","example":false},"reference":{"type":"string","description":"Document sign request reference","example":"document 1234"},"submitter":{"type":"string","description":"Email address of submitter of the document sign request","example":"john.doo.smith@zynyo.com"},"submitterName":{"type":"string","description":"Name of submitter of the document sign request","example":"John Doo Smith"},"createdAt":{"type":"string","format":"int64","description":"The creation date of the sign request","example":1577836800000},"expireAt":{"type":"string","format":"int64","description":"Expiration date for the sign request","example":1580428800000},"callbackURL":{"type":"string","description":"Callback URL for posting document status callbacks, overrides API key level","example":"https://postman-echo.com/post"},"applicationVersion":{"type":"string","description":"The name and version of the application used to create this sign request","example":"MyApplication v1.0"},"sendDate":{"type":"string","description":"Send date to add to the audit log. The send date can be the number of days after signing or an absolute date in the format dd-mm-yyyy","example":7,"pattern":"^(\\d+|\\d\\d-\\d\\d-\\d\\d\\d\\d)$"},"parallel":{"type":"boolean","description":"Boolean that indicates whether the flow of inviting the signatories should be parallel or sequential","example":false},"signRequestType":{"type":"string","description":"The type of sign request","enum":["SIGN","DELIVERY"],"example":"SIGN"},"signrequestMetaDataList":{"type":"array","description":"The metadata for the sign request","items":{"$ref":"#/components/schemas/ModelSignrequestMetaData"}}},"title":"SignRequest"},"ModelSignatory":{"type":"object","description":"Model for a signatory","properties":{"name":{"type":"string","description":"The full name of the signatory","example":"John Doo Smith","maxLength":250,"minLength":2},"email":{"type":"string","format":"email","description":"The email address of the signatory","example":"john.doo.smith@zynyo.com","maxLength":250,"minLength":5},"signatoryLocale":{"type":"string","description":"The default locale (language) for the signatory","enum":["nl","en","de","fr","es","tr","nl_NL","en_US","de_DE","fr_FR","es_ES","tr_TR"],"example":"en_US"},"lastStateChangeAt":{"type":"string","format":"int64","description":"Timestamp of latest signatory state change","example":1577836800000},"state":{"type":"string","description":"The current signatory state","enum":["CC","REPLACEMENT_CANDIDATE","AUTHORIZATION_CANDIDATE","REPLACED","DELEGATED","GROUP_COMPLETED","NOT_INVITED","AWAIT_EMAIL","EMAIL_SENT","UUID_ACCESSED","VIEWING","VIEWED","VALIDATED","DOWNLOAD_ACCESSED","DOWNLOADED","AUTHENTICATION_FAILED","REJECTED","E_EMAIL","ERROR"],"example":"VALIDATED"},"timesMailReminderSent":{"type":"integer","format":"int32","description":"The number of times of a mail reminder has been sent to the signatory","example":1},"timesMailAlllowed":{"type":"integer","format":"int32","description":"The number of times a mail reminder is allowed","example":3},"timesSMSReminderSent":{"type":"integer","format":"int32","description":"The number of times of a sms reminder has been sent to the signatory","example":1},"timesSMSAllowed":{"type":"integer","format":"int32","description":"The number of times a sms reminder is allowed","example":3},"enhancedTextSize":{"type":"boolean","description":"Whether the signatory has enabled a bigger text size"},"enhancedContrast":{"type":"boolean","description":"Whether the signatory has enabled a larger color contrast"},"authenticationMethods":{"type":"array","description":"The  methods of authentication for the signatory","items":{"oneOf":[{"$ref":"#/components/schemas/ModelCSCAuthenticationMethod"},{"$ref":"#/components/schemas/ModelCheckedIDAuthenticationMethod"},{"$ref":"#/components/schemas/ModelDigiDAuthenticationMethod"},{"$ref":"#/components/schemas/ModelDocumentAnchorAuthenticationMethod"},{"$ref":"#/components/schemas/ModelDocumentTemplateAuthenticationMethod"},{"$ref":"#/components/schemas/ModelIDINAuthenticationMethod"},{"$ref":"#/components/schemas/ModelIRMAAuthenticationMethod"},{"$ref":"#/components/schemas/ModelMouseSignatureAuthenticationMethod"},{"$ref":"#/components/schemas/ModelSMSTANAuthenticationMethod"},{"$ref":"#/components/schemas/ModelSSOAuthenticationMethod"}]}},"orderNumber":{"type":"integer","format":"int32","description":"The order of the signatory","example":0},"rejectReason":{"type":"string","description":"The signatory's reason for rejecting the document.","example":"I rejected the contract because it is not the latest version"},"publicUUID":{"type":"string","description":"(external) UUID for the signatory","example":"3eea8187-e63d-43e7-a1f7-7272c4f50f23"},"priority":{"type":"string","description":"Submitted priority for the signatory","enum":["DEFAULT","HIGH_PRIORITY"],"example":"DEFAULT"},"signatoryRole":{"type":"string","description":"Participation role for the signatory","enum":["ACCEPTANCE","SIGN","SIGN_OPTION","SIGN_AUTHORIZED","SIGN_REPLACEMENT","DELIVERY","CC"],"example":"SIGN"},"returnUrl":{"type":"string","description":"The return url to redirect to when finished signing","example":"https://your_application_url"},"disableInvitation":{"type":"boolean","description":"When true, invitation email is disabled","example":false},"disableStatusChange":{"type":"boolean","description":"When true, status email is disabled","example":false},"disableEmail":{"type":"boolean","description":"When true, signed document email is disabled","example":false},"errorEmailReason":{"type":"string","description":"If there is a problem sending the email to the signatory the reason is in this field","example":"Bounced Address"},"emailStateReports":{"type":"array","description":"The state reports of the send emails","items":{"$ref":"#/components/schemas/EmailStateReport"}}},"required":["email","name","signatoryRole"],"title":"Signatory"},"ModelSignatureLabel":{"type":"object","description":"Model for a signature label","properties":{"xCoordinate":{"type":"number","format":"double","description":"The x coordinate of the label","example":30},"yCoordinate":{"type":"number","format":"double","description":"The y coordinate of the label","example":230},"height":{"type":"number","format":"double","description":"The height of the label","example":20},"width":{"type":"number","format":"double","description":"The with of the label","example":110},"pageIndex":{"type":"integer","format":"int32","description":"The page index of the appearance of the label","example":3},"url":{"type":"string","description":"Url for image representation"},"type":{"type":"string","description":"Type of label used"},"required":{"type":"boolean","description":"When true, the label is required"},"name":{"type":"string","description":"The name of the label"},"labelValue":{"type":"string","description":"Value entered by signatory if label has input option"},"tabStop":{"type":"integer","format":"int32","description":"The tab stop number if the label user input enabled","example":1},"templateLabelType":{"type":"string","description":"Type if label is part of template","enum":["PARAPH","SIGNATURE","SIGNATURE_BLOCK","DATE","NAME","EMAIL","CERTIFICATE","TEXT","TEXTAREA","CHECKBOX","RADIO","SELECT","IDIN_FULLNAME","IDIN_LASTNAME","IDIN_INITIALS","IDIN_POSTALCODE","IDIN_STREET","IDIN_HOUSENUMBER","IDIN_HOUSENUMBER_SUFFIX","IDIN_CITY","IDIN_GENDER","IDIN_DAYOFBIRTH","IDIN_18OROLDER","LABEL"]},"guid":{"type":"string","description":"Unique id for displaying in user interface"},"defaultValue":{"type":"string","description":"Input field default value if label is part of template"},"placeholder":{"type":"string","description":"Input field placeholder if label is part of template"},"characterLimit":{"type":"integer","format":"int32","description":"Maximum number of characters for input field if label is part of template","example":20},"characterRegex":{"type":"string","description":"Regex restriction of input field if label is part of template"},"labelState":{"type":"string","description":"Current state of label"},"signatoryUUID":{"type":"string","description":"Unique id of signatory"},"stampImage":{"type":"string","description":"Base64 encoded content of your stampimage, container needs to be png within maximum dimensions of 200 by 200 pixels"},"options":{"type":"array","description":"List of options for select/radio field label","example":"Option 1;Option 2;Option 3","items":{"type":"string"}}},"title":"SignatureLabel"},"ModelSignrequestMetaData":{"type":"object","description":"Model for the sign request metadata values","properties":{"group":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"}},"title":"SignrequestMetaData"}}}}