{"items":[{"type":"link","label":"Namirial Notify APIs","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api","content":{"contentType":"overview","meta":{"name":"Namirial Notify APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"namirialnotify-api.json","url":"/_bundle/@l10n/it/products/namirialnotify/apis/oas/namirialnotify-api.json?download"},{"kind":"download","label":"namirialnotify-api.yaml","url":"/_bundle/@l10n/it/products/namirialnotify/apis/oas/namirialnotify-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Namirial Notify APIs (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unified OpenAPI reference for the Namirial Notify service APIs. This specification aggregates EviNotice, EviMail, EviSMS, EviSign, EviPost, and shared affidavit and attachment download endpoints. EviNotice, EviMail, and EviSMS each group their single-message and batch operations together. In the public Namirial Notify API environments, single-message operations for EviMail, EviSMS, and EviPost use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" base path. EviMail and EviSMS batch operations use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/EviMail/Batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/EviSms/Batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", respectively. EviSign issuer operations use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/evisign"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; Bundle uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/evisign/{Id}/bundle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". SignLink overrides the server to the application host and uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/EviSign/SignLink"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Some lower-level technical artifacts may show those V1 routes without the prefix. For customer integrations, use the public paths shown in this specification. For the public Namirial Notify API environments, EviNotice routes use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" base path. The legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v2/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form is still accepted for backward compatibility."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"separator","label":"Service operations","content":null},{"type":"group","label":"EviNotice","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice","items":[{"label":"Submit a new EviNotice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticesubmit","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticesubmit","metadata":{"seo":{"title":"Submit a new EviNotice","description":"Submit a new EviNotice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeSubmit","name":"Submit a new EviNotice","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a new EviNotice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Evi-IdempotencyToken","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional idempotency token (UUID recommended) to prevent duplicate submissions on retry. A replay of a cached "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submission returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Responses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"408"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not cached for replay."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1EviNotice~1Submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeSubmitRequest","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/standardSimple","paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/advancedComplete"]}},"schemaId":"components/schemas/EviNoticeSubmitRequest","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/standardSimple","paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/advancedComplete"],"pointer":"/paths/~1v2~1EviNotice~1Submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviNotice/Submit","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Evi-IdempotencyToken","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviNoticeSubmitRequest","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/standardSimple","paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/advancedComplete"]}},"responseCodes":["200","202","400","401","403","405","409"],"pointer":"/v2/EviNotice/Submit","href":"evinotice/evinoticesubmit","openApiOperationId":"eviNoticeSubmit","summary":"Submit a new EviNotice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviNoticeSubmitRequest","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/standardSimple","paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/advancedComplete"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeSubmitRequest","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/standardSimple","paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/advancedComplete"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"EviNotice accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/200/content/application~1json/example"],"headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["New"]}}},"headerSchemaId":"schema_1"},{"code":"202","description":"Idempotent replay. The same X-Evi-IdempotencyToken was used for a cached 200 OK submission. The original response body is returned; the notice is not resubmitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/202/content/application~1json/example"],"headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Replay"]}}},"headerSchemaId":"schema_2"},{"code":"400","description":"Invalid request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/EviNoticeProblem"}},"schemaId":"components/schemas/EviNoticeProblem"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The authenticated account lacks the required API permission for EviNotice, or the account has insufficient credit balance to submit the notice."},{"code":"405","description":"Requested WhatsApp notification or PIN service is disabled."},{"code":"409","description":"Another Submit with the same X-Evi-IdempotencyToken is currently in flight.","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Conflict"]}}},"headerSchemaId":"schema_3"}],"pointer":"/paths/~1v2~1EviNotice~1Submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/200/content/application~1json/example"]}}},{"code":"202","schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeSubmitResponse","exampleIds":["paths/~1v2~1EviNotice~1Submit/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/EviNoticeProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/EviNoticeProblem"}}},{"code":"401"},{"code":"403"},{"code":"405"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticesubmit"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Submit"},{"label":"Get a single EviNotice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeget","metadata":{"seo":{"title":"Get a single EviNotice","description":"Get a single EviNotice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeGet","name":"Get a single EviNotice","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1{Id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single EviNotice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","schemaId":"schema_4","description":"The UUID of the EviNotice returned at submission.","required":true}],"pointer":"/paths/~1v2~1EviNotice~1{Id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"IncludeAffidavits","in":"query","schemaId":"schema_5","description":"Include affidavit metadata in the response."},{"name":"IncludeAttachments","in":"query","schemaId":"schema_5","description":"Include attachment metadata in the response."}],"pointer":"/paths/~1v2~1EviNotice~1{Id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/{Id}","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"IncludeAffidavits","in":"query","schemaId":"schema_5"},{"name":"IncludeAttachments","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/EviNotice/{Id}","href":"evinotice/evinoticeget","openApiOperationId":"eviNoticeGet","summary":"Get a single EviNotice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"EviNotice retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeGetResponse","exampleIds":["paths/~1v2~1EviNotice~1{Id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeGetResponse","exampleIds":["paths/~1v2~1EviNotice~1{Id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request"},{"code":"401","description":"Authentication failed"},{"code":"404","description":"EviNotice not found"}],"pointer":"/paths/~1v2~1EviNotice~1{Id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeGetResponse","exampleIds":["paths/~1v2~1EviNotice~1{Id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeGetResponse","exampleIds":["paths/~1v2~1EviNotice~1{Id}/get/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticeget"}],"panels":[]}]},"httpPath":"/v2/EviNotice/{Id}"},{"label":"Query multiple EviNotices","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticequery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticequery","metadata":{"seo":{"title":"Query multiple EviNotices","description":"Use State Closed to find notices that have reached the only terminal state. Outcome then identifies the final recorded result. A notice can close with Outcome Received when link access was recorded and no higher-priority outcome applies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeQuery","name":"Query multiple EviNotices","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query multiple EviNotices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use State Closed to find notices that have reached the only terminal state. Outcome then identifies the final recorded result. A notice can close with Outcome Received when link access was recorded and no higher-priority outcome applies.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeQueryRequest"}},"schemaId":"components/schemas/EviNoticeQueryRequest","pointer":"/paths/~1v2~1EviNotice~1Query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviNotice/Query","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviNoticeQueryRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v2/EviNotice/Query","href":"evinotice/evinoticequery","openApiOperationId":"eviNoticeQuery","summary":"Query multiple EviNotices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviNoticeQueryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeQueryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeQueryResponse","exampleIds":["paths/~1v2~1EviNotice~1Query/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeQueryResponse","exampleIds":["paths/~1v2~1EviNotice~1Query/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid Query field, owner email or limit."},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Owner filtering is not permitted for this user."}],"pointer":"/paths/~1v2~1EviNotice~1Query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeQueryResponse","exampleIds":["paths/~1v2~1EviNotice~1Query/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeQueryResponse","exampleIds":["paths/~1v2~1EviNotice~1Query/post/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticequery"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Query"},{"label":"Download all attachments of an EviNotice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeattachmentsdownload","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeattachmentsdownload","metadata":{"seo":{"title":"Download all attachments of an EviNotice","description":"Download all attachments of an EviNotice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeAttachmentsDownload","name":"Download all attachments of an EviNotice","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1{Id}~1Attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download all attachments of an EviNotice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","schemaId":"schema_4","description":"The UUID of the EviNotice.","required":true}],"pointer":"/paths/~1v2~1EviNotice~1{Id}~1Attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/{Id}/Attachments","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","204","401","404"],"pointer":"/v2/EviNotice/{Id}/Attachments","href":"evinotice/evinoticeattachmentsdownload","openApiOperationId":"eviNoticeAttachmentsDownload","summary":"Download all attachments of an EviNotice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ZIP file containing all attachments.","mediaType":"application/zip","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"204","description":"No attachments available for this EviNotice."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"EviNotice not found."}],"pointer":"/paths/~1v2~1EviNotice~1{Id}~1Attachments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}}},{"code":"204"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticeattachmentsdownload"}],"panels":[]}]},"httpPath":"/v2/EviNotice/{Id}/Attachments"},{"label":"Download all affidavits of an EviNotice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitsdownload","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitsdownload","metadata":{"seo":{"title":"Download all affidavits of an EviNotice","description":"Download all affidavits of an EviNotice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeAffidavitsDownload","name":"Download all affidavits of an EviNotice","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1{Id}~1Affidavits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download all affidavits of an EviNotice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","schemaId":"schema_4","description":"The UUID of the EviNotice.","required":true}],"pointer":"/paths/~1v2~1EviNotice~1{Id}~1Affidavits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/{Id}/Affidavits","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","204","401","403"],"pointer":"/v2/EviNotice/{Id}/Affidavits","href":"evinotice/evinoticeaffidavitsdownload","openApiOperationId":"eviNoticeAffidavitsDownload","summary":"Download all affidavits of an EviNotice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ZIP file containing all affidavits.","mediaType":"application/zip","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"204","description":"No affidavits have been generated yet for this EviNotice."},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Notice not found or not accessible to this account."}],"pointer":"/paths/~1v2~1EviNotice~1{Id}~1Affidavits/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}}},{"code":"204"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticeaffidavitsdownload"}],"panels":[]}]},"httpPath":"/v2/EviNotice/{Id}/Affidavits"},{"label":"Download one EviNotice affidavit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitdownload","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitdownload","metadata":{"seo":{"title":"Download one EviNotice affidavit","description":"Download one EviNotice affidavit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeAffidavitDownload","name":"Download one EviNotice affidavit","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Affidavits~1{Id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download one EviNotice affidavit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","schemaId":"schema_4","description":"The UUID of the affidavit.","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Affidavits~1{Id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/Affidavits/{Id}","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v2/EviNotice/Affidavits/{Id}","href":"evinotice/evinoticeaffidavitdownload","openApiOperationId":"eviNoticeAffidavitDownload","summary":"Download one EviNotice affidavit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"PDF file containing the requested affidavit.","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Affidavit belongs to a notice this account cannot access."},{"code":"404","description":"Affidavit not found."}],"pointer":"/paths/~1v2~1EviNotice~1Affidavits~1{Id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_6"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticeaffidavitdownload"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Affidavits/{Id}"},{"label":"Request an on-demand affidavit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitrequest","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitrequest","metadata":{"seo":{"title":"Request an on-demand affidavit","description":"Generates a custom affidavit for a previously submitted EviNotice. The original submit request must have included AffidavitKinds with the OnDemand value. The notice must still be eligible — not Draft, not Closed, and within the configured per-notice on-demand limit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeAffidavitRequest","name":"Request an on-demand affidavit","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Affidavits~1Request/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an on-demand affidavit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a custom affidavit for a previously submitted EviNotice. The original submit request must have included "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitKinds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnDemand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. The notice must still be eligible — not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and within the configured per-notice on-demand limit."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeAffidavitRequestBody"}},"schemaId":"components/schemas/EviNoticeAffidavitRequestBody","pointer":"/paths/~1v2~1EviNotice~1Affidavits~1Request/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviNotice/Affidavits/Request","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviNoticeAffidavitRequestBody"}},"responseCodes":["200","401","403","404","405"],"pointer":"/v2/EviNotice/Affidavits/Request","href":"evinotice/evinoticeaffidavitrequest","openApiOperationId":"eviNoticeAffidavitRequest","summary":"Request an on-demand affidavit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviNoticeAffidavitRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeAffidavitRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Affidavit request accepted. Generation is asynchronous; an AffidavitPublished callback fires when the affidavit is ready.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeAffidavitRequestResponse"}},"schemaId":"components/schemas/EviNoticeAffidavitRequestResponse"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The per-notice on-demand affidavit limit has been reached."},{"code":"404","description":"Notice not found among those submitted by this user."},{"code":"405","description":"OnDemand was not included in AffidavitKinds at submission, or the notice is in a state that does not support on-demand affidavit generation (Draft or Closed).\n"}],"pointer":"/paths/~1v2~1EviNotice~1Affidavits~1Request/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeAffidavitRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeAffidavitRequestResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticeaffidavitrequest"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Affidavits/Request"},{"label":"Create a notice batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchcreate","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchcreate","metadata":{"seo":{"title":"Create a notice batch","description":"Creates a new, empty notice batch. Only a Description is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the BatchId used by all other batch operations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchCreate","name":"Create a notice batch","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a notice batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new, empty notice batch. Only a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BatchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used by all other batch operations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1EviNotice~1Batches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviNotice/Batches","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","401","403","500"],"pointer":"/v2/EviNotice/Batches","href":"evinotice/evinoticebatchcreate","openApiOperationId":"eviNoticeBatchCreate","summary":"Create a notice batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Batch created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/responses/201/content/application~1json/example"]},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Batch sending is not available for this user or site."},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1v2~1EviNotice~1Batches/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviNotice~1Batches/post/responses/201/content/application~1json/example"]}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchcreate"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches"},{"label":"Query notice batches (HTTP QUERY method)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchesquery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchesquery","metadata":{"seo":{"title":"Query notice batches (HTTP QUERY method)","description":"Lists notice batches owned by the caller (or the caller's site), with cursor pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchesQuery","name":"Query notice batches (HTTP QUERY method)","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query notice batches (HTTP QUERY method)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists notice batches owned by the caller (or the caller's site), with cursor pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses the HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, not GET."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OpenAPI cannot express the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, so it is shown here as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the filter fields as query parameters. In practice, send an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the fields in a JSON body ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"States"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TextSearch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"States","in":"query","schemaId":"schema_7","description":"Filter by one or more batch states."},{"name":"Cursor","in":"query","schemaId":"schema_0","description":"Opaque pagination cursor returned by the previous response."},{"name":"Limit","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of batches to return (1–100)."},"children":[]}]}]}],"required":true},{"name":"SortBy","in":"query","schemaId":"schema_9"},{"name":"SortOrder","in":"query","schemaId":"schema_10"},{"name":"Direction","in":"query","schemaId":"schema_11"},{"name":"TextSearch","in":"query","schemaId":"schema_0","description":"Free-text search over batch descriptions."}],"pointer":"/paths/~1v2~1EviNotice~1Batches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/Batches","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"States","in":"query","schemaId":"schema_7"},{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","required":true,"schemaId":"schema_8"},{"name":"SortBy","in":"query","schemaId":"schema_9"},{"name":"SortOrder","in":"query","schemaId":"schema_10"},{"name":"Direction","in":"query","schemaId":"schema_11"},{"name":"TextSearch","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2/EviNotice/Batches","href":"evinotice/evinoticebatchesquery","openApiOperationId":"eviNoticeBatchesQuery","summary":"Query notice batches (HTTP QUERY method)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchesQueryResponse"}},"schemaId":"components/schemas/EviNoticeBatchesQueryResponse"},{"code":"400","description":"Malformed request (invalid state, sort, or direction value)."},{"code":"401","description":"Authentication failed"}],"pointer":"/paths/~1v2~1EviNotice~1Batches/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeBatchesQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchesQueryResponse"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchesquery"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches"},{"label":"Get a notice batch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchget","metadata":{"seo":{"title":"Get a notice batch","description":"Retrieves the full state of a batch, including its configured notice template and processing progress."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchGet","name":"Get a notice batch","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a notice batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the full state of a batch, including its configured notice template and processing progress."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","description":"The UUID of the batch, as returned at creation.","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}","href":"evinotice/evinoticebatchget","openApiOperationId":"eviNoticeBatchGet","summary":"Get a notice batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchGetResponse"}},"schemaId":"components/schemas/EviNoticeBatchGetResponse"},{"code":"400","description":"BatchId is missing or a default (empty) UUID."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeBatchGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchGetResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchget"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}"},{"label":"Update a notice batch","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchpatch","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchpatch","metadata":{"seo":{"title":"Update a notice batch","description":"Updates batch metadata and the notice template options. All fields are optional; only the fields supplied are changed. Setting State transitions the batch (for example, to start processing or schedule it). Setting ScheduledDate schedules the batch for later dispatch. Batch scheduling uses UTC. Specify ScheduledDate in UTC."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchPatch","name":"Update a notice batch","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a notice batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates batch metadata and the notice template options. All fields are optional; only the fields supplied are changed. Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"State"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transitions the batch (for example, to start processing or schedule it). Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ScheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schedules the batch for later dispatch. Batch scheduling uses UTC. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ScheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in UTC."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","description":"The UUID of the batch, as returned at creation.","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchPatchRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeBatchPatchRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/EviNotice/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchPatchRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}","href":"evinotice/evinoticebatchpatch","openApiOperationId":"eviNoticeBatchPatch","summary":"Update a notice batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviNoticeBatchPatchRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchPatchRequest","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch updated."},{"code":"400","description":"Invalid request."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchpatch"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}"},{"label":"Delete a notice batch","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchdelete","metadata":{"seo":{"title":"Delete a notice batch","description":"Removes a previously created batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchDelete","name":"Delete a notice batch","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a notice batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a previously created batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","description":"The UUID of the batch, as returned at creation.","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviNotice/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","400","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}","href":"evinotice/evinoticebatchdelete","openApiOperationId":"eviNoticeBatchDelete","summary":"Delete a notice batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Batch deleted."},{"code":"400","description":"Invalid request."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchdelete"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}"},{"label":"Set the batch body","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchbodyput","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchbodyput","metadata":{"seo":{"title":"Set the batch body","description":"Sets the HTML body of the notice for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use PATCH .../{BatchId} to set the Subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchBodyPut","name":"Set the batch body","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set the batch body","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the HTML body of the notice for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/EviNotice/Batches/{BatchId}/Body","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"text/html":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"]}},"responseCodes":["202","400","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Body","href":"evinotice/evinoticebatchbodyput","openApiOperationId":"eviNoticeBatchBodyPut","summary":"Set the batch body"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"],"mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body accepted and queued for update. Poll GET .../{BatchId} to check status."},"children":[]}]}]}]},{"code":"400","description":"The request has no valid body."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchbodyput"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Body"},{"label":"Add batch recipients (CSV)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientspost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientspost","metadata":{"seo":{"title":"Add batch recipients (CSV)","description":"Adds recipients to the batch by uploading a text/csv file. The CSV uses ; as the column separator. Mandatory columns: address, legalname. Optional columns: lookupkey, displayname, custodychallenge, custodychallengeresponse, deliverychallenge, deliverychallengeresponse, deliveryotpchannel, deliveryotpaddress. Custom per-recipient fields are added as extra columns prefixed with * (for example, *orderid)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchRecipientsPost","name":"Add batch recipients (CSV)","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add batch recipients (CSV)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds recipients to the batch by uploading a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file. The CSV uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the column separator. Mandatory columns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional columns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lookupkey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custodychallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custodychallengeresponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverychallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverychallengeresponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryotpchannel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryotpaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom per-recipient fields are added as extra columns prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*orderid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviNotice/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Recipients","href":"evinotice/evinoticebatchrecipientspost","openApiOperationId":"eviNoticeBatchRecipientsPost","summary":"Add batch recipients (CSV)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recipients accepted. No response body is returned."},{"code":"400","description":"Invalid CSV (duplicated columns, missing mandatory columns, invalid custom-column names, empty file or too many recipients), missing body, incorrect Content-Type or Content-Encoding, or a batch that can no longer be modified."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchrecipientspost"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Recipients"},{"label":"Query batch recipients (HTTP QUERY method)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsquery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsquery","metadata":{"seo":{"title":"Query batch recipients (HTTP QUERY method)","description":"Lists the recipients of a batch, with cursor pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchRecipientsQuery","name":"Query batch recipients (HTTP QUERY method)","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query batch recipients (HTTP QUERY method)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the recipients of a batch, with cursor pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses the HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, not GET."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OpenAPI cannot express the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, so it is shown here as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the filter fields as query parameters. In practice, send an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortDirection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in a JSON body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Cursor","in":"query","schemaId":"schema_0","description":"Opaque pagination cursor returned by the previous response."},{"name":"Limit","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of recipients to return (1–1000)."},"children":[]}]}]}]},{"name":"SortDirection","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","schemaId":"schema_12"},{"name":"SortDirection","in":"query","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Recipients","href":"evinotice/evinoticebatchrecipientsquery","openApiOperationId":"eviNoticeBatchRecipientsQuery","summary":"Query batch recipients (HTTP QUERY method)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchRecipientsQueryResponse"}},"schemaId":"components/schemas/EviNoticeBatchRecipientsQueryResponse"},{"code":"400","description":"Malformed request."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeBatchRecipientsQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchRecipientsQueryResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchrecipientsquery"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Recipients"},{"label":"Delete all batch recipients","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsdelete","metadata":{"seo":{"title":"Delete all batch recipients","description":"Removes all recipients from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchRecipientsDelete","name":"Delete all batch recipients","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all batch recipients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes all recipients from the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviNotice/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Recipients","href":"evinotice/evinoticebatchrecipientsdelete","openApiOperationId":"eviNoticeBatchRecipientsDelete","summary":"Delete all batch recipients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Recipients removed."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchrecipientsdelete"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Recipients"},{"label":"Add a batch attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentspost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentspost","metadata":{"seo":{"title":"Add a batch attachment","description":"Adds a single attachment to the batch by uploading it as multipart/form-data. The attachment is included in every notice generated from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchAttachmentsPost","name":"Add a batch attachment","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a batch attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a single attachment to the batch by uploading it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The attachment is included in every notice generated from the batch."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_14"}},"schemaId":"schema_14","pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviNotice/Batches/{BatchId}/Attachments","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_14"}},"responseCodes":["200","400","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Attachments","href":"evinotice/evinoticebatchattachmentspost","openApiOperationId":"eviNoticeBatchAttachmentsPost","summary":"Add a batch attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"schema_14","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_14"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment added.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchAttachmentPostResponse"}},"schemaId":"components/schemas/EviNoticeBatchAttachmentPostResponse"},{"code":"400","description":"No file was supplied, or more than one file was supplied."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviNoticeBatchAttachmentPostResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchAttachmentPostResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchattachmentspost"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Attachments"},{"label":"List batch attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsget","metadata":{"seo":{"title":"List batch attachments","description":"Returns metadata for all attachments configured on the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchAttachmentsGet","name":"List batch attachments","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List batch attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns metadata for all attachments configured on the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/Batches/{BatchId}/Attachments","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Attachments","href":"evinotice/evinoticebatchattachmentsget","openApiOperationId":"eviNoticeBatchAttachmentsGet","summary":"List batch attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment metadata returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}},"schemaId":"schema_15"},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchattachmentsget"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Attachments"},{"label":"Delete all batch attachments","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsdelete","metadata":{"seo":{"title":"Delete all batch attachments","description":"Removes all attachments from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchAttachmentsDelete","name":"Delete all batch attachments","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all batch attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes all attachments from the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviNotice/Batches/{BatchId}/Attachments","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Attachments","href":"evinotice/evinoticebatchattachmentsdelete","openApiOperationId":"eviNoticeBatchAttachmentsDelete","summary":"Delete all batch attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachments removed."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchattachmentsdelete"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Attachments"},{"label":"Download a batch attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentget","metadata":{"seo":{"title":"Download a batch attachment","description":"Downloads the binary content of a single batch attachment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchAttachmentGet","name":"Download a batch attachment","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a batch attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads the binary content of a single batch attachment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true},{"name":"AttachmentId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"},{"name":"AttachmentId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}","href":"evinotice/evinoticebatchattachmentget","openApiOperationId":"eviNoticeBatchAttachmentGet","summary":"Download a batch attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment content.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No attachment or batch with the given IDs was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_6"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchattachmentget"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}"},{"label":"Delete a batch attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentdelete","metadata":{"seo":{"title":"Delete a batch attachment","description":"Removes a single attachment from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviNoticeBatchAttachmentDelete","name":"Delete a batch attachment","isWebhook":false,"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a batch attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a single attachment from the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true},{"name":"AttachmentId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"},{"name":"AttachmentId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}","href":"evinotice/evinoticebatchattachmentdelete","openApiOperationId":"eviNoticeBatchAttachmentDelete","summary":"Delete a batch attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachment removed."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No attachment or batch with the given IDs was found."}],"pointer":"/paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evinotice/evinoticebatchattachmentdelete"}],"panels":[]}]},"httpPath":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}"}],"content":{"contentType":"group","meta":{"name":"EviNotice"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EviNotice","showPageActions":true},{"nodeType":"markdoc","content":"Certified hosted notices with hosted content, attachments, affidavits, and batch delivery via v2."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/EviNotice/Submit","summary":"Submit a new EviNotice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evinotice/evinoticesubmit","deprecated":false},{"title":"/v2/EviNotice/{Id}","summary":"Get a single EviNotice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticeget","deprecated":false},{"title":"/v2/EviNotice/Query","summary":"Query multiple EviNotices","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evinotice/evinoticequery","deprecated":false},{"title":"/v2/EviNotice/{Id}/Attachments","summary":"Download all attachments of an EviNotice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticeattachmentsdownload","deprecated":false},{"title":"/v2/EviNotice/{Id}/Affidavits","summary":"Download all affidavits of an EviNotice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticeaffidavitsdownload","deprecated":false},{"title":"/v2/EviNotice/Affidavits/{Id}","summary":"Download one EviNotice affidavit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticeaffidavitdownload","deprecated":false},{"title":"/v2/EviNotice/Affidavits/Request","summary":"Request an on-demand affidavit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evinotice/evinoticeaffidavitrequest","deprecated":false},{"title":"/v2/EviNotice/Batches","summary":"Create a notice batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evinotice/evinoticebatchcreate","deprecated":false},{"title":"/v2/EviNotice/Batches","summary":"Query notice batches (HTTP QUERY method)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticebatchesquery","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}","summary":"Get a notice batch","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticebatchget","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}","summary":"Update a notice batch","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/evinotice/evinoticebatchpatch","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}","summary":"Delete a notice batch","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evinotice/evinoticebatchdelete","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Body","summary":"Set the batch body","prefix":{"name":"put","color":"put"},"badges":[],"link":"/evinotice/evinoticebatchbodyput","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Recipients","summary":"Add batch recipients (CSV)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evinotice/evinoticebatchrecipientspost","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Recipients","summary":"Query batch recipients (HTTP QUERY method)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticebatchrecipientsquery","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Recipients","summary":"Delete all batch recipients","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evinotice/evinoticebatchrecipientsdelete","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Attachments","summary":"Add a batch attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evinotice/evinoticebatchattachmentspost","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Attachments","summary":"List batch attachments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticebatchattachmentsget","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Attachments","summary":"Delete all batch attachments","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evinotice/evinoticebatchattachmentsdelete","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}","summary":"Download a batch attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evinotice/evinoticebatchattachmentget","deprecated":false},{"title":"/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}","summary":"Delete a batch attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evinotice/evinoticebatchattachmentdelete","deprecated":false}]}]}]}]}},{"type":"group","label":"EviMail","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail","items":[{"label":"Submit a certified email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailsubmit","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailsubmit","metadata":{"seo":{"title":"Submit a certified email","description":"Submit a certified email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailSubmit","name":"Submit a certified email","isWebhook":false,"pointer":"/paths/~1v1~1EviMail~1Submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a certified email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Evi-IdempotencyToken","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional idempotency token (UUID recommended) to prevent duplicate submissions on retry. A replay of a cached "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submission returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Responses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"408"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not cached for replay."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1EviMail~1Submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviMailSubmitRequest","exampleIds":["paths/~1v1~1EviMail~1Submit/post/requestBody/content/application~1json/examples/emailOk"]}},"schemaId":"components/schemas/EviMailSubmitRequest","exampleIds":["paths/~1v1~1EviMail~1Submit/post/requestBody/content/application~1json/examples/emailOk"],"pointer":"/paths/~1v1~1EviMail~1Submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/EviMail/Submit","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Evi-IdempotencyToken","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviMailSubmitRequest","exampleIds":["paths/~1v1~1EviMail~1Submit/post/requestBody/content/application~1json/examples/emailOk"]}},"responseCodes":["200","202","400","401","403","409"],"pointer":"/v1/EviMail/Submit","href":"evimail/evimailsubmit","openApiOperationId":"eviMailSubmit","summary":"Submit a certified email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviMailSubmitRequest","exampleIds":["paths/~1v1~1EviMail~1Submit/post/requestBody/content/application~1json/examples/emailOk"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviMailSubmitRequest","exampleIds":["paths/~1v1~1EviMail~1Submit/post/requestBody/content/application~1json/examples/emailOk"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}},"schemaId":"components/schemas/EviMailSubmitResponse","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["New"]}}},"headerSchemaId":"schema_1"},{"code":"202","description":"Idempotent replay. The same X-Evi-IdempotencyToken was used for a cached 200 OK submission. The original response body is returned; the message is not resubmitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}},"schemaId":"components/schemas/EviMailSubmitResponse","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Replay"]}}},"headerSchemaId":"schema_2"},{"code":"400","description":"Invalid request or business rule failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailError"}},"schemaId":"components/schemas/EviMailError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Access denied. The authenticated account lacks the required API permission, has specified a From address that is not permitted for this account, or has attempted to set a restricted request header.\n"},{"code":"409","description":"Another Submit with the same X-Evi-IdempotencyToken is currently in flight.","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Conflict"]}}},"headerSchemaId":"schema_3"}],"pointer":"/paths/~1v1~1EviMail~1Submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}}},{"code":"202","schemaId":"components/schemas/EviMailSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}}},{"code":"400","schemaId":"components/schemas/EviMailError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailError"}}},{"code":"401"},{"code":"403"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailsubmit"}],"panels":[]}]},"httpPath":"/v1/EviMail/Submit"},{"label":"Query certified emails (GET)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailqueryget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailqueryget","metadata":{"seo":{"title":"Query certified emails (GET)","description":"Query certified emails (GET)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailQueryGet","name":"Query certified emails (GET)","isWebhook":false,"pointer":"/paths/~1v1~1EviMail~1Query/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query certified emails (GET)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0"},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0"},{"name":"WithLinkedId","in":"query","schemaId":"schema_4","description":"Filters by linked ID, such as a batch ID. Cannot be combined with affidavit or attachment inclusion flags."},{"name":"OnState","in":"query","schemaId":"schema_16"},{"name":"WithOutcome","in":"query","schemaId":"schema_17"},{"name":"OrderResultsBy","in":"query","schemaId":"schema_18"},{"name":"Limit","in":"query","schemaId":"schema_19","description":"Default and maximum of 100 for an ordinary query, 25 with affidavit or attachment metadata, or 1 with binary content."},{"name":"Offset","in":"query","schemaId":"schema_20"},{"name":"IncludeAffidavits","in":"query","schemaId":"schema_5"},{"name":"IncludeAffidavitBlobs","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. When true with IncludeAffidavits, includes Base64 affidavit PDFs in affidavits[].bytes and limits the query to one email. Set false for metadata-only results and use /AffidavitsDownload for new integrations."},"children":[]}]}]}],"deprecated":true},{"name":"IncludeAttachments","in":"query","schemaId":"schema_5"},{"name":"IncludeAttachmentBlobs","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With IncludeAttachments, includes Base64 file contents in attachments[].data and limits the query to one email. Set false explicitly for metadata-only results and use /AttachmentDownload for new integrations."},"children":[]}]}]}],"deprecated":true}],"pointer":"/paths/~1v1~1EviMail~1Query/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/EviMail/Query","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0"},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0"},{"name":"WithLinkedId","in":"query","schemaId":"schema_4"},{"name":"OnState","in":"query","schemaId":"schema_16"},{"name":"WithOutcome","in":"query","schemaId":"schema_17"},{"name":"OrderResultsBy","in":"query","schemaId":"schema_18"},{"name":"Limit","in":"query","schemaId":"schema_19"},{"name":"Offset","in":"query","schemaId":"schema_20"},{"name":"IncludeAffidavits","in":"query","schemaId":"schema_5"},{"name":"IncludeAffidavitBlobs","in":"query","schemaId":"schema_5"},{"name":"IncludeAttachments","in":"query","schemaId":"schema_5"},{"name":"IncludeAttachmentBlobs","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v1/EviMail/Query","href":"evimail/evimailqueryget","openApiOperationId":"eviMailQueryGet","summary":"Query certified emails (GET)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailQueryResponse"}},"schemaId":"components/schemas/EviMailQueryResponse"},{"code":"401","description":"Authentication failed"}],"pointer":"/paths/~1v1~1EviMail~1Query/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailQueryResponse"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailqueryget"}],"panels":[]}]},"httpPath":"/v1/EviMail/Query"},{"label":"Request an on-demand affidavit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailaffidavitrequest","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailaffidavitrequest","metadata":{"seo":{"title":"Request an on-demand affidavit","description":"Generates a custom affidavit for a previously submitted EviMail. The original Submit request must have included AffidavitKinds containing OnDemand, and the communication must still be eligible for on-demand affidavits. The submitting owner can request one while the transaction is active, the affidavit profile permits on-demand generation, and the configured limit has not been reached."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailAffidavitRequest","name":"Request an on-demand affidavit","isWebhook":false,"pointer":"/paths/~1v1~1EviMail~1AffidavitRequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an on-demand affidavit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a custom affidavit for a previously submitted EviMail. The original Submit request must have included "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitKinds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnDemand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the communication must still be eligible for on-demand affidavits. The submitting owner can request one while the transaction is active, the affidavit profile permits on-demand generation, and the configured limit has not been reached."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitRequest","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviMailAffidavitRequest","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/EviMail/AffidavitRequest","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitRequest","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401"],"pointer":"/v1/EviMail/AffidavitRequest","href":"evimail/evimailaffidavitrequest","openApiOperationId":"eviMailAffidavitRequest","summary":"Request an on-demand affidavit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviMailAffidavitRequest","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitRequest","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Affidavit request accepted. Generation is asynchronous.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitResponse","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviMailAffidavitResponse","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request or business rule failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}},"schemaId":"components/schemas/EviMailAffidavitError"},{"code":"401","description":"Authentication failed"}],"pointer":"/paths/~1v1~1EviMail~1AffidavitRequest/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailAffidavitResponse","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitResponse","exampleIds":["paths/~1v1~1EviMail~1AffidavitRequest/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/EviMailAffidavitError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailaffidavitrequest"}],"panels":[]}]},"httpPath":"/v1/EviMail/AffidavitRequest"},{"label":"Create an email batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchcreate","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchcreate","metadata":{"seo":{"title":"Create an email batch","description":"Creates a new, empty email batch. Only a Description is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the BatchId used by all other batch operations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchCreate","name":"Create an email batch","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an email batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new, empty email batch. Only a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BatchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used by all other batch operations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviMail~1Batches/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviMail~1Batches/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1EviMail~1Batches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviMail/Batches","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviMail~1Batches/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","202","401","403","500"],"pointer":"/v2/EviMail/Batches","href":"evimail/evimailbatchcreate","openApiOperationId":"eviMailBatchCreate","summary":"Create an email batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviMail~1Batches/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviMail~1Batches/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Batch created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviMail~1Batches/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviMail~1Batches/post/responses/201/content/application~1json/example"]},{"code":"202","description":"Idempotent replay. Returns the original creation response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse"}},"schemaId":"components/schemas/EviNoticeBatchCreateResponse"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The user lacks permission to send batches, or the site does not use by-submission billing."},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1v2~1EviMail~1Batches/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviMail~1Batches/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviMail~1Batches/post/responses/201/content/application~1json/example"]}}},{"code":"202","schemaId":"components/schemas/EviNoticeBatchCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse"}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchcreate"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches"},{"label":"Query email batches (HTTP QUERY method)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchesquery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchesquery","metadata":{"seo":{"title":"Query email batches (HTTP QUERY method)","description":"Lists batches submitted by the authenticated user in the current site, with cursor pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchesQuery","name":"Query email batches (HTTP QUERY method)","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query email batches (HTTP QUERY method)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists batches submitted by the authenticated user in the current site, with cursor pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses the HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, not GET."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OpenAPI cannot express the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, so it is shown here as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the filter fields as query parameters. In practice, send an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the fields in a JSON body ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"States"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TextSearch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"States","in":"query","schemaId":"schema_7"},{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","schemaId":"schema_8","required":true},{"name":"SortBy","in":"query","schemaId":"schema_9"},{"name":"SortOrder","in":"query","schemaId":"schema_10"},{"name":"Direction","in":"query","schemaId":"schema_11"},{"name":"TextSearch","in":"query","schemaId":"schema_0"}],"pointer":"/paths/~1v2~1EviMail~1Batches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviMail/Batches","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[],"query":[{"name":"States","in":"query","schemaId":"schema_7"},{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","required":true,"schemaId":"schema_8"},{"name":"SortBy","in":"query","schemaId":"schema_9"},{"name":"SortOrder","in":"query","schemaId":"schema_10"},{"name":"Direction","in":"query","schemaId":"schema_11"},{"name":"TextSearch","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2/EviMail/Batches","href":"evimail/evimailbatchesquery","openApiOperationId":"eviMailBatchesQuery","summary":"Query email batches (HTTP QUERY method)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchesQueryResponse"}},"schemaId":"components/schemas/EviMailBatchesQueryResponse"},{"code":"400","description":"Malformed request."},{"code":"401","description":"Authentication failed"}],"pointer":"/paths/~1v2~1EviMail~1Batches/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailBatchesQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchesQueryResponse"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchesquery"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches"},{"label":"Get an email batch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchget","metadata":{"seo":{"title":"Get an email batch","description":"Retrieves the full state of a batch, including its configured email template and processing progress."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchGet","name":"Get an email batch","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an email batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the full state of a batch, including its configured email template and processing progress."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviMail/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}","href":"evimail/evimailbatchget","openApiOperationId":"eviMailBatchGet","summary":"Get an email batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchGetResponse"}},"schemaId":"components/schemas/EviMailBatchGetResponse"},{"code":"400","description":"BatchId is missing or a default (empty) UUID."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailBatchGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchGetResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchget"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}"},{"label":"Update an email batch","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchpatch","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchpatch","metadata":{"seo":{"title":"Update an email batch","description":"Updates batch metadata and email template options. To submit a Draft or Invalid batch, send State Submitted and a future UTC ScheduledDate in the same request. To return a Submitted or Scheduled batch to editable state, send State Draft. Omitted or empty AcceptReasons and RejectReasons clear the stored lists. Before submission, the batch needs a body and at least one recipient, plus Subject, a permitted From, TimeToLive greater than 0, OnlineRetentionPeriod from 1 to 20 years, CommitmentOptions, and CertificationLevel. New batches have no defaults for these fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchPatch","name":"Update an email batch","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an email batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates batch metadata and email template options. To submit a Draft or Invalid batch, send State Submitted and a future UTC ScheduledDate in the same request. To return a Submitted or Scheduled batch to editable state, send State Draft. Omitted or empty AcceptReasons and RejectReasons clear the stored lists. Before submission, the batch needs a body and at least one recipient, plus Subject, a permitted From, TimeToLive greater than 0, OnlineRetentionPeriod from 1 to 20 years, CommitmentOptions, and CertificationLevel. New batches have no defaults for these fields.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviMailBatchPatchRequest","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviMailBatchPatchRequest","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/EviMail/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviMailBatchPatchRequest","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/v2/EviMail/Batches/{BatchId}","href":"evimail/evimailbatchpatch","openApiOperationId":"eviMailBatchPatch","summary":"Update an email batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"components/schemas/EviMailBatchPatchRequest","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviMailBatchPatchRequest","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch updated."},{"code":"400","description":"Invalid update, insufficient credit, or incompatible voucher tier."},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The user lacks permission to send batches, or the site does not use by-submission billing."},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchpatch"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}"},{"label":"Delete an email batch","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchdelete","metadata":{"seo":{"title":"Delete an email batch","description":"Removes a previously created batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchDelete","name":"Delete an email batch","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an email batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a previously created batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviMail/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}","href":"evimail/evimailbatchdelete","openApiOperationId":"eviMailBatchDelete","summary":"Delete an email batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Batch deleted."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchdelete"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}"},{"label":"Set the batch body","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchbodyput","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchbodyput","metadata":{"seo":{"title":"Set the batch body","description":"Sets the HTML body of the email for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use PATCH .../{BatchId} to set the Subject."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchBodyPut","name":"Set the batch body","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set the batch body","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the HTML body of the email for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/EviMail/Batches/{BatchId}/Body","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"text/html":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"]}},"responseCodes":["202","400","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Body","href":"evimail/evimailbatchbodyput","openApiOperationId":"eviMailBatchBodyPut","summary":"Set the batch body"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"],"mediaTypes":["text/html"],"mediaTypeSchemas":{"text/html":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Batch body replaced. The response has no body."},{"code":"400","description":"The request has no valid body."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchbodyput"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Body"},{"label":"Add batch recipients (CSV)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientspost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientspost","metadata":{"seo":{"title":"Add batch recipients (CSV)","description":"Replaces the recipient list of an editable batch with a raw CSV upload. Send exactly Content-Type: text/csv without media-type parameters. Send the CSV in UTF-8. The CSV supports up to 100,000 recipients and uses ; as the column separator. Mandatory columns: emailaddress, legalname. Optional columns: lookupkey, displayname, evidenceaccesscontrolchallenge, evidenceaccesscontrolchallengeresponse. Custom per-recipient fields are added as extra columns prefixed with * (for example, *orderid)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchRecipientsPost","name":"Add batch recipients (CSV)","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add batch recipients (CSV)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the recipient list of an editable batch with a raw CSV upload. Send exactly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without media-type parameters. Send the CSV in UTF-8. The CSV supports up to 100,000 recipients and uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the column separator. Mandatory columns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional columns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lookupkey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"evidenceaccesscontrolchallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"evidenceaccesscontrolchallengeresponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom per-recipient fields are added as extra columns prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*orderid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviMail/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"responseCodes":["200","400","401","404","415"],"pointer":"/v2/EviMail/Batches/{BatchId}/Recipients","href":"evimail/evimailbatchrecipientspost","openApiOperationId":"eviMailBatchRecipientsPost","summary":"Add batch recipients (CSV)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"CSV stored. The batch worker validates recipient rows after submission and can mark the batch Invalid. No response body is returned."},{"code":"400","description":"Batch is not editable, CSV validation failed, or the content type or encoding is invalid."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."},{"code":"415","description":"The server rejected the request media type. Some deployments return HTTP 400 for this case."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchrecipientspost"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Recipients"},{"label":"Query batch recipients (HTTP QUERY method)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientsquery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientsquery","metadata":{"seo":{"title":"Query batch recipients (HTTP QUERY method)","description":"Lists the recipients of a batch, with cursor pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchRecipientsQuery","name":"Query batch recipients (HTTP QUERY method)","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query batch recipients (HTTP QUERY method)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the recipients of a batch, with cursor pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses the HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, not GET."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OpenAPI cannot express the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, so it is shown here as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the filter fields as query parameters. In practice, send an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortDirection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in a JSON body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","schemaId":"schema_12"},{"name":"SortDirection","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviMail/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","schemaId":"schema_12"},{"name":"SortDirection","in":"query","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Recipients","href":"evimail/evimailbatchrecipientsquery","openApiOperationId":"eviMailBatchRecipientsQuery","summary":"Query batch recipients (HTTP QUERY method)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchRecipientsQueryResponse"}},"schemaId":"components/schemas/EviMailBatchRecipientsQueryResponse"},{"code":"400","description":"Malformed request."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailBatchRecipientsQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchRecipientsQueryResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchrecipientsquery"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Recipients"},{"label":"Delete all batch recipients","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientsdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientsdelete","metadata":{"seo":{"title":"Delete all batch recipients","description":"Removes all recipients from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchRecipientsDelete","name":"Delete all batch recipients","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all batch recipients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes all recipients from the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviMail/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Recipients","href":"evimail/evimailbatchrecipientsdelete","openApiOperationId":"eviMailBatchRecipientsDelete","summary":"Delete all batch recipients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Recipients removed."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchrecipientsdelete"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Recipients"},{"label":"Add a batch attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentspost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentspost","metadata":{"seo":{"title":"Add a batch attachment","description":"Adds a single attachment to the batch by uploading it as multipart/form-data. The attachment is included in emails generated from the batch. Upload exactly one nonempty file and set its filename and media type on the Content part. The single-message limits apply when individual items are submitted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchAttachmentsPost","name":"Add a batch attachment","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a batch attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a single attachment to the batch by uploading it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The attachment is included in emails generated from the batch. Upload exactly one nonempty file and set its filename and media type on the Content part. The single-message limits apply when individual items are submitted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_21"}},"schemaId":"schema_21","pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviMail/Batches/{BatchId}/Attachments","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_21"}},"responseCodes":["200","400","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Attachments","href":"evimail/evimailbatchattachmentspost","openApiOperationId":"eviMailBatchAttachmentsPost","summary":"Add a batch attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"schema_21","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_21"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment added.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchAttachmentPostResponse"}},"schemaId":"components/schemas/EviMailBatchAttachmentPostResponse"},{"code":"400","description":"The file is missing or empty, multiple files were supplied, metadata is invalid, or the batch is not editable."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailBatchAttachmentPostResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailBatchAttachmentPostResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchattachmentspost"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Attachments"},{"label":"List batch attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentsget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentsget","metadata":{"seo":{"title":"List batch attachments","description":"Returns metadata for all attachments configured on the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchAttachmentsGet","name":"List batch attachments","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List batch attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns metadata for all attachments configured on the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviMail/Batches/{BatchId}/Attachments","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Attachments","href":"evimail/evimailbatchattachmentsget","openApiOperationId":"eviMailBatchAttachmentsGet","summary":"List batch attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment metadata returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchattachmentsget"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Attachments"},{"label":"Delete all batch attachments","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentsdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentsdelete","metadata":{"seo":{"title":"Delete all batch attachments","description":"Removes all attachments from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchAttachmentsDelete","name":"Delete all batch attachments","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all batch attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes all attachments from the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviMail/Batches/{BatchId}/Attachments","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Attachments","href":"evimail/evimailbatchattachmentsdelete","openApiOperationId":"eviMailBatchAttachmentsDelete","summary":"Delete all batch attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachments removed."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchattachmentsdelete"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Attachments"},{"label":"Download a batch attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentget","metadata":{"seo":{"title":"Download a batch attachment","description":"Downloads the binary content of a single batch attachment. The response uses the stored attachment media type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchAttachmentGet","name":"Download a batch attachment","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a batch attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downloads the binary content of a single batch attachment. The response uses the stored attachment media type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true},{"name":"AttachmentId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"},{"name":"AttachmentId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}","href":"evimail/evimailbatchattachmentget","openApiOperationId":"eviMailBatchAttachmentGet","summary":"Download a batch attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment content.","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No attachment or batch with the given IDs was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_6"}}},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchattachmentget"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}"},{"label":"Delete a batch attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentdelete","metadata":{"seo":{"title":"Delete a batch attachment","description":"Removes a single attachment from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviMailBatchAttachmentDelete","name":"Delete a batch attachment","isWebhook":false,"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a batch attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a single attachment from the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true},{"name":"AttachmentId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"},{"name":"AttachmentId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}","href":"evimail/evimailbatchattachmentdelete","openApiOperationId":"eviMailBatchAttachmentDelete","summary":"Delete a batch attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachment removed."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No attachment or batch with the given IDs was found."}],"pointer":"/paths/~1v2~1EviMail~1Batches~1{BatchId}~1Attachments~1{AttachmentId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evimail/evimailbatchattachmentdelete"}],"panels":[]}]},"httpPath":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}"}],"content":{"contentType":"group","meta":{"name":"EviMail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EviMail","showPageActions":true},{"nodeType":"markdoc","content":"Certified email submission, status tracking, and on-demand affidavits via v1, plus batch delivery, recipients, and attachments via v2."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/EviMail/Submit","summary":"Submit a certified email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evimail/evimailsubmit","deprecated":false},{"title":"/v1/EviMail/Query","summary":"Query certified emails (GET)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evimail/evimailqueryget","deprecated":false},{"title":"/v1/EviMail/AffidavitRequest","summary":"Request an on-demand affidavit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evimail/evimailaffidavitrequest","deprecated":false},{"title":"/v2/EviMail/Batches","summary":"Create an email batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evimail/evimailbatchcreate","deprecated":false},{"title":"/v2/EviMail/Batches","summary":"Query email batches (HTTP QUERY method)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evimail/evimailbatchesquery","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}","summary":"Get an email batch","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evimail/evimailbatchget","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}","summary":"Update an email batch","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/evimail/evimailbatchpatch","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}","summary":"Delete an email batch","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evimail/evimailbatchdelete","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Body","summary":"Set the batch body","prefix":{"name":"put","color":"put"},"badges":[],"link":"/evimail/evimailbatchbodyput","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Recipients","summary":"Add batch recipients (CSV)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evimail/evimailbatchrecipientspost","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Recipients","summary":"Query batch recipients (HTTP QUERY method)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evimail/evimailbatchrecipientsquery","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Recipients","summary":"Delete all batch recipients","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evimail/evimailbatchrecipientsdelete","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Attachments","summary":"Add a batch attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evimail/evimailbatchattachmentspost","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Attachments","summary":"List batch attachments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evimail/evimailbatchattachmentsget","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Attachments","summary":"Delete all batch attachments","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evimail/evimailbatchattachmentsdelete","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}","summary":"Download a batch attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evimail/evimailbatchattachmentget","deprecated":false},{"title":"/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}","summary":"Delete a batch attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evimail/evimailbatchattachmentdelete","deprecated":false}]}]}]}]}},{"type":"group","label":"EviSMS","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms","items":[{"label":"Submit a certified SMS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismssubmit","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismssubmit","metadata":{"seo":{"title":"Submit a certified SMS","description":"Submit a certified SMS"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsSubmit","name":"Submit a certified SMS","isWebhook":false,"pointer":"/paths/~1v1~1EviSms~1Submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a certified SMS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Evi-IdempotencyToken","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional idempotency token (UUID recommended) to prevent duplicate submissions on retry. A replay of a cached "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submission returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Responses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"408"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not cached for replay."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1EviSms~1Submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviSmsSubmitRequest","exampleIds":["paths/~1v1~1EviSms~1Submit/post/requestBody/content/application~1json/examples/smsOk"]}},"schemaId":"components/schemas/EviSmsSubmitRequest","exampleIds":["paths/~1v1~1EviSms~1Submit/post/requestBody/content/application~1json/examples/smsOk"],"pointer":"/paths/~1v1~1EviSms~1Submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/EviSms/Submit","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Evi-IdempotencyToken","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviSmsSubmitRequest","exampleIds":["paths/~1v1~1EviSms~1Submit/post/requestBody/content/application~1json/examples/smsOk"]}},"responseCodes":["200","202","400","401","403","409"],"pointer":"/v1/EviSms/Submit","href":"evisms/evismssubmit","openApiOperationId":"eviSmsSubmit","summary":"Submit a certified SMS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviSmsSubmitRequest","exampleIds":["paths/~1v1~1EviSms~1Submit/post/requestBody/content/application~1json/examples/smsOk"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviSmsSubmitRequest","exampleIds":["paths/~1v1~1EviSms~1Submit/post/requestBody/content/application~1json/examples/smsOk"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SMS accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}},"schemaId":"components/schemas/EviMailSubmitResponse","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["New"]}}},"headerSchemaId":"schema_1"},{"code":"202","description":"Idempotent replay. The same X-Evi-IdempotencyToken was used for a cached 200 OK submission. The original response body is returned; the message is not resubmitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}},"schemaId":"components/schemas/EviMailSubmitResponse","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Replay"]}}},"headerSchemaId":"schema_2"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}},"schemaId":"components/schemas/EviMailAffidavitError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The authenticated account lacks the required API permission for EviSMS."},{"code":"409","description":"Another Submit with the same X-Evi-IdempotencyToken is currently in flight.","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Conflict"]}}},"headerSchemaId":"schema_3"}],"pointer":"/paths/~1v1~1EviSms~1Submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviMailSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}}},{"code":"202","schemaId":"components/schemas/EviMailSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailSubmitResponse"}}},{"code":"400","schemaId":"components/schemas/EviMailAffidavitError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}}},{"code":"401"},{"code":"403"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismssubmit"}],"panels":[]}]},"httpPath":"/v1/EviSms/Submit"},{"label":"Query certified SMS messages (GET)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsqueryget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsqueryget","metadata":{"seo":{"title":"Query certified SMS messages (GET)","description":"Query certified SMS messages (GET)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsQueryGet","name":"Query certified SMS messages (GET)","isWebhook":false,"pointer":"/paths/~1v1~1EviSms~1Query/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query certified SMS messages (GET)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0"},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0"},{"name":"WithLinkedId","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by linked ID. Leave affidavit and attachment data disabled. The legacy implementation uses deployment settings for omitted blob flags, with both defaults declared enabled. On legacy deployments, explicitly send IncludeAffidavitBlobs=false and IncludeAttachmentBlobs=false. The attachment flag applies only to legacy Query."},"children":[]}]}]}]},{"name":"OnState","in":"query","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters results by the current EviSMS state. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not part of the current public EviSMS lifecycle."},"children":[]}]}]}]},{"name":"WithOutcome","in":"query","schemaId":"schema_17"},{"name":"OrderResultsBy","in":"query","schemaId":"schema_18"},{"name":"Limit","in":"query","schemaId":"schema_8","description":"Default and maximum are 100 for messages alone, 25 with affidavit metadata, and 1 with affidavit blobs."},{"name":"Offset","in":"query","schemaId":"schema_20"},{"name":"IncludeAffidavits","in":"query","schemaId":"schema_5","description":"Include affidavit entries. Set IncludeAffidavitBlobs to false for metadata-only results."},{"name":"IncludeAffidavitBlobs","in":"query","schemaId":"schema_5","description":"When true with IncludeAffidavits, returns Base64 PDFs and limits the query to one message. ASP.NET defaults to false. Legacy uses a deployment setting whose declared default is true. Set false explicitly for metadata-only results and use /AffidavitsDownload for PDFs.","deprecated":true}],"pointer":"/paths/~1v1~1EviSms~1Query/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/EviSms/Query","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0"},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0"},{"name":"WithLinkedId","in":"query","schemaId":"schema_4"},{"name":"OnState","in":"query","schemaId":"schema_23"},{"name":"WithOutcome","in":"query","schemaId":"schema_17"},{"name":"OrderResultsBy","in":"query","schemaId":"schema_18"},{"name":"Limit","in":"query","schemaId":"schema_8"},{"name":"Offset","in":"query","schemaId":"schema_20"},{"name":"IncludeAffidavits","in":"query","schemaId":"schema_5"},{"name":"IncludeAffidavitBlobs","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v1/EviSms/Query","href":"evisms/evismsqueryget","openApiOperationId":"eviSmsQueryGet","summary":"Query certified SMS messages (GET)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsQueryResponse"}},"schemaId":"components/schemas/EviSmsQueryResponse"},{"code":"401","description":"Authentication failed"}],"pointer":"/paths/~1v1~1EviSms~1Query/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviSmsQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsQueryResponse"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsqueryget"}],"panels":[]}]},"httpPath":"/v1/EviSms/Query"},{"label":"Create an SMS batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchcreate","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchcreate","metadata":{"seo":{"title":"Create an SMS batch","description":"Creates a new, empty SMS batch. Only a Description is required at creation; the message text, recipients, and options are set with the subsequent batch endpoints. Returns the BatchId used by all other batch operations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchCreate","name":"Create an SMS batch","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an SMS batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new, empty SMS batch. Only a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required at creation; the message text, recipients, and options are set with the subsequent batch endpoints. Returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BatchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used by all other batch operations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviSms~1Batches/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviSms~1Batches/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1EviSms~1Batches/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviSms/Batches","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviSms~1Batches/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","202","401","403","500"],"pointer":"/v2/EviSms/Batches","href":"evisms/evismsbatchcreate","openApiOperationId":"eviSmsBatchCreate","summary":"Create an SMS batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviSms~1Batches/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateRequest","exampleIds":["paths/~1v2~1EviSms~1Batches/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Batch created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviSms~1Batches/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviSms~1Batches/post/responses/201/content/application~1json/example"]},{"code":"202","description":"On ASP.NET, an idempotent replay returns the previously stored batch result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse"}},"schemaId":"components/schemas/EviNoticeBatchCreateResponse"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The site does not use by-submission billing or the account lacks the batch sender role."},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1v2~1EviSms~1Batches/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviSms~1Batches/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse","exampleIds":["paths/~1v2~1EviSms~1Batches/post/responses/201/content/application~1json/example"]}}},{"code":"202","schemaId":"components/schemas/EviNoticeBatchCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviNoticeBatchCreateResponse"}}},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchcreate"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches"},{"label":"Query SMS batches (HTTP QUERY method)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchesquery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchesquery","metadata":{"seo":{"title":"Query SMS batches (HTTP QUERY method)","description":"Lists SMS batches owned by the caller (or the caller's site), with cursor pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchesQuery","name":"Query SMS batches (HTTP QUERY method)","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query SMS batches (HTTP QUERY method)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists SMS batches owned by the caller (or the caller's site), with cursor pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses the HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, not GET."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OpenAPI cannot express the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, so it is shown here as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the filter fields as query parameters. In practice, send an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the fields in a JSON body ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"States"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TextSearch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"States","in":"query","schemaId":"schema_7"},{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","schemaId":"schema_8","required":true},{"name":"SortBy","in":"query","schemaId":"schema_9"},{"name":"SortOrder","in":"query","schemaId":"schema_10"},{"name":"Direction","in":"query","schemaId":"schema_11"},{"name":"TextSearch","in":"query","schemaId":"schema_0"}],"pointer":"/paths/~1v2~1EviSms~1Batches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviSms/Batches","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[],"query":[{"name":"States","in":"query","schemaId":"schema_7"},{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","required":true,"schemaId":"schema_8"},{"name":"SortBy","in":"query","schemaId":"schema_9"},{"name":"SortOrder","in":"query","schemaId":"schema_10"},{"name":"Direction","in":"query","schemaId":"schema_11"},{"name":"TextSearch","in":"query","schemaId":"schema_0"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2/EviSms/Batches","href":"evisms/evismsbatchesquery","openApiOperationId":"eviSmsBatchesQuery","summary":"Query SMS batches (HTTP QUERY method)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsBatchesQueryResponse"}},"schemaId":"components/schemas/EviSmsBatchesQueryResponse"},{"code":"400","description":"Malformed request."},{"code":"401","description":"Authentication failed"}],"pointer":"/paths/~1v2~1EviSms~1Batches/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviSmsBatchesQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsBatchesQueryResponse"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchesquery"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches"},{"label":"Get an SMS batch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchget","metadata":{"seo":{"title":"Get an SMS batch","description":"Retrieves the full state of a batch, including its configured message template and processing progress."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchGet","name":"Get an SMS batch","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an SMS batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the full state of a batch, including its configured message template and processing progress."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviSms/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/EviSms/Batches/{BatchId}","href":"evisms/evismsbatchget","openApiOperationId":"eviSmsBatchGet","summary":"Get an SMS batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsBatchGetResponse"}},"schemaId":"components/schemas/EviSmsBatchGetResponse"},{"code":"400","description":"BatchId is missing or a default (empty) UUID."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviSmsBatchGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsBatchGetResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchget"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches/{BatchId}"},{"label":"Update an SMS batch","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchpatch","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchpatch","metadata":{"seo":{"title":"Update an SMS batch","description":"Updates supplied batch metadata and message template options, including the SMS Text. Blank values for text fields are ignored. To submit a Draft or Invalid batch, set State to Submitted and send a future ScheduledDate in UTC. The stored batch must have text, recipients, a positive TTL, 1–20 years of online retention, and a valid certification level. Batches created through the API have no defaults for TimeToLive, OnlineRetentionPeriod, or CertificationLevel. Set them before submitting or in the same PATCH request. A Submitted or Scheduled batch can be returned to Draft before processing starts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchPatch","name":"Update an SMS batch","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an SMS batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates supplied batch metadata and message template options, including the SMS "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Blank values for text fields are ignored. To submit a Draft or Invalid batch, set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"State"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and send a future "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ScheduledDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in UTC. The stored batch must have text, recipients, a positive TTL, 1–20 years of online retention, and a valid certification level. Batches created through the API have no defaults for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeToLive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnlineRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CertificationLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Set them before submitting or in the same PATCH request. A Submitted or Scheduled batch can be returned to Draft before processing starts."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviSmsBatchPatchRequest","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviSmsBatchPatchRequest","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/EviSms/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviSmsBatchPatchRequest","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/v2/EviSms/Batches/{BatchId}","href":"evisms/evismsbatchpatch","openApiOperationId":"eviSmsBatchPatch","summary":"Update an SMS batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"components/schemas/EviSmsBatchPatchRequest","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviSmsBatchPatchRequest","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch updated."},{"code":"400","description":"Invalid request."},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The site does not use by-submission billing."},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchpatch"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches/{BatchId}"},{"label":"Delete an SMS batch","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchdelete","metadata":{"seo":{"title":"Delete an SMS batch","description":"Removes a previously created batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchDelete","name":"Delete an SMS batch","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an SMS batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes a previously created batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviSms/Batches/{BatchId}","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviSms/Batches/{BatchId}","href":"evisms/evismsbatchdelete","openApiOperationId":"eviSmsBatchDelete","summary":"Delete an SMS batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Batch deleted."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchdelete"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches/{BatchId}"},{"label":"Add batch recipients (CSV)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientspost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientspost","metadata":{"seo":{"title":"Add batch recipients (CSV)","description":"Uploads the batch recipient list as a text/csv file, replacing any previous list. The upload supports up to 100,000 recipients. Use ; as the column separator. Mandatory columns: phonenumber, legalname. Optional columns: lookupkey, evidenceaccesscontrolchallenge, evidenceaccesscontrolchallengeresponse. Custom per-recipient fields are added as extra columns prefixed with * (for example, *orderid)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchRecipientsPost","name":"Add batch recipients (CSV)","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add batch recipients (CSV)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads the batch recipient list as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file, replacing any previous list. The upload supports up to 100,000 recipients. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the column separator. Mandatory columns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phonenumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"legalname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional columns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lookupkey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"evidenceaccesscontrolchallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"evidenceaccesscontrolchallengeresponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom per-recipient fields are added as extra columns prefixed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*orderid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/EviSms/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/v2/EviSms/Batches/{BatchId}/Recipients","href":"evisms/evismsbatchrecipientspost","openApiOperationId":"eviSmsBatchRecipientsPost","summary":"Add batch recipients (CSV)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeSchemas":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recipients accepted. No response body is returned."},{"code":"400","description":"The CSV is empty, invalid, or exceeds the recipient limit, or the batch cannot be edited."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchrecipientspost"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches/{BatchId}/Recipients"},{"label":"Query batch recipients (HTTP QUERY method)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsquery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsquery","metadata":{"seo":{"title":"Query batch recipients (HTTP QUERY method)","description":"Lists the recipients of a batch, with cursor pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchRecipientsQuery","name":"Query batch recipients (HTTP QUERY method)","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query batch recipients (HTTP QUERY method)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the recipients of a batch, with cursor pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint uses the HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, not GET."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" OpenAPI cannot express the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method, so it is shown here as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the filter fields as query parameters. In practice, send an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUERY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SortDirection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in a JSON body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","schemaId":"schema_12"},{"name":"SortDirection","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/EviSms/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"Cursor","in":"query","schemaId":"schema_0"},{"name":"Limit","in":"query","schemaId":"schema_12"},{"name":"SortDirection","in":"query","schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v2/EviSms/Batches/{BatchId}/Recipients","href":"evisms/evismsbatchrecipientsquery","openApiOperationId":"eviSmsBatchRecipientsQuery","summary":"Query batch recipients (HTTP QUERY method)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsBatchRecipientsQueryResponse"}},"schemaId":"components/schemas/EviSmsBatchRecipientsQueryResponse"},{"code":"400","description":"Malformed request."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviSmsBatchRecipientsQueryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSmsBatchRecipientsQueryResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchrecipientsquery"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches/{BatchId}/Recipients"},{"label":"Delete all batch recipients","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsdelete","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsdelete","metadata":{"seo":{"title":"Delete all batch recipients","description":"Removes all recipients from the batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSmsBatchRecipientsDelete","name":"Delete all batch recipients","isWebhook":false,"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all batch recipients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes all recipients from the batch."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"BatchId","in":"path","schemaId":"schema_4","required":true}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/EviSms/Batches/{BatchId}/Recipients","servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"parameters":{"path":[{"name":"BatchId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/v2/EviSms/Batches/{BatchId}/Recipients","href":"evisms/evismsbatchrecipientsdelete","openApiOperationId":"eviSmsBatchRecipientsDelete","summary":"Delete all batch recipients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com"},{"url":"https://api.ecertia.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Recipients removed."},{"code":"401","description":"Authentication failed"},{"code":"404","description":"No batch with the given BatchId was found."}],"pointer":"/paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisms/evismsbatchrecipientsdelete"}],"panels":[]}]},"httpPath":"/v2/EviSms/Batches/{BatchId}/Recipients"}],"content":{"contentType":"group","meta":{"name":"EviSMS"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EviSMS","showPageActions":true},{"nodeType":"markdoc","content":"Certified SMS and RCS submission, status tracking, and evidence retrieval via v1, plus SMS batch delivery and recipients via v2."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/EviSms/Submit","summary":"Submit a certified SMS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisms/evismssubmit","deprecated":false},{"title":"/v1/EviSms/Query","summary":"Query certified SMS messages (GET)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evisms/evismsqueryget","deprecated":false},{"title":"/v2/EviSms/Batches","summary":"Create an SMS batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisms/evismsbatchcreate","deprecated":false},{"title":"/v2/EviSms/Batches","summary":"Query SMS batches (HTTP QUERY method)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evisms/evismsbatchesquery","deprecated":false},{"title":"/v2/EviSms/Batches/{BatchId}","summary":"Get an SMS batch","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evisms/evismsbatchget","deprecated":false},{"title":"/v2/EviSms/Batches/{BatchId}","summary":"Update an SMS batch","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/evisms/evismsbatchpatch","deprecated":false},{"title":"/v2/EviSms/Batches/{BatchId}","summary":"Delete an SMS batch","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evisms/evismsbatchdelete","deprecated":false},{"title":"/v2/EviSms/Batches/{BatchId}/Recipients","summary":"Add batch recipients (CSV)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisms/evismsbatchrecipientspost","deprecated":false},{"title":"/v2/EviSms/Batches/{BatchId}/Recipients","summary":"Query batch recipients (HTTP QUERY method)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evisms/evismsbatchrecipientsquery","deprecated":false},{"title":"/v2/EviSms/Batches/{BatchId}/Recipients","summary":"Delete all batch recipients","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/evisms/evismsbatchrecipientsdelete","deprecated":false}]}]}]}]}},{"type":"group","label":"EviSign","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign","items":[{"label":"Submit a new EviSign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignsubmit","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignsubmit","metadata":{"seo":{"title":"Submit a new EviSign","description":"Creates a new EviSign for the authenticated site/user context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSignSubmit","name":"Submit a new EviSign","isWebhook":false,"pointer":"/paths/~1v1~1evisign~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a new EviSign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new EviSign for the authenticated site/user context."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Evi-IdempotencyToken","in":"header","schemaId":"schema_0","description":"Optional unique token per logical Submit. Reuse the same token to retry that submission."}],"pointer":"/paths/~1v1~1evisign~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignSubmit","exampleIds":["paths/~1v1~1evisign~1submit/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/v1.EviSignSubmit","exampleIds":["paths/~1v1~1evisign~1submit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1evisign~1submit/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Client-provided identifier used to look up a specific EviSign."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(required)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Subject line used for the EviSign submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(required)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Base64-encoded binary content of the main document to be signed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SigningParties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": List of signing parties required to sign the document."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signing party display name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Notification address used to deliver signature access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SigningMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature method required for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureAppearances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature appearance descriptors (JSON format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureQuestions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Additional questions shown during signing."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Question key identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Question label shown to the signer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Field type name for the question input."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Default value used when no explicit value is provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether the question is mandatory."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidationRegex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validation regex applied to the question value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidationMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validation message returned when regex validation fails."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ToolTip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Tooltip text shown for the question."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SelectListItems"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Available options when TypeName is a select-list field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UseWikiText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether Label should be rendered as wiki text."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PhoneNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Phone number used for SMS PIN signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignDelivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether delivery must be signed first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EmailAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Email address used for email PIN signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureChallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge question used for Challenge signing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureChallengeResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge response used for Challenge signing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LegalName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Legal name of the signing party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddressType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Address type of the signing party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DisableSignRequests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether signature request notifications are disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequiresCaptcha"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether captcha is required for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Language used for this signing party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SigningOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signing order position for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Role assigned to this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DisableFinalNotification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether final notifications are disabled for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DisableStateNotifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether state change notifications are disabled for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether this party is required to sign."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeToWait"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Time to wait for this signer, in minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignStep"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature step used for commitment/signature flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Address used for final notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DeliverySubDomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivery subdomain used for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DeliveryCustomUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Custom redirect URL used with DeliverySubDomain."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DeliveryWebView"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivery WebView target for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AllowVoicePinFallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether voice PIN fallback is allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DeliveryProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivery profile identifier for this party."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignerGeoLocationPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Geolocation policy applied during delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EntityIdKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Legal identifier type of the entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EntityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Legal identifier value of the entity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PersonIdKind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Legal identifier type of the signer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PersonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Legal identifier value of the signer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DelegatedSignature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delegated signature configuration."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WhatsAppPinPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": WhatsApp PIN policy applied to delegated signature flows."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WhatsAppPinPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": WhatsApp PIN policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestPolicy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Channel policy for signature request delivery attempts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestTemplate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Template name for signature request email notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestTemplateValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Placeholder values used to render SignatureRequestTemplate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProgressNotificationTemplate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Template name for progress email notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProgressNotificationTemplateValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Placeholder values used to render ProgressNotificationTemplate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationTemplate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Template name for final email notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationTemplateValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Placeholder values used to render FinalNotificationTemplate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureReminderTemplate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Template name for signature reminder email notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureReminderTemplateValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Placeholder values used to render SignatureReminderTemplate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LiteFlow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether LiteFlow is enabled for this party."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InterestedParties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": List of interested parties notified about the EviSign lifecycle."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Interested party email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProgressNotificationTemplate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Notification template identifier used for progress updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ProgressNotificationTemplateValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Placeholder values used to render ProgressNotificationTemplate."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Optional settings that customize EviSign submission behavior."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeToLive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Time to live in minutes for the EviSign lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestInfoText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Informational text shown in signature request notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LandingPageInfoText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Informational text shown on the signing landing page."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationInfoText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Informational text shown in the final notification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignedRedirectUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": URL where signers are redirected after signing successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Access control method required to open evidence in custody."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlChallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge question used when EvidenceAccessControlMethod is Challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlChallengeResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Challenge answer used when EvidenceAccessControlMethod is Challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AttachToSignatureRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates how attachments are included in signature request notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AttachToFinalNotification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates how attachments are included in final notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdditionalCommitments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Additional commitments shown during the signing process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Custom fields stored as additional metadata on the submitted EviSign."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(required)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Custom field key identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(required)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Display label for the custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(required)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Submitted value for the custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IsLookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether this field is used as lookup key."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Field type identifier used by dynamic form rendering."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DefaultValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Default value used when no explicit value is provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether a value is required for this field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidationRegex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validation regex applied to the field value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidationMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Validation message returned when regex validation fails."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotaryRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Notary retention period in years. Values greater than zero enable notary custody."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotaryProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Notary profile identifier. Required when NotaryRetentionPeriod is greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnlineRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Online retention period in years."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CertificationLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certification level applied to the submitted evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalRejectedNotificationInfoText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Informational text shown in rejection notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureReminderInfoText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Informational text shown in signature reminder notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExpiredNotificationInfoText"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Informational text shown in expiration notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Language"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": UI/content language used for signer-facing pages and notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitLanguage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Language used for affidavit generation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SecurityTags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Security tags associated with the generated evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PushNotificationUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Callback URL that receives POST push notifications for message events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PushNotificationFilter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Push notification events to send to PushNotificationUrl."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CostCentre"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cost center identifier associated with the submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CommitmentOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Commitment behavior options used in signer interactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CommitmentCommentsAllowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether commitment comments are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InterestedPartiesNotifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Interested-party notification event names to emit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GenerateSignedDocument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether the signed document should be generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reminders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reminder scheduling configuration."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Initial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Initial delay before sending the first reminder."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Repeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Interval used to send repeated reminders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Days of the week when reminders can be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeRange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Allowed daily time range for sending reminders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Maximum number of reminders to send."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Condition or limit that stops reminder delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TimeZone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Time zone used to evaluate reminder schedule settings."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PushNotificationExtraData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Extra payload included in each push notification callback."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GenerateSignedDocumentOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Configuration used when GenerateSignedDocument is enabled."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CertificationCertificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certificate identifier used to generate the signed document."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RequireRejectReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether signers must provide a reject reason when rejecting."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RejectReasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": List of allowed reject reasons presented to signers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SummaryAffidavit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Summary affidavit generation settings."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Masking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": List of masking patterns applied to affidavit content."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludeDocument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether the main document is included."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludeAttachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether attachments are included."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludeEvents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether events are included."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludedCommitments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Commitment roles to include in the summary affidavit."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitKinds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Explicit affidavit kinds requested for this submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DisablePlatformReferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether platform references should be hidden in generated artifacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OwnerNotificationTemplate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Owner notification template identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OwnerNotificationTemplateValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Placeholder values used to render OwnerNotificationTemplate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LtaStorage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether long-term archive storage is requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CustomLayoutLogoUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Custom logo URL used by the signature layout."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Optional supporting attachments included with the EviSign submission."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment content identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DisplayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment display name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment file name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MimeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment MIME type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContentDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment content description."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContentDisposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment content disposition."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContentLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment content location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContentEncoding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Content encoding of the attachment payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment binary content."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachment key-value attributes (for example, RequireContentCommitment=true)."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attribute key."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attribute value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attribute values."},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Issuer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Display name of the issuer shown to parties."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sender email address used for recipient-facing communications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DisableSenderHeader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates whether the sender header should be omitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ReplyTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reply-to email address for recipient responses."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/evisign/submit","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Evi-IdempotencyToken","in":"header","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/v1.EviSignSubmit","exampleIds":["paths/~1v1~1evisign~1submit/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","202","400","401","403","409","500","default"],"pointer":"/v1/evisign/submit","href":"evisign/evisignsubmit","openApiOperationId":"eviSignSubmit","summary":"Submit a new EviSign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/v1.EviSignSubmit","exampleIds":["paths/~1v1~1evisign~1submit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignSubmit","exampleIds":["paths/~1v1~1evisign~1submit/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"EviSign message accepted and persisted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignSubmit._Result"}},"schemaId":"components/schemas/v1.EviSignSubmit._Result","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome when a token is supplied.","schema":{"type":"string","enum":["New"]}}},"headerSchemaId":"schema_24"},{"code":"202","description":"Request replay detected by idempotency key; returning previously stored result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignSubmit._Result"}},"schemaId":"components/schemas/v1.EviSignSubmit._Result","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome when a token is supplied.","schema":{"type":"string","enum":["Replay"]}}},"headerSchemaId":"schema_25"},{"code":"400","description":"Invalid request or business rule failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"403","description":"API, EviSign service, or required operation permission is missing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"409","description":"A request with the same idempotency token is in progress. Retry the same logical submission with the same token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse","headers":{"X-Evi-IdempotencyStatus":{"schema":{"type":"string","enum":["Conflict"]}}},"headerSchemaId":"schema_26"},{"code":"500","description":"Unexpected server failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"}],"pointer":"/paths/~1v1~1evisign~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/v1.EviSignSubmit._Result","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignSubmit._Result"}}},{"code":"202","schemaId":"components/schemas/v1.EviSignSubmit._Result","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignSubmit._Result"}}},{"code":"400","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"default","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisign/evisignsubmit"}],"panels":[]}]},"httpPath":"/v1/evisign/submit"},{"label":"Query EviSign messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignquery","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignquery","metadata":{"seo":{"title":"Query EviSign messages","description":"Query EviSigns visible to the authenticated context. For metadata-only pages of up to 25, explicitly set IncludeAttachmentBlobsOnResult and IncludeAffidavitBlobsOnResult to false and enable the entry flags you need. ASP.NET defaults both file-content flags to false. The legacy service has deployment settings whose declared defaults enable both. Including attachment or affidavit entries with file bytes limits the request to one result. Use Bundle to retrieve a ZIP archive."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSignQuery","name":"Query EviSign messages","isWebhook":false,"pointer":"/paths/~1v1~1evisign~1query/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query EviSign messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Query EviSigns visible to the authenticated context. For metadata-only pages of up to 25, explicitly set IncludeAttachmentBlobsOnResult and IncludeAffidavitBlobsOnResult to false and enable the entry flags you need. ASP.NET defaults both file-content flags to false. The legacy service has deployment settings whose declared defaults enable both. Including attachment or affidavit entries with file bytes limits the request to one result. Use Bundle to retrieve a ZIP archive."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"WithUniqueIds","in":"query","style":"form","explode":false,"schemaId":"schema_27","description":"Filters results by EviSign unique identifiers."},{"name":"WithLookupKeys","in":"query","style":"form","explode":false,"schemaId":"schema_28","description":"Filter by client lookup keys. Comma-separated values are supported; a lookup key containing a comma cannot be represented as one value in this form."},{"name":"OnState","in":"query","schemaId":"components/schemas/v1.EviSignQuery._State","description":"Filters results by current processing state."},{"name":"WithOutcome","in":"query","schemaId":"components/schemas/v1.EviSignQuery._Outcome","description":"Filters results by processing outcome."},{"name":"OrderResultsBy","in":"query","schemaId":"schema_29","description":"Sort order used for the query results."},{"name":"Offset","in":"query","schemaId":"schema_30","description":"Number of entries to skip."},{"name":"Limit","in":"query","schemaId":"schema_31","description":"Maximum 1 when including attachment or affidavit entries with file bytes. To page metadata up to 25, explicitly enable the entry flags you need and set both file-content flags to false. Disable attachment and affidavit entries for pages up to 100. When omitted, the service selects a default limit from the effective inclusion flags."},{"name":"IncludeAffidavitsOnResult","in":"query","schemaId":"schema_32","description":"Includes affidavit entries in each result. Defaults to false. Set IncludeAffidavitBlobsOnResult to false for metadata only."},{"name":"IncludeEventsOnResult","in":"query","schemaId":"schema_33","description":"Includes event metadata in each result. Defaults to false."},{"name":"IncludeAttachmentsOnResult","in":"query","schemaId":"schema_34","description":"Includes attachment entries in each result. Defaults to true on the ASP.NET API. The legacy service uses a deployment setting whose declared default is true. Set IncludeAttachmentBlobsOnResult to false for metadata only."},{"name":"IncludeAttachmentBlobsOnResult","in":"query","schemaId":"schema_5","description":"Compatibility flag for file bytes when attachment entries are included. Defaults to false on ASP.NET. The legacy service uses a deployment setting whose declared default is true. Set to false explicitly for metadata only."},{"name":"IncludeAffidavitBlobsOnResult","in":"query","schemaId":"schema_5","description":"Compatibility flag for file bytes when affidavit entries are included. Defaults to false on ASP.NET. The legacy service uses a deployment setting whose declared default is true. Set to false explicitly for metadata only."},{"name":"IncludeDocumentsOnResult","in":"query","schemaId":"schema_32","description":"Includes generated document metadata in each result. Defaults to false."}],"pointer":"/paths/~1v1~1evisign~1query/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/evisign/query","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_27","style":"form","explode":false},{"name":"WithLookupKeys","in":"query","schemaId":"schema_28","style":"form","explode":false},{"name":"OnState","in":"query","schemaId":"components/schemas/v1.EviSignQuery._State"},{"name":"WithOutcome","in":"query","schemaId":"components/schemas/v1.EviSignQuery._Outcome"},{"name":"OrderResultsBy","in":"query","schemaId":"schema_29"},{"name":"Offset","in":"query","schemaId":"schema_30"},{"name":"Limit","in":"query","schemaId":"schema_31"},{"name":"IncludeAffidavitsOnResult","in":"query","schemaId":"schema_32"},{"name":"IncludeEventsOnResult","in":"query","schemaId":"schema_33"},{"name":"IncludeAttachmentsOnResult","in":"query","schemaId":"schema_34"},{"name":"IncludeAttachmentBlobsOnResult","in":"query","schemaId":"schema_5"},{"name":"IncludeAffidavitBlobsOnResult","in":"query","schemaId":"schema_5"},{"name":"IncludeDocumentsOnResult","in":"query","schemaId":"schema_32"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","500","default"],"pointer":"/v1/evisign/query","href":"evisign/evisignquery","openApiOperationId":"eviSignQuery","summary":"Query EviSign messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignQuery._Result"}},"schemaId":"components/schemas/v1.EviSignQuery._Result"},{"code":"400","description":"Invalid request or business rule failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"403","description":"API, EviSign service, or required operation permission is missing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"500","description":"Unexpected server failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"}],"pointer":"/paths/~1v1~1evisign~1query/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/v1.EviSignQuery._Result","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignQuery._Result"}}},{"code":"400","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"default","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisign/evisignquery"}],"panels":[]}]},"httpPath":"/v1/evisign/query"},{"label":"Cancel an existing EviSign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisigncancel","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisigncancel","metadata":{"seo":{"title":"Cancel an existing EviSign","description":"Requests cancellation of a previously submitted EviSign for the authenticated site/user context. Cancellation is accepted and processed asynchronously."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSignCancel","name":"Cancel an existing EviSign","isWebhook":false,"pointer":"/paths/~1v1~1evisign~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an existing EviSign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requests cancellation of a previously submitted EviSign for the authenticated site/user context. Cancellation is accepted and processed asynchronously."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignCancel","exampleIds":["paths/~1v1~1evisign~1cancel/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/v1.EviSignCancel","exampleIds":["paths/~1v1~1evisign~1cancel/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1evisign~1cancel/post/requestBody","description":"UniqueId is required and must not be the empty UUID. Comments is a required, nonblank cancellation reason (maximum 2048 characters). Quietly defaults to false."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/evisign/cancel","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/v1.EviSignCancel","exampleIds":["paths/~1v1~1evisign~1cancel/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","500","default"],"pointer":"/v1/evisign/cancel","href":"evisign/evisigncancel","openApiOperationId":"eviSignCancel","summary":"Cancel an existing EviSign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/v1.EviSignCancel","exampleIds":["paths/~1v1~1evisign~1cancel/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignCancel","exampleIds":["paths/~1v1~1evisign~1cancel/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cancellation request accepted and queued for processing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignCancel._Result"}},"schemaId":"components/schemas/v1.EviSignCancel._Result"},{"code":"400","description":"Invalid request or business rule failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"401","description":"Authentication failed, or the caller does not own the EviSign.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"403","description":"API, EviSign service, or required operation permission is missing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"404","description":"EviSign not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"409","description":"EviSign state prevents cancellation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"500","description":"Unexpected server failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"}],"pointer":"/paths/~1v1~1evisign~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/v1.EviSignCancel._Result","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignCancel._Result"}}},{"code":"400","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"default","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisign/evisigncancel"}],"panels":[]}]},"httpPath":"/v1/evisign/cancel"},{"label":"Resend an EviSign signature request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignresend","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignresend","metadata":{"seo":{"title":"Resend an EviSign signature request","description":"Requests resending the signature request for a signing party of a previously submitted EviSign in the authenticated site/user context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSignResend","name":"Resend an EviSign signature request","isWebhook":false,"pointer":"/paths/~1v1~1evisign~1resend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend an EviSign signature request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requests resending the signature request for a signing party of a previously submitted EviSign in the authenticated site/user context."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignResend","exampleIds":["paths/~1v1~1evisign~1resend/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/v1.EviSignResend","exampleIds":["paths/~1v1~1evisign~1resend/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1evisign~1resend/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UniqueId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(non-default)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Unique identifier of the EviSign for which the signature request will be resent."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotificationAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(required)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Notification address of the signing party to whom the signature request will be resent."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/evisign/resend","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/v1.EviSignResend","exampleIds":["paths/~1v1~1evisign~1resend/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500","default"],"pointer":"/v1/evisign/resend","href":"evisign/evisignresend","openApiOperationId":"eviSignResend","summary":"Resend an EviSign signature request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/v1.EviSignResend","exampleIds":["paths/~1v1~1evisign~1resend/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignResend","exampleIds":["paths/~1v1~1evisign~1resend/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resend request accepted and queued for processing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignResend._Result"}},"schemaId":"components/schemas/v1.EviSignResend._Result"},{"code":"400","description":"Invalid request or business rule failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"401","description":"Authentication failed, or the caller does not own the EviSign.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"403","description":"API, EviSign service, or required operation permission is missing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"404","description":"EviSign not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"409","description":"NotificationAddress matches zero or multiple parties.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"429","description":"Resend cooldown or configured SMS limit reached. Retry-After is supplied when a cooldown is available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse","headers":{"Retry-After":{"description":"Cooldown in seconds, when available.","schema":{"type":"string"}}},"headerSchemaId":"schema_35"},{"code":"500","description":"Unexpected server failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"}],"pointer":"/paths/~1v1~1evisign~1resend/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/v1.EviSignResend._Result","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignResend._Result"}}},{"code":"400","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"429","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"default","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisign/evisignresend"}],"panels":[]}]},"httpPath":"/v1/evisign/resend"},{"label":"Request an on-demand affidavit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignaffidavitrequest","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignaffidavitrequest","metadata":{"seo":{"title":"Request an on-demand affidavit","description":"Asynchronously request an affidavit for an EviSign owned by the caller. The original submission must enable OnDemand affidavits; Draft and Closed entries, exhausted limits and unavailable records are rejected with 400. IncludedCommitments accepts None or Signers and defaults to None in the generation job. Acceptance queues the request. Closure or the request limit can prevent later generation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSignAffidavitRequest","name":"Request an on-demand affidavit","isWebhook":false,"pointer":"/paths/~1v1~1evisign~1affidavitrequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an on-demand affidavit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Asynchronously request an affidavit for an EviSign owned by the caller. The original submission must enable OnDemand affidavits; Draft and Closed entries, exhausted limits and unavailable records are rejected with 400. IncludedCommitments accepts None or Signers and defaults to None in the generation job. Acceptance queues the request. Closure or the request limit can prevent later generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignAffidavitRequest","exampleIds":["paths/~1v1~1evisign~1affidavitrequest/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/v1.EviSignAffidavitRequest","exampleIds":["paths/~1v1~1evisign~1affidavitrequest/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1evisign~1affidavitrequest/post/requestBody","description":"Required nonempty UniqueId; optional IncludeDocument, IncludeAttachments, IncludeEvents, IncludedCommitments (None or Signers), and Masking. IncludeAttachments includes only attachments submitted with RequireContentCommitment enabled."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/evisign/affidavitrequest","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/v1.EviSignAffidavitRequest","exampleIds":["paths/~1v1~1evisign~1affidavitrequest/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","500","default"],"pointer":"/v1/evisign/affidavitrequest","href":"evisign/evisignaffidavitrequest","openApiOperationId":"eviSignAffidavitRequest","summary":"Request an on-demand affidavit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/v1.EviSignAffidavitRequest","exampleIds":["paths/~1v1~1evisign~1affidavitrequest/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/v1.EviSignAffidavitRequest","exampleIds":["paths/~1v1~1evisign~1affidavitrequest/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Affidavit on-demand request accepted and queued for processing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignAffidavitRequest._Result"}},"schemaId":"components/schemas/v1.EviSignAffidavitRequest._Result"},{"code":"400","description":"Invalid request or business rule failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"403","description":"API, EviSign service, or required operation permission is missing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"500","description":"Unexpected server failure.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"},{"code":"default","description":"Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}},"schemaId":"components/schemas/v1.ErrorResponse"}],"pointer":"/paths/~1v1~1evisign~1affidavitrequest/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/v1.EviSignAffidavitRequest._Result","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.EviSignAffidavitRequest._Result"}}},{"code":"400","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}},{"code":"default","schemaId":"components/schemas/v1.ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/v1.ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisign/evisignaffidavitrequest"}],"panels":[]}]},"httpPath":"/v1/evisign/affidavitrequest"},{"label":"Download EviSign bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignbundle","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignbundle","metadata":{"seo":{"title":"Download EviSign bundle","description":"Download a ZIP containing the original document plus the available files selected by the inclusion flags. The EviSign must belong to the authenticated site; missing or inaccessible entries return 404. No Closed-state prerequisite is imposed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSignBundle","name":"Download EviSign bundle","isWebhook":false,"pointer":"/paths/~1v2~1evisign~1{Id}~1bundle/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download EviSign bundle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download a ZIP containing the original document plus the available files selected by the inclusion flags. The EviSign must belong to the authenticated site; missing or inaccessible entries return 404. No Closed-state prerequisite is imposed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Id","in":"path","schemaId":"schema_4","description":"Unique identifier of the EviSign to download.","required":true}],"pointer":"/paths/~1v2~1evisign~1{Id}~1bundle/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"IncludeAffidavits","in":"query","schemaId":"schema_33","description":"Includes affidavit files in the bundle when true. Defaults to false."},{"name":"IncludeAttachments","in":"query","schemaId":"schema_33","description":"Includes attachment files in the bundle when true. Defaults to false."},{"name":"IncludeNotifications","in":"query","schemaId":"schema_33","description":"Includes notification EML files in the bundle when true. Defaults to false."},{"name":"IncludeAdditionalDocuments","in":"query","schemaId":"schema_33","description":"Includes non-original generated documents in the bundle when true. Defaults to false."}],"pointer":"/paths/~1v2~1evisign~1{Id}~1bundle/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/evisign/{Id}/bundle","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[{"name":"Id","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"IncludeAffidavits","in":"query","schemaId":"schema_33"},{"name":"IncludeAttachments","in":"query","schemaId":"schema_33"},{"name":"IncludeNotifications","in":"query","schemaId":"schema_33"},{"name":"IncludeAdditionalDocuments","in":"query","schemaId":"schema_33"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/v2/evisign/{Id}/bundle","href":"evisign/evisignbundle","openApiOperationId":"eviSignBundle","summary":"Download EviSign bundle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bundle downloaded successfully as a ZIP file.","mediaType":"application/zip","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1v2~1evisign~1{Id}~1bundle/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}}},{"code":"400","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"401","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"403","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"404","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"409","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}}},{"code":"500","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisign/evisignbundle"}],"panels":[]}]},"httpPath":"/v2/evisign/{Id}/bundle"},{"label":"Create a temporary signing link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignsignlink","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignsignlink","metadata":{"seo":{"title":"Create a temporary signing link","description":"Generate a one-hour link for one party to access one or more already processed EviSigns owned by the caller. Single-item methods: MobilePin, EmailPin, Handwriting, WebClick. Multiple-item flow accepts MobilePin, EmailPin or WebClick with compatible commitment and geolocation settings; delivery subdomains, reject reasons and signature questions are not supported. The whole request fails if all items are discarded or the allowed count is exceeded. Lite Flow is incompatible with handwriting, geolocation, BeforeDoc/End signing steps or a configured SignedRedirectUrl. Treat the returned URL as sensitive and opaque. JSON and legacy XML are supported; the guide documents XML names and negotiation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviSignSignLink","name":"Create a temporary signing link","isWebhook":false,"pointer":"/paths/~1EviSign~1SignLink/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a temporary signing link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate a one-hour link for one party to access one or more already processed EviSigns owned by the caller. Single-item methods: MobilePin, EmailPin, Handwriting, WebClick. Multiple-item flow accepts MobilePin, EmailPin or WebClick with compatible commitment and geolocation settings; delivery subdomains, reject reasons and signature questions are not supported. The whole request fails if all items are discarded or the allowed count is exceeded. Lite Flow is incompatible with handwriting, geolocation, BeforeDoc/End signing steps or a configured SignedRedirectUrl. Treat the returned URL as sensitive and opaque. JSON and legacy XML are supported; the guide documents XML names and negotiation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkRequest","exampleIds":["paths/~1EviSign~1SignLink/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviSignSignLinkRequest","exampleIds":["paths/~1EviSign~1SignLink/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1EviSign~1SignLink/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/EviSign/SignLink","servers":[{"url":"https://app.evicertia.com","description":"Production SignLink"},{"url":"https://app.ecertia.com","description":"Pre-production / QA SignLink"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkRequest","exampleIds":["paths/~1EviSign~1SignLink/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","409","500"],"pointer":"/EviSign/SignLink","href":"evisign/evisignsignlink","openApiOperationId":"eviSignSignLink","summary":"Create a temporary signing link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://app.evicertia.com","description":"Production SignLink"},{"url":"https://app.ecertia.com","description":"Pre-production / QA SignLink"}],"schemaId":"components/schemas/EviSignSignLinkRequest","exampleIds":["paths/~1EviSign~1SignLink/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkRequest","exampleIds":["paths/~1EviSign~1SignLink/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Temporary link created. Inspect results for discarded items; order need not match input.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkResponse","exampleIds":["paths/~1EviSign~1SignLink/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviSignSignLinkResponse","exampleIds":["paths/~1EviSign~1SignLink/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid parameters, incompatible multiple-item settings or unsupported Lite Flow configuration.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkError"}},"schemaId":"components/schemas/EviSignSignLinkError","headers":{"X-Evi-Error-Id":{"schema":{"type":"string","format":"uuid"},"description":"Error correlation ID; also returned in responseStatus.errorId."}},"headerSchemaId":"schema_36"},{"code":"401","description":"Authentication missing or invalid. Empty response body."},{"code":"409","description":"All items discarded or discarded count exceeds DiscardedThreshold.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkError"}},"schemaId":"components/schemas/EviSignSignLinkError","headers":{"X-Evi-Error-Id":{"schema":{"type":"string","format":"uuid"},"description":"Error correlation ID; also returned in responseStatus.errorId."}},"headerSchemaId":"schema_36"},{"code":"500","description":"Unexpected error, or API/EviSign service not enabled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkError"}},"schemaId":"components/schemas/EviSignSignLinkError","headers":{"X-Evi-Error-Id":{"schema":{"type":"string","format":"uuid"},"description":"Error correlation ID; also returned in responseStatus.errorId."}},"headerSchemaId":"schema_36"}],"pointer":"/paths/~1EviSign~1SignLink/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviSignSignLinkResponse","exampleIds":["paths/~1EviSign~1SignLink/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkResponse","exampleIds":["paths/~1EviSign~1SignLink/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/EviSignSignLinkError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkError"}}},{"code":"401"},{"code":"409","schemaId":"components/schemas/EviSignSignLinkError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkError"}}},{"code":"500","schemaId":"components/schemas/EviSignSignLinkError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviSignSignLinkError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evisign/evisignsignlink"}],"panels":[]}]},"httpPath":"/EviSign/SignLink"}],"content":{"contentType":"group","meta":{"name":"EviSign"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EviSign","showPageActions":true},{"nodeType":"markdoc","content":"EviSign has entered Long-Term Support (LTS). It will continue to receive security patches and critical bug fixes, but no new features will be developed.\nElectronic signature submission, status tracking, cancellation, resending, on-demand affidavits, ZIP bundles and temporary signing links."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/evisign/submit","summary":"Submit a new EviSign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisign/evisignsubmit","deprecated":false},{"title":"/v1/evisign/query","summary":"Query EviSign messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evisign/evisignquery","deprecated":false},{"title":"/v1/evisign/cancel","summary":"Cancel an existing EviSign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisign/evisigncancel","deprecated":false},{"title":"/v1/evisign/resend","summary":"Resend an EviSign signature request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisign/evisignresend","deprecated":false},{"title":"/v1/evisign/affidavitrequest","summary":"Request an on-demand affidavit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisign/evisignaffidavitrequest","deprecated":false},{"title":"/v2/evisign/{Id}/bundle","summary":"Download EviSign bundle","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evisign/evisignbundle","deprecated":false},{"title":"/EviSign/SignLink","summary":"Create a temporary signing link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evisign/evisignsignlink","deprecated":false}]}]}]}]}},{"type":"group","label":"EviPost","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost","items":[{"label":"Submit a certified postal communication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostsubmit","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostsubmit","metadata":{"seo":{"title":"Submit a certified postal communication","description":"Submit a Base64-encoded PDF smaller than 2,097,152 bytes before encoding. Acceptance does not confirm later PDF validation or postal delivery. A processing failure or postal-service rejection can close the communication with outcome Failed; use Query to check the outcome."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostSubmit","name":"Submit a certified postal communication","isWebhook":false,"pointer":"/paths/~1v1~1EviPost~1Submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a certified postal communication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a Base64-encoded PDF smaller than 2,097,152 bytes before encoding. Acceptance does not confirm later PDF validation or postal delivery. A processing failure or postal-service rejection can close the communication with outcome "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use Query to check the outcome."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Evi-IdempotencyToken","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional idempotency token (GUID recommended) to prevent duplicate submissions on retry. A replay of a cached "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submission returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Responses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"408"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not cached for replay."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1EviPost~1Submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1v1~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"]}},"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1v1~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"],"pointer":"/paths/~1v1~1EviPost~1Submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/EviPost/Submit","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Evi-IdempotencyToken","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1v1~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"]}},"responseCodes":["200","202","400","401","403","409","492"],"pointer":"/v1/EviPost/Submit","href":"evipost/evipostsubmit","openApiOperationId":"eviPostSubmit","summary":"Submit a certified postal communication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1v1~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1v1~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Postal communication accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1v1~1EviPost~1Submit/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1v1~1EviPost~1Submit/post/responses/200/content/application~1json/example"],"headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["New"]}}},"headerSchemaId":"schema_1"},{"code":"202","description":"Idempotent replay. The same X-Evi-IdempotencyToken was used for a cached 200 OK submission. The original response body is returned; the postal communication is not resubmitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse"}},"schemaId":"components/schemas/EviPostSubmitResponse","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Replay"]}}},"headerSchemaId":"schema_2"},{"code":"400","description":"Invalid request or business rule failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}},"schemaId":"components/schemas/EviMailAffidavitError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Access denied. The authenticated account is not provisioned for EviPost. Contact your Namirial Notify account manager to enable this service.\n"},{"code":"409","description":"Another Submit with the same X-Evi-IdempotencyToken is currently in flight.","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Conflict"]}}},"headerSchemaId":"schema_3"},{"code":"492","description":"Submission quota for this recipient or for this service type on the site was reached. Avoid retrying immediately; contact support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}},"schemaId":"components/schemas/EviMailAffidavitError"}],"pointer":"/paths/~1v1~1EviPost~1Submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1v1~1EviPost~1Submit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1v1~1EviPost~1Submit/post/responses/200/content/application~1json/example"]}}},{"code":"202","schemaId":"components/schemas/EviPostSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse"}}},{"code":"400","schemaId":"components/schemas/EviMailAffidavitError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}}},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"492","schemaId":"components/schemas/EviMailAffidavitError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostsubmit"}],"panels":[]}]},"httpPath":"/v1/EviPost/Submit"},{"label":"Query certified postal communications (GET)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostqueryget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostqueryget","metadata":{"seo":{"title":"Query certified postal communications (GET)","description":"Query certified postal communications (GET)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostQueryGet","name":"Query certified postal communications (GET)","isWebhook":false,"pointer":"/paths/~1v1~1EviPost~1Query/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query certified postal communications (GET)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0","description":"Filter by one or more unique IDs (comma-separated)."},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0","description":"Filter by one or more lookup keys (comma-separated)."},{"name":"OnState","in":"query","schemaId":"schema_37","description":"Filter by current state. Contact support before using this parameter."},{"name":"WithOutcome","in":"query","schemaId":"schema_38","description":"Filter by outcome. Contact support before using this parameter."},{"name":"OrderResultsBy","in":"query","schemaId":"schema_18","description":"Sort field for results."},{"name":"Offset","in":"query","schemaId":"schema_20","description":"Number of results to skip for pagination."},{"name":"Limit","in":"query","schemaId":"schema_8","description":"Default and maximum are 100 without affidavits, 25 with affidavit metadata, and 1 with embedded affidavit PDFs.\n"},{"name":"IncludeDocumentOnResult","in":"query","schemaId":"schema_5","description":"Include the base64-encoded original document in results."},{"name":"IncludeAffidavitsOnResult","in":"query","schemaId":"schema_5","description":"Include affidavit metadata in results."},{"name":"IncludeAffidavitBlobsOnResult","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled with IncludeAffidavitsOnResult, embeds Base64 affidavit PDFs in affidavits[].bytes. Some deployments enable blobs when this flag is omitted. Set false explicitly for metadata-only results and use /AffidavitsDownload to fetch PDFs."},"children":[]}]}]}],"deprecated":true}],"pointer":"/paths/~1v1~1EviPost~1Query/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/EviPost/Query","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0"},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0"},{"name":"OnState","in":"query","schemaId":"schema_37"},{"name":"WithOutcome","in":"query","schemaId":"schema_38"},{"name":"OrderResultsBy","in":"query","schemaId":"schema_18"},{"name":"Offset","in":"query","schemaId":"schema_20"},{"name":"Limit","in":"query","schemaId":"schema_8"},{"name":"IncludeDocumentOnResult","in":"query","schemaId":"schema_5"},{"name":"IncludeAffidavitsOnResult","in":"query","schemaId":"schema_5"},{"name":"IncludeAffidavitBlobsOnResult","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/EviPost/Query","href":"evipost/evipostqueryget","openApiOperationId":"eviPostQueryGet","summary":"Query certified postal communications (GET)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1v1~1EviPost~1Query/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1v1~1EviPost~1Query/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid query, including a limit above the applicable maximum.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}},"schemaId":"components/schemas/EviMailAffidavitError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Access denied. The authenticated account is not provisioned for EviPost. Contact your Namirial Notify account manager to enable this service.\n"}],"pointer":"/paths/~1v1~1EviPost~1Query/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1v1~1EviPost~1Query/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1v1~1EviPost~1Query/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/EviMailAffidavitError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostqueryget"}],"panels":[]}]},"httpPath":"/v1/EviPost/Query"},{"label":"Request an on-demand affidavit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostaffidavitrequest","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostaffidavitrequest","metadata":{"seo":{"title":"Request an on-demand affidavit","description":"The original submitting account can request an affidavit for a submitted Letter or LetterLite before it closes. At Submit, enable AffidavitsOnDemandEnabled and use AdvancedContentOnSubmit, AdvancedContentOnClose, or AdvancedContentOnSubmitAndOnClose. Generation is asynchronous and a configurable limit applies per communication. Registered accepts the flag at Submit but cannot use this operation. The platform skips a queued request if the communication closes or earlier requests reach the limit before processing. In these cases no AffidavitPublished callback is sent for the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostAffidavitRequest","name":"Request an on-demand affidavit","isWebhook":false,"pointer":"/paths/~1v1~1EviPost~1AffidavitRequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an on-demand affidavit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original submitting account can request an affidavit for a submitted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before it closes. At Submit, enable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitsOnDemandEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdvancedContentOnSubmit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdvancedContentOnClose"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdvancedContentOnSubmitAndOnClose"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Generation is asynchronous and a configurable limit applies per communication. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts the flag at Submit but cannot use this operation. The platform skips a queued request if the communication closes or earlier requests reach the limit before processing. In these cases no AffidavitPublished callback is sent for the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/EviPost/AffidavitRequest","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/v1/EviPost/AffidavitRequest","href":"evipost/evipostaffidavitrequest","openApiOperationId":"eviPostAffidavitRequest","summary":"Request an on-demand affidavit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Affidavit request queued. Use Query to check which affidavits were generated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request or business rule failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}},"schemaId":"components/schemas/EviMailAffidavitError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The authenticated account lacks the required API or EviPost permissions."}],"pointer":"/paths/~1v1~1EviPost~1AffidavitRequest/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1v1~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/EviMailAffidavitError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviMailAffidavitError"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostaffidavitrequest"}],"panels":[]}]},"httpPath":"/v1/EviPost/AffidavitRequest"},{"label":"Cancel a postal communication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostcancel","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostcancel","metadata":{"seo":{"title":"Cancel a postal communication","description":"Requests cancellation of a previously submitted EviPost. Use this operation for Letter with a delivery receipt, delivery attempts, or disposal enabled. The communication must not be Draft or Closed, and the request must be within the configured cancellation window (30 minutes from creation by default). Only the submitting account can request cancellation. Requires CanUseCancel and the standard EviPost API permission. A successful response accepts the request for asynchronous processing; it does not confirm cancellation by the postal operator. To confirm cancellation, check that Query reports the Cancelled state, or the Closed state with the Cancelled outcome. A Cancelled callback confirms cancellation only when AdditionalData.Success is true; false reports an unsuccessful attempt. The API can accept LetterLite requests, but the current cancellation processor does not support that service type; contact support if cancellation is needed. Requests that fail an eligibility check are rejected. A non-2xx response means the request was not accepted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostCancel","name":"Cancel a postal communication","isWebhook":false,"pointer":"/paths/~1v1~1EviPost~1Cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a postal communication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests cancellation of a previously submitted EviPost. Use this operation for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a delivery receipt, delivery attempts, or disposal enabled. The communication must not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the request must be within the configured cancellation window (30 minutes from creation by default). Only the submitting account can request cancellation. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CanUseCancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the standard EviPost API permission. A successful response accepts the request for asynchronous processing; it does not confirm cancellation by the postal operator. To confirm cancellation, check that Query reports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" outcome. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callback confirms cancellation only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdditionalData.Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports an unsuccessful attempt. The API can accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests, but the current cancellation processor does not support that service type; contact support if cancellation is needed. Requests that fail an eligibility check are rejected. A non-2xx response means the request was not accepted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v1~1EviPost~1Cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/EviPost/Cancel","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/EviPost/Cancel","href":"evipost/evipostcancel","openApiOperationId":"eviPostCancel","summary":"Cancel a postal communication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cancellation request accepted for asynchronous processing; cancellation is not yet confirmed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request, such as a malformed UUID. Supply a non-empty UniqueId."},{"code":"401","description":"Authentication failed, or the authenticated account is not the owner of the postal communication."},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticated account lacks the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CanUseCancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission, or EviPost is not enabled for this account."},"children":[]}]}]}]},{"code":"404","description":"No postal communication with the given UniqueId was found."}],"pointer":"/paths/~1v1~1EviPost~1Cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1v1~1EviPost~1Cancel/post/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostcancel"}],"panels":[]}]},"httpPath":"/v1/EviPost/Cancel"}],"content":{"contentType":"group","meta":{"name":"EviPost"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EviPost","showPageActions":true},{"nodeType":"markdoc","content":"Certified physical postal delivery with status tracking, cancellation requests for eligible items, and on-demand affidavits for open Letter and LetterLite items."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/EviPost/Submit","summary":"Submit a certified postal communication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evipost/evipostsubmit","deprecated":false},{"title":"/v1/EviPost/Query","summary":"Query certified postal communications (GET)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evipost/evipostqueryget","deprecated":false},{"title":"/v1/EviPost/AffidavitRequest","summary":"Request an on-demand affidavit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evipost/evipostaffidavitrequest","deprecated":false},{"title":"/v1/EviPost/Cancel","summary":"Cancel a postal communication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evipost/evipostcancel","deprecated":false}]}]}]}]}},{"type":"group","label":"Shared Downloads","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads","items":[{"label":"Download attachments by ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadpost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadpost","metadata":{"seo":{"title":"Download attachments by ID","description":"Download attachments by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachmentDownloadPost","name":"Download attachments by ID","isWebhook":false,"pointer":"/paths/~1AttachmentDownload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download attachments by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UniqueIdsRequest"}},"schemaId":"components/schemas/UniqueIdsRequest","pointer":"/paths/~1AttachmentDownload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/AttachmentDownload","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UniqueIdsRequest"}},"responseCodes":["200","401"],"pointer":"/AttachmentDownload","href":"shared-downloads/attachmentdownloadpost","openApiOperationId":"attachmentDownloadPost","summary":"Download attachments by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/UniqueIdsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UniqueIdsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment metadata and base64 content.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentDownloadResponse"}},"schemaId":"components/schemas/AttachmentDownloadResponse"},{"code":"401","description":"Authentication failed."}],"pointer":"/paths/~1AttachmentDownload/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AttachmentDownloadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentDownloadResponse"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-downloads/attachmentdownloadpost"}],"panels":[]}]},"httpPath":"/AttachmentDownload"},{"label":"Download attachments by ID using query parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadget","metadata":{"seo":{"title":"Download attachments by ID using query parameters","description":"Download attachments by ID using query parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachmentDownloadGet","name":"Download attachments by ID using query parameters","isWebhook":false,"pointer":"/paths/~1AttachmentDownload/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download attachments by ID using query parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"UniqueIds","in":"query","style":"form","explode":true,"schemaId":"schema_27","required":true}],"pointer":"/paths/~1AttachmentDownload/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/AttachmentDownload","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"UniqueIds","in":"query","required":true,"schemaId":"schema_27","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/AttachmentDownload","href":"shared-downloads/attachmentdownloadget","openApiOperationId":"attachmentDownloadGet","summary":"Download attachments by ID using query parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment metadata and base64 content.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentDownloadResponse"}},"schemaId":"components/schemas/AttachmentDownloadResponse"},{"code":"401","description":"Authentication failed."}],"pointer":"/paths/~1AttachmentDownload/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AttachmentDownloadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentDownloadResponse"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-downloads/attachmentdownloadget"}],"panels":[]}]},"httpPath":"/AttachmentDownload"},{"label":"Download affidavit PDFs by ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadpost","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadpost","metadata":{"seo":{"title":"Download affidavit PDFs by ID","description":"Packages the requested affidavit PDFs in a ZIP archive. All requested affidavits must exist and be owned by the authenticated user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"affidavitsDownloadPost","name":"Download affidavit PDFs by ID","isWebhook":false,"pointer":"/paths/~1AffidavitsDownload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download affidavit PDFs by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Packages the requested affidavit PDFs in a ZIP archive. All requested affidavits must exist and be owned by the authenticated user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AffidavitUniqueIdsRequest"}},"schemaId":"components/schemas/AffidavitUniqueIdsRequest","pointer":"/paths/~1AffidavitsDownload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/AffidavitsDownload","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AffidavitUniqueIdsRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/AffidavitsDownload","href":"shared-downloads/affidavitsdownloadpost","openApiOperationId":"affidavitsDownloadPost","summary":"Download affidavit PDFs by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"schemaId":"components/schemas/AffidavitUniqueIdsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AffidavitUniqueIdsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ZIP archive containing the requested affidavit PDFs.","mediaType":"application/zip","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}},"schemaId":"schema_6","headers":{"Content-Disposition":{"description":"Suggested archive filename.","schema":{"type":"string","example":"attachment;filename=\"affidavits.zip\""}}},"headerSchemaId":"schema_39"},{"code":"400","description":"The identifier list is missing or exceeds the configured limit."},{"code":"401","description":"Authentication failed."},{"code":"403","description":"The account lacks the required API permission, or one or more requested affidavits are not owned by the authenticated user."},{"code":"404","description":"One or more requested affidavit IDs were not found."}],"pointer":"/paths/~1AffidavitsDownload/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-downloads/affidavitsdownloadpost"}],"panels":[]}]},"httpPath":"/AffidavitsDownload"},{"label":"Download affidavit PDFs by ID using query parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadget","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadget","metadata":{"seo":{"title":"Download affidavit PDFs by ID using query parameters","description":"Packages the requested affidavit PDFs in a ZIP archive. Repeat the UniqueIds query parameter for multiple IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"affidavitsDownloadGet","name":"Download affidavit PDFs by ID using query parameters","isWebhook":false,"pointer":"/paths/~1AffidavitsDownload/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download affidavit PDFs by ID using query parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Packages the requested affidavit PDFs in a ZIP archive. Repeat the UniqueIds query parameter for multiple IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"UniqueIds","in":"query","style":"form","explode":true,"schemaId":"schema_27","description":"Affidavit UUIDs to include. Duplicate values are invalid and should not be retried unchanged.","required":true}],"pointer":"/paths/~1AffidavitsDownload/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/AffidavitsDownload","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"UniqueIds","in":"query","required":true,"schemaId":"schema_27","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/AffidavitsDownload","href":"shared-downloads/affidavitsdownloadget","openApiOperationId":"affidavitsDownloadGet","summary":"Download affidavit PDFs by ID using query parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ZIP archive containing the requested affidavit PDFs.","mediaType":"application/zip","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}},"schemaId":"schema_6","headers":{"Content-Disposition":{"description":"Suggested archive filename.","schema":{"type":"string","example":"attachment;filename=\"affidavits.zip\""}}},"headerSchemaId":"schema_39"},{"code":"400","description":"The identifier list is missing or exceeds the configured limit."},{"code":"401","description":"Authentication failed."},{"code":"403","description":"The account lacks the required API permission, or one or more requested affidavits are not owned by the authenticated user."},{"code":"404","description":"One or more requested affidavit IDs were not found."}],"pointer":"/paths/~1AffidavitsDownload/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_6"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-downloads/affidavitsdownloadget"}],"panels":[]}]},"httpPath":"/AffidavitsDownload"},{"label":"Check an affidavit archive request","deprecated":false,"httpVerb":"head","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadhead","routeSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadhead","metadata":{"seo":{"title":"Check an affidavit archive request","description":"Accepts the same affidavit identifiers as GET and returns the response headers without transferring the archive body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"affidavitsDownloadHead","name":"Check an affidavit archive request","isWebhook":false,"pointer":"/paths/~1AffidavitsDownload/head","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check an affidavit archive request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accepts the same affidavit identifiers as GET and returns the response headers without transferring the archive body."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"UniqueIds","in":"query","style":"form","explode":true,"schemaId":"schema_27","description":"Affidavit UUIDs to include. Duplicate values are invalid and should not be retried unchanged.","required":true}],"pointer":"/paths/~1AffidavitsDownload/head/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"HEAD","path":"/AffidavitsDownload","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"UniqueIds","in":"query","required":true,"schemaId":"schema_27","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/AffidavitsDownload","href":"shared-downloads/affidavitsdownloadhead","openApiOperationId":"affidavitsDownloadHead","summary":"Check an affidavit archive request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The affidavit archive request is valid.","headers":{"Content-Disposition":{"description":"Suggested archive filename.","schema":{"type":"string","example":"attachment;filename=\"affidavits.zip\""}}},"headerSchemaId":"schema_39"},{"code":"400","description":"The identifier list is missing or exceeds the configured limit."},{"code":"401","description":"Authentication failed."},{"code":"403","description":"The account lacks the required API permission, or one or more requested affidavits are not owned by the authenticated user."},{"code":"404","description":"One or more requested affidavit IDs were not found."}],"pointer":"/paths/~1AffidavitsDownload/head/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-downloads/affidavitsdownloadhead"}],"panels":[]}]},"httpPath":"/AffidavitsDownload"}],"content":{"contentType":"group","meta":{"name":"Shared Downloads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shared Downloads","showPageActions":true},{"nodeType":"markdoc","content":"Shared affidavit and attachment download endpoints."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/AttachmentDownload","summary":"Download attachments by ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shared-downloads/attachmentdownloadpost","deprecated":false},{"title":"/AttachmentDownload","summary":"Download attachments by ID using query parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shared-downloads/attachmentdownloadget","deprecated":false},{"title":"/AffidavitsDownload","summary":"Download affidavit PDFs by ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/shared-downloads/affidavitsdownloadpost","deprecated":false},{"title":"/AffidavitsDownload","summary":"Download affidavit PDFs by ID using query parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/shared-downloads/affidavitsdownloadget","deprecated":false},{"title":"/AffidavitsDownload","summary":"Check an affidavit archive request","prefix":{"name":"head","color":"head"},"badges":[],"link":"/shared-downloads/affidavitsdownloadhead","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/EviNoticeAttachment":{"id":"components/schemas/EviNoticeAttachment","kind":"json-schema","title":"EviNoticeAttachment","data":{"type":"object","required":["Data"],"properties":{"Data":{"type":"string","format":"byte","description":"Base64-encoded content of the file. Each decoded file must be smaller than 8 MiB (8,388,608 bytes); the combined decoded file size must be at most 25 MiB (26,214,400 bytes) for Submit. The complete encoded JSON request must also fit the API host request-size limit and can be rejected before attachment validation.\n"},"Filename":{"type":"string","description":"Optional file name including extension. Supply Filename when MimeType is omitted so the platform can derive the MIME type. Data is required.\n"},"DisplayName":{"type":"string","description":"A human-readable label shown to the recipient instead of the raw file name."},"MimeType":{"type":"string","description":"The MIME type of the file, for example application/pdf. Supply it or a Filename from which the MIME type can be derived.\n"},"ContentId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Content-ID that can be referenced with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cid:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Body HTML to embed the attachment inline."},"children":[]}]}]}]},"ContentEncoding":{"type":"string","description":"Optional character set of a text attachment, for example utf-8. This does not describe Data, which is always base64 in JSON. An unknown character set returns 400.\n"},"ContentDescription":{"type":"string","description":"Optional human-readable description of the attachment."},"ContentDisposition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Content-Disposition of the attachment (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"ContentLocation":{"type":"string","description":"The Content-Location header value for the attachment."},"IncludeOnAffidavits":{"type":"boolean","description":"Whether this attachment is referenced in generated affidavits. Only for PDF attachments (PDF 1.7 or earlier) and only when AffidavitKinds is set; otherwise the request returns 400.\n"}}}},"components/schemas/EviNoticeReminders":{"id":"components/schemas/EviNoticeReminders","kind":"json-schema","title":"EviNoticeReminders","data":{"type":"object","description":"Reminders re-send the notification email while the notice remains open. Only email RecipientAddress values are supported; a mobile recipient returns 400. Reading or deciding stops reminders only when it closes the notice; with a pending commitment choice or EnforceTrackingUntilTimeToLive the notice stays open and reminders continue.","required":["Initial","Repeat","Days","TimeRange","Stop","TimeZone","Max"],"properties":{"Initial":{"type":"string","description":"ISO 8601 duration after submission before the first reminder (for example P2D). Must not exceed TimeToLive. The first reminder ignores Days, TimeRange and Stop; keep Initial before Stop.\n","example":"P2D"},"Repeat":{"type":"string","description":"Use a whole-day ISO 8601 interval, for example P1D. Later reminders use the first allowed day/time window on or after the start of the day reached by adding this interval, in TimeZone; this is not an exact elapsed-time interval. Sub-day values are not supported in practice: the next reminder can be scheduled immediately, or in the next allowed window of the same day.\n","example":"P1D"},"Days":{"type":"array","description":"Allowed days from the second reminder onward. Do not repeat a day.\n","items":{"type":"string","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]},"example":["Monday","Tuesday","Wednesday","Thursday","Friday"]},"TimeRange":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed windows from the second reminder onward: FROM08TO10, FROM10TO12, FROM12TO15, FROM15TO19, FROM19TO22 (19:00–22:00). Do not repeat a window."},"children":[]}]}]}],"items":{"type":"string","enum":["FROM08TO10","FROM10TO12","FROM12TO15","FROM15TO19","FROM19TO22"]},"example":["FROM08TO10","FROM10TO12","FROM12TO15","FROM15TO19"]},"Max":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required, at least 1. For a TTL containing 1 whole day, at most 3; for 2–20 whole days, at most that number of days; above 20 days, at most 20. A TTL shorter than one day has no additional TTL-based cap."},"children":[]}]}]}],"minimum":1,"example":5},"Stop":{"type":"string","description":"ISO 8601 duration from submission; later reminders at or after this point are not scheduled. It does not restrict the first reminder; keep Initial before Stop.\n","example":"P15D"},"TimeZone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of Etc/GMT-14 through Etc/GMT+11; Etc/GMT0 is UTC. Region names such as Europe/Madrid return 400. The sign is inverted: Etc/GMT-1 means UTC+1."},"children":[]}]}]}],"example":"Etc/GMT-1"}}}},"components/schemas/EviNoticeSubmitRequest":{"id":"components/schemas/EviNoticeSubmitRequest","kind":"json-schema","title":"EviNoticeSubmitRequest","data":{"type":"object","required":["Subject","Body","RecipientAddress"],"properties":{"Subject":{"type":"string","description":"The subject line of the certified notice."},"Body":{"type":"string","description":"The HTML or plain-text body of the hosted notice."},"RecipientAddress":{"type":"string","description":"Recipient's email address or mobile phone number in E.164 format. The delivery notification is sent to this address."},"RecipientDisplayName":{"type":"string","description":"The display name shown to the recipient in the delivery notification."},"RecipientLegalName":{"type":"string","description":"The legal name of the recipient, recorded in the certification evidence."},"IssuerLegalName":{"type":"string","description":"The legal name of the sending organisation, recorded in the certification evidence."},"From":{"type":"string","description":"Override the sender address shown in the delivery notification email."},"ReplyTo":{"type":"string","description":"Reply-to address for the delivery notification email."},"LookupKey":{"type":"string","description":"An arbitrary key assigned by the integrator to correlate this notice with records in your own system."},"CustomLayoutLogoUrl":{"type":"string","format":"uri","description":"URL of a custom logo to display in the hosted notice layout."},"TimeToLive":{"type":"integer","minimum":60,"maximum":86400,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time in minutes during which the platform will attempt delivery and keep the notice accessible to the recipient. Range: 60–86,400 (1 hour to 60 days). When omitted, the platform's configured TTL default applies, independently of the site or user WebUI send-form default."},"children":[]}]}]}],"example":10080},"Attachments":{"type":"array","description":"Files to include in the hosted notice. This Submit endpoint accepts at most 14 attachments. Each decoded file must be smaller than 8 MiB (8,388,608 bytes); the combined decoded file size must be at most 25 MiB (26,214,400 bytes). The complete base64-encoded JSON request must also fit the API host request-size limit; a request approaching the decoded-file limit can be rejected before attachment validation.\n","maxItems":14,"items":{"$ref":"#/components/schemas/EviNoticeAttachment"}},"CertificationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The legal framework and geographic variant for certification. Supported values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QERDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and their regional variants. Availability depends on the account."},"children":[]}]}]}],"enum":["Standard","Advanced","QERDS","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE","QERDS_ES","QERDS_IT"],"example":"Advanced_EU"},"QERDSEnrollmentAllowed":{"type":"boolean","description":"Allow a recipient without a matching verified identity to enroll before accessing the notice content. Omitting this field does not enable enrollment. When true, a site-configured QERDSEnrollmentProfile is required. Qualified recipient identification remains required when enrollment is disabled.\n"},"QERDSEnrollmentProfile":{"type":"string","description":"The site-configured QeRDS enrollment profile. Required when QERDSEnrollmentAllowed is true. Any supplied non-empty profile must match a profile configured on the site, including when enrollment is disabled. This is distinct from QERDSIdentityTenant.\n"},"RecipientLegalIdRequired":{"type":"boolean","description":"Require recipient legal-ID verification before accessing the notice. Must be true for qualified EviNotice certification levels."},"RecipientLegalIdKind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal-document kind recognized by the service and suitable for the configured identity flow. Supply together with RecipientLegalIdValue; both are required for QERDS_IT and the pair must validate. For QERDS_ES, supply both or omit both. Accepted kinds depend on the target service version and identity configuration; example codes are not an exhaustive list."},"children":[]}]}]}],"example":"TIN:IT"},"RecipientLegalIdValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A pre-filled legal ID value for the recipient, up to 50 characters. Send it together with RecipientLegalIdKind. Required with RecipientLegalIdKind for QERDS_IT and must be valid for the selected kind."},"children":[]}]}]}]},"AffidavitKinds":{"type":"array","description":"Selects affidavit kinds to generate when the corresponding events occur. Failure before processing completes closes the notice without generating affidavits. Later transmission or delivery failures can be certified by TransmissionResult or DeliveryResult when requested. Failed is accepted by the request contract but does not generate a separate Failed affidavit. For qualified notices, include both SubmittedAdvanced and Read, or include CompleteAdvanced. Other kinds may be added; Submitted alone does not satisfy the qualified requirement.\n","items":{"type":"string","enum":["Submitted","SubmittedAdvanced","Dispatched","TransmissionResult","DeliveryResult","Received","Read","Committed","CommittedAdvanced","Refused","Closed","ClosedAdvanced","Event","Complete","CompleteAdvanced","OnDemand","ContentDownload","Failed"]}},"EvidenceAccessControlMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how recipients access the evidence record once the recipient has accepted or rejected the notice, or it has closed. Public allows anyone with the link; Challenge asks your question, and AutoChallenge asks for the recipient address. DeliverySignMethod separately protects first access. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutoChallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unlike EviMail and EviSMS, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not supported for EviNotice. For qualified notices, set Public explicitly; the configured global default used when this field is omitted may not satisfy that rule. This evidence-access setting does not replace qualified recipient identification."},"children":[]}]}]}],"enum":["AutoChallenge","Public","Challenge"]},"EvidenceAccessControlChallenge":{"type":"string","description":"The challenge question shown to the visitor. Required only with EvidenceAccessControlMethod Challenge; rejected with other methods.\n"},"EvidenceAccessControlChallengeResponse":{"type":"string","description":"The expected answer to EvidenceAccessControlChallenge. Required only with EvidenceAccessControlMethod Challenge; rejected with other methods.\n"},"NotificationChannels":{"type":"array","description":"Email recipients accept only Email. Mobile recipients can list up to three of SMS, WhatsApp and RCS without repeats; channels are tried in order, moving to the next only after failure. WhatsApp requires service and site enablement; RCS requires site enablement.\n","items":{"type":"string","enum":["SMS","WhatsApp","RCS","Email"]}},"DeliverySignMethod":{"type":"string","description":"Controls how the recipient authenticates to access the hosted notice.","enum":["WebClick","Challenge","MobilePin","EmailPin"]},"DeliverySignChallenge":{"type":"string","description":"The challenge question shown to the recipient when DeliverySignMethod is Challenge."},"DeliverySignChallengeResponse":{"type":"string","description":"The expected answer to the challenge question."},"DeliverySignFixedMobile":{"type":"string","description":"The fixed mobile number used to send the PIN when DeliverySignMethod is MobilePin.","example":"+34600000000"},"DeliverySignFixedEmail":{"type":"string","description":"The fixed email address used to send the PIN when DeliverySignMethod is EmailPin."},"MobilePinChannels":{"type":"array","description":"Ordered list of three PIN channel groups. Each element lists the channels offered for one PIN send; channels are not used in parallel. Only valid with DeliverySignMethod MobilePin. After null or empty groups are discarded, supply exactly three non-empty groups without repeated channels within a group. Supported channels: SMS, WhatsApp, RCS. WhatsApp requires service and site enablement; RCS requires site enablement. With an explicit MobilePin method and this field omitted, the default is three SMS attempt groups. NotificationChannels separately routes the notice alert.\n","items":{"type":"array","items":{"type":"string","enum":["SMS","WhatsApp","RCS"]}},"example":[["SMS"],["SMS"],["SMS"]]},"CommitmentChoice":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls whether the recipient can accept or reject the notice. EviMail exposes the same behaviour through a field named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CommitmentOptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Disabled","Accept","Reject","AcceptOrReject"]},"CommitmentCommentsAllowed":{"type":"boolean","description":"Allow the recipient to add a free-text comment when committing. For qualified notices, keep disabled with CommitmentChoice Accept or AcceptOrReject. Use CommitmentChoice Reject when collecting recipient comments or rejection reasons.\n"},"RejectReasons":{"type":"array","description":"Predefined rejection reasons the recipient can select from. Requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Accept. Up to 20 reasons, each at most 150 characters, without HTML. Otherwise Submit returns 400.\n","items":{"type":"string"}},"RequireRejectReason":{"type":"boolean","description":"Require the recipient to select or enter a rejection reason before rejecting. When true, requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Accept; otherwise Submit returns 400.\n"},"AcceptReasons":{"type":"array","description":"Predefined acceptance reasons the recipient can select from. Requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Reject. Up to 20 reasons, each at most 150 characters, without HTML. Otherwise Submit returns 400. Do not configure for qualified acceptance, where recipient comments and acceptance reasons are unavailable.\n","items":{"type":"string"}},"RequireAcceptReason":{"type":"boolean","description":"Require the recipient to select or enter an acceptance reason before accepting. When true, requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Reject; otherwise Submit returns 400. Keep false or omitted for qualified acceptance, where acceptance reasons are unavailable.\n"},"PushNotificationFilter":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply PushNotificationUrl and PushNotificationFilter together; PushNotificationExtraData is allowed only with both (up to 1,024 characters). Otherwise Submit returns 400. State transitions that trigger a push notification callback to PushNotificationUrl. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitPublished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a platform meta-event that fires when affidavit generation completes — it is not a lifecycle state."},"children":[]}]}]}],"items":{"type":"string","enum":["Processed","Sent","Dispatched","Delivered","Received","Read","Replied","Failed","Closed","AffidavitPublished"]}},"PushNotificationUrl":{"type":"string","format":"uri","description":"The URL that receives push notification callbacks when a state in PushNotificationFilter is reached. Supply PushNotificationUrl and PushNotificationFilter together; PushNotificationExtraData is allowed only with both (up to 1,024 characters). Otherwise Submit returns 400. HTTP and HTTPS are accepted; use HTTPS because HTTP omits Comments on Replied and XmissionDetails on Sent."},"PushNotificationExtraData":{"type":"string","description":"Arbitrary string passed back verbatim in each push notification payload. Supply PushNotificationUrl and PushNotificationFilter together; PushNotificationExtraData is allowed only with both (up to 1,024 characters). Otherwise Submit returns 400."},"Language":{"enum":["ca","de","el","en","es","fr","it","pt","pt-BR","ro"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BCP 47 language tag controlling the language of the hosted notice UI (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"it"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Defaults to en when omitted; does not inherit the site language configured for the WebUI."},"children":[]}]}]}],"default":"en","example":"en"},"AffidavitLanguage":{"enum":["ca","de","el","en","es","fr","it","pt","pt-BR","ro"],"type":"string","description":"BCP 47 language tag controlling the language of generated affidavit documents. Defaults to en when omitted; does not inherit the site language configured for the WebUI.","default":"en","example":"en"},"NotificationLayout":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visual layout of the hosted notice page. EviMail exposes the same concept through a field named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DeliveryAppearance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["Certified","AsIs"]},"LandingPageInfoText":{"type":"string","description":"Additional text shown on the landing page before the recipient opens the content. Maximum 8,192 characters.\n"},"NotificationTemplate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of an enabled EviNotice:Email:Notification template for email recipients, or of an enabled EviNotice:Sms:Notification template for mobile recipients whose NotificationChannels include SMS. Not used for RCS/WhatsApp-only notifications. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/it/products/namirialnotify/dev/templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using communication templates from the API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"NotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs supplying values for the user variables declared in NotificationTemplate."},"OwnerNotificationTemplate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of an enabled custom template used for the issuer's status notification email. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/it/products/namirialnotify/dev/templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using communication templates from the API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OwnerNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate."},"CommitmentChoiceButtonText":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom action-button label. Up to 15 unaccented letters (A–Z, a–z) or digits; no spaces or punctuation."},"children":[]}]}]}]},"CommitmentChoiceButtonOnly":{"type":"boolean","description":"Only with CommitmentChoice Accept or Reject; otherwise 400. Shows a single action button with CommitmentChoiceButtonText or the default Finish label instead of the standard Accept/Reject label. It does not hide the comment field.\n"},"QERDSIdentityTenant":{"type":"string","description":"Optional identity context used for recipient identity lookup and in-notice enrollment. When supplied, it must exactly match a tenant configured on the site for the selected certification variant. The context is also recorded with QeRDS service-terms acceptance. Obtain the value during provisioning; this is distinct from QERDSEnrollmentProfile.\n"},"CostCentre":{"type":"string","description":"An arbitrary cost-centre label recorded with the transaction for internal billing allocation."},"EnforceTrackingUntilTimeToLive":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the platform keeps tracking recipient attachment downloads until TimeToLive elapses. This must be enabled together with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContentDownload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" affidavit kind — enabling one without the other returns a validation error."},"children":[]}]}]}]},"DisableSenderHeader":{"type":"boolean","description":"When true, the Sender header is removed from the recipient notification email."},"DisablePlatformReferences":{"type":"boolean","description":"When true, internal platform references are suppressed in the generated affidavits."},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the evidence for this transaction is stored in Namirial Archive during post-close processing after tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnlineRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separately controls online accessibility."},"children":[]}]}]}]},"AllowRefusal":{"type":"boolean","description":"When true, the recipient can explicitly refuse the notice before reading it (records a Refused outcome)."},"OnlineRetentionPeriod":{"minimum":1,"maximum":20,"type":"integer","description":"Online custody period in years: 1 to 20 years; with by-submission billing your voucher tier can impose a lower maximum.\n"},"NotaryRetention":{"type":"boolean","description":"When true, the evidence is placed under notarial deposit. Requires NotaryProfile to be set."},"NotaryProfile":{"type":"string","description":"The notary profile identifier to use for notarial deposit. Required when NotaryRetention is true."},"Reminders":{"$ref":"#/components/schemas/EviNoticeReminders"}}}},"components/schemas/EviNoticeSubmitResponse":{"id":"components/schemas/EviNoticeSubmitResponse","kind":"json-schema","title":"EviNoticeSubmitResponse","data":{"type":"object","properties":{"Id":{"type":"string","format":"uuid","description":"The unique identifier of the submitted EviNotice. Use this to retrieve status and download evidence."}}}},"components/schemas/EviNoticeProblem":{"id":"components/schemas/EviNoticeProblem","kind":"json-schema","title":"EviNoticeProblem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7807 Problem+JSON error response."},"children":[]}]}]}],"properties":{"Status":{"type":"integer","description":"HTTP status code."},"Type":{"type":"string","format":"uri","description":"URI identifying the problem type."},"Title":{"type":"string","description":"Short, human-readable summary of the problem type."},"Detail":{"type":"string","description":"Human-readable explanation specific to this occurrence."},"Instance":{"type":"string","description":"URI reference identifying the specific occurrence of the problem. May be absent."},"RequestId":{"type":"string","format":"uuid","description":"Unique identifier for this request, useful for support and diagnostics."},"InvalidValues":{"type":"array","description":"Field-level validation errors. Present on 400 validation failures.","items":{"type":"object","additionalProperties":true}}}}},"components/schemas/EviNoticeSummary":{"id":"components/schemas/EviNoticeSummary","kind":"json-schema","title":"EviNoticeSummary","data":{"type":"object","description":"Summary of an EviNotice, returned in Query results and as the base of the Get response.","properties":{"Id":{"type":"string","format":"uuid","description":"Unique identifier of the EviNotice."},"LinkedId":{"type":"string","description":"ID of a related EviNotice, if applicable."},"Subject":{"type":"string","description":"Subject of the certified notice."},"LookupKey":{"type":"string","description":"The integrator-assigned lookup key."},"Issuer":{"type":"string","description":"Legal name of the issuing organisation."},"IssuerEmail":{"type":"string","description":"Email address of the issuer account."},"IssuerPhone":{"type":"string","description":"Phone number of the issuer account, if set."},"RecipientAddress":{"type":"string","description":"Email address or mobile number of the recipient.\n"},"RecipientDisplayName":{"type":"string","description":"Display name of the recipient."},"RecipientLegalName":{"type":"string","description":"Legal name of the recipient."},"State":{"type":"string","description":"Current step in the notice lifecycle. Closed is the only terminal state.","enum":["Draft","Submitted","Processed","Sent","Dispatched","Delivered","Received","Read","Replied","Closed","Failed"]},"Outcome":{"type":"string","description":"None while open. At Closed, the first recorded milestone in this order determines the final outcome: Failed, Rejected, Accepted, Refused, Read, Received, Delivered, Sent, Certified. Received records access to the hosted notice link. Read records opening the hosted content. Cancelled is a compatibility value in the response enum and is not produced by current closure logic.\n","enum":["None","Certified","Sent","Delivered","Received","Read","Accepted","Rejected","Failed","Cancelled","Refused"]},"CreationDate":{"type":"string","format":"date-time"},"LastUpdateDate":{"type":"string","format":"date-time"},"SubmittedOn":{"type":"string","format":"date-time","description":"Timestamp when the submission was accepted by the platform."},"ProcessedOn":{"type":"string","format":"date-time","description":"Timestamp recorded for the Processed milestone. It is populated after initial processing and content certification succeed, but its value is the admission time recorded at submission, so it normally equals SubmittedOn and does not measure processing duration."},"SentOn":{"type":"string","format":"date-time","description":"Event time reported by the successful notification sending result. For email, this is transmission to the recipient's mail system; for mobile channels, successful transmission reported by the sending channel. This does not certify that the hosted notice was read. Do not infer callback arrival order or require strict numerical timestamp ordering from the logical lifecycle sequence."},"DispatchedOn":{"type":"string","format":"date-time","description":"Timestamp when the platform, after its initial checks, accepted responsibility for the communication and issued the notification send request to its sending process. It does not confirm successful transmission to the remote system. Dispatch logically precedes the sending result; equal or strictly ordered timestamp values and callback arrival order are not guaranteed."},"DeliveredOn":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email: timestamp when delivery to the recipient's mail system was confirmed — best-effort, may be absent even when the message was delivered. Mobile channels: operator delivery confirmation."},"children":[]}]}]}]},"ReadOn":{"type":"string","format":"date-time","description":"Timestamp when the recipient accessed the protected content on the platform."},"RepliedOn":{"type":"string","format":"date-time"},"ExpiredOn":{"type":"string","description":"Time the notice closed, whatever the reason (including expiry, decision, refusal or failure); not only TimeToLive expiry.\n","format":"date-time"},"AcceptedOn":{"type":"string","format":"date-time"},"RejectedOn":{"type":"string","format":"date-time"},"FailedOn":{"type":"string","format":"date-time"},"RefusedOn":{"type":"string","format":"date-time"},"ArchivedOn":{"type":"string","format":"date-time"},"TimeToLive":{"type":"integer","description":"The TimeToLive value (in minutes) that was set at submission."},"AllowRefusal":{"type":"boolean","description":"Whether the recipient was allowed to refuse the notice without opening it."},"NotaryProfile":{"type":"string","description":"The notary certification profile applied."},"SourceChannel":{"type":"string","description":"The channel through which the notice was submitted (e.g. API, portal)."},"OnlineRetentionPeriod":{"type":"integer","description":"Number of years the notice and its evidence remain accessible online."},"NotaryRetention":{"type":"boolean","description":"Whether the evidence is retained by a notary for long-term legal storage."},"ReceivedOn":{"type":"string","format":"date-time","description":"Timestamp when the recipient opened the access link and reached the delivery page on the platform."},"From":{"type":"string","description":"From address used in the delivery notification email."},"CostCentre":{"type":"string","description":"Cost-centre label recorded with the transaction for internal billing allocation."},"CommitmentComments":{"type":"string","description":"Free-text comment provided by the recipient when accepting or rejecting the notice."},"AffidavitKinds":{"type":"array","description":"The affidavit event types configured at submission.","items":{"type":"string"}},"Reminders":{"allOf":[{"$ref":"#/components/schemas/EviNoticeReminders"}],"description":"Reminder configuration as set at submission. Absent when no reminders were configured."},"NotificationChannels":{"type":"array","description":"Channels used to deliver the notification to the recipient.","items":{"type":"string","enum":["SMS","WhatsApp","RCS","Email"]}},"MobilePinChannels":{"type":"array","description":"PIN channel groups configured at submission. Each element lists channels offered for one PIN send, not parallel sends. The first PIN, sent when the recipient requests it, uses the first channel of the first group; no channel choice is offered. On a resend, the recipient chooses one channel from the next group (no choice is shown when that group has a single channel); after the third send, the last group is reused.\n","items":{"type":"array","items":{"type":"string","enum":["SMS","WhatsApp","RCS"]}}}}}},"components/schemas/EviNoticeAffidavitInfo":{"id":"components/schemas/EviNoticeAffidavitInfo","kind":"json-schema","title":"EviNoticeAffidavitInfo","data":{"type":"object","description":"Metadata for a single generated affidavit.","properties":{"Id":{"type":"string","description":"Unique identifier of the affidavit."},"Kind":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affidavit response identifier, for example EviNotice:Submitted or EviNotice:Delivery:Result; Legacy when no kind identifier is recorded. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/it/products/namirialnotify/user-guides/evidences-affidavits#evinotice-affidavit-identifiers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifier mapping"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Description":{"type":"string","description":"Human-readable description of the affidavit."},"CreationDate":{"type":"string","format":"date-time","description":"Timestamp when the affidavit was generated."},"Length":{"type":"integer","description":"Size of the affidavit file in bytes."}}}},"components/schemas/EviNoticeAttachmentInfo":{"id":"components/schemas/EviNoticeAttachmentInfo","kind":"json-schema","title":"EviNoticeAttachmentInfo","data":{"type":"object","description":"Metadata for a single attachment associated with an EviNotice.","properties":{"Id":{"type":"string","description":"Unique identifier of the attachment."},"Filename":{"type":"string","description":"File name including extension."},"MimeType":{"type":"string","description":"MIME type of the attachment."},"Length":{"type":"integer","description":"Size of the attachment in bytes."},"Hash":{"type":"string","description":"Cryptographic hash of the attachment content, used for integrity verification."},"IncludeOnAffidavits":{"type":"boolean","description":"Whether this attachment is referenced in generated affidavits."}}}},"components/schemas/EviNoticeGetResponse":{"id":"components/schemas/EviNoticeGetResponse","kind":"json-schema","title":"EviNoticeGetResponse","data":{"allOf":[{"$ref":"#/components/schemas/EviNoticeSummary"},{"type":"object","properties":{"SiteName":{"type":"string","description":"Name of the Namirial Notify site under which this notice was submitted."},"XmissionResult":{"type":"boolean","nullable":true,"description":"Whether the delivery notification email or SMS was successfully transmitted."},"XmissionSummary":{"type":"string","description":"Human-readable summary of the transmission result (e.g. bounce or SMTP reply code)."},"CustomLayoutLogoUrl":{"type":"string","format":"uri","description":"Custom logo URL that was configured at submission."},"Affidavits":{"type":"array","description":"Metadata for each generated affidavit. Present when IncludeAffidavits is true.","items":{"$ref":"#/components/schemas/EviNoticeAffidavitInfo"}},"Attachments":{"type":"array","description":"Metadata for each attachment. Present when IncludeAttachments is true.","items":{"$ref":"#/components/schemas/EviNoticeAttachmentInfo"}}}}]}},"components/schemas/EviNoticeQueryRequest":{"id":"components/schemas/EviNoticeQueryRequest","kind":"json-schema","title":"EviNoticeQueryRequest","data":{"type":"object","description":"Filters and pagination controls for querying EviNotices. All fields are optional.","properties":{"Limit":{"type":"integer","minimum":1,"maximum":100,"default":100,"description":"Maximum number of results to return per page."},"Owner":{"type":"string","format":"email","description":"Without Owner, site-level users see their site and other users only their own notices. Owner filtering is allowed only for site-level users (403 otherwise), and must be a valid email (400 otherwise). Drafts are excluded.\n"},"LookupKeys":{"type":"array","description":"Filter by one or more integrator-assigned lookup keys.","items":{"type":"string"}},"LinkedId":{"type":"string","format":"uuid","description":"Filter by linked ID."},"State":{"type":"string","description":"Filter by current notice state. Use Closed to select notices with a final outcome.","enum":["Draft","Submitted","Processed","Sent","Dispatched","Delivered","Received","Read","Replied","Closed","Failed"]},"Outcome":{"type":"string","description":"Filter by outcome. None selects open notices. Received selects closed notices whose final outcome records link access.","enum":["None","Certified","Sent","Delivered","Received","Read","Accepted","Rejected","Failed","Refused"]},"Cursor":{"type":"string","description":"Opaque pagination cursor returned in the previous response. Pass this value to retrieve the next page."}}}},"components/schemas/EviNoticeQueryResponse":{"id":"components/schemas/EviNoticeQueryResponse","kind":"json-schema","title":"EviNoticeQueryResponse","data":{"type":"object","description":"Paginated list of EviNotices matching the query filters.","properties":{"Cursor":{"type":"string","description":"Returned whenever the page contains results, including the final non-empty page. Continue until the response has no results; that empty response has no Cursor.\n"},"Results":{"type":"array","description":"The list of EviNotice summaries matching the query.","items":{"$ref":"#/components/schemas/EviNoticeSummary"}}}}},"components/schemas/EviNoticeAffidavitRequestBody":{"id":"components/schemas/EviNoticeAffidavitRequestBody","kind":"json-schema","title":"EviNoticeAffidavitRequestBody","data":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","format":"uuid","description":"The unique ID of the EviNotice, as returned at submission."},"IncludeBody":{"type":"boolean","description":"Include the notice body in the affidavit."},"IncludeAttachments":{"type":"boolean","description":"Include notice attachments in the affidavit. Attachments must have been submitted with IncludeOnAffidavits set to true."},"IncludeEvents":{"type":"boolean","description":"Include detailed event information in the affidavit."}}}},"components/schemas/EviNoticeAffidavitRequestResponse":{"id":"components/schemas/EviNoticeAffidavitRequestResponse","kind":"json-schema","title":"EviNoticeAffidavitRequestResponse","data":{"type":"object","properties":{"RequestId":{"type":"string","format":"uuid","description":"Unique identifier for this affidavit request. Use it to correlate the subsequent AffidavitPublished callback."}}}},"components/schemas/EviNoticeBatchSummary":{"id":"components/schemas/EviNoticeBatchSummary","kind":"json-schema","title":"EviNoticeBatchSummary","data":{"type":"object","description":"Summary of a notice batch, returned in batch query results.","properties":{"Id":{"type":"string","format":"uuid"},"State":{"type":"string","enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]},"Submitter":{"type":"string"},"SubmitterId":{"type":"string"},"SiteId":{"type":"string","format":"uuid"},"SiteName":{"type":"string"},"Description":{"type":"string"},"CreationDate":{"type":"string","format":"date-time"},"ScheduledFor":{"type":"string","format":"date-time","description":"Scheduled execution date and time in UTC."},"StartedOn":{"type":"string","format":"date-time"},"ProcessedOn":{"type":"string","format":"date-time"},"LastUpdated":{"type":"string","format":"date-time"},"TotalCount":{"type":"integer"},"TotalSent":{"type":"integer"},"TotalFailed":{"type":"integer"}}}},"components/schemas/EviNoticeBatchesQueryResponse":{"id":"components/schemas/EviNoticeBatchesQueryResponse","kind":"json-schema","title":"EviNoticeBatchesQueryResponse","data":{"type":"object","properties":{"Cursor":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque cursor for the next page. Pass it back as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve more results."},"children":[]}]}]}]},"HasMoreResults":{"type":"boolean"},"Results":{"type":"array","items":{"$ref":"#/components/schemas/EviNoticeBatchSummary"}}}}},"components/schemas/EviNoticeBatchCreateRequest":{"id":"components/schemas/EviNoticeBatchCreateRequest","kind":"json-schema","title":"EviNoticeBatchCreateRequest","data":{"type":"object","required":["Description"],"properties":{"Description":{"type":"string","maxLength":255,"description":"Human-readable description of the batch."}}}},"components/schemas/EviNoticeBatchCreateResponse":{"id":"components/schemas/EviNoticeBatchCreateResponse","kind":"json-schema","title":"EviNoticeBatchCreateResponse","data":{"type":"object","properties":{"BatchId":{"type":"string","format":"uuid","description":"Unique identifier of the created batch. Use it in all other batch operations."}}}},"components/schemas/EviNoticeAffidavitKindValue":{"id":"components/schemas/EviNoticeAffidavitKindValue","kind":"json-schema","title":"EviNoticeAffidavitKindValue","data":{"type":"string","description":"Contract values for affidavit selection. Failed is accepted but the notice lifecycle does not generate a separate Failed affidavit.","enum":["Submitted","SubmittedAdvanced","Dispatched","TransmissionResult","DeliveryResult","Received","Read","Committed","CommittedAdvanced","Refused","Closed","ClosedAdvanced","Event","Complete","CompleteAdvanced","OnDemand","ContentDownload","Failed"]}},"components/schemas/EviNoticePushNotificationValue":{"id":"components/schemas/EviNoticePushNotificationValue","kind":"json-schema","title":"EviNoticePushNotificationValue","data":{"type":"string","enum":["Processed","Sent","Dispatched","Delivered","Received","Read","Replied","Failed","Closed","AffidavitPublished"]}},"components/schemas/EviNoticeBatchTemplate":{"id":"components/schemas/EviNoticeBatchTemplate","kind":"json-schema","title":"EviNoticeBatchTemplate","data":{"type":"object","description":"The notice template configured for the batch (the per-notice settings applied to every recipient).","properties":{"Subject":{"type":"string"},"Body":{"type":"string","description":"HTML body of the notice."},"IssuerName":{"type":"string"},"From":{"type":"string"},"DisableSenderHeader":{"type":"boolean"},"ReplyTo":{"type":"string"},"CostCentre":{"type":"string"},"TimeToLive":{"type":"integer"},"CertificationLevel":{"type":"string","enum":["None","Standard","Advanced","QERDS","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE","QERDS_ES","QERDS_IT"]},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables post-close LTA storage for every notice generated from the batch. Each notice is stored after its own tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site."},"children":[]}]}]}]},"AffidavitKinds":{"type":"array","items":{"$ref":"#/components/schemas/EviNoticeAffidavitKindValue"}},"Language":{"type":"string"},"AffidavitLanguage":{"type":"string"},"OnlineRetentionPeriod":{"type":"integer"},"PushNotificationUrl":{"type":"string","format":"uri"},"PushNotificationFilter":{"type":"array","items":{"$ref":"#/components/schemas/EviNoticePushNotificationValue"}},"PushNotificationExtraData":{"type":"string"},"CommitmentOptions":{"type":"string","enum":["Disabled","Accept","Reject","AcceptOrReject"]},"CommitmentCommentsAllowed":{"type":"boolean"},"RejectReasons":{"type":"array","items":{"type":"string"}},"AcceptReasons":{"type":"array","items":{"type":"string"}},"RequireRejectReason":{"type":"boolean"},"RequireAcceptReason":{"type":"boolean"},"DeliveryAppearance":{"type":"string","enum":["Certified","AsIs"]},"AllowRefusal":{"type":"boolean"},"OwnerNotificationTemplate":{"type":"string"},"Channel":{"type":"string"}}}},"components/schemas/EviNoticeBatchGetResponse":{"id":"components/schemas/EviNoticeBatchGetResponse","kind":"json-schema","title":"EviNoticeBatchGetResponse","data":{"type":"object","description":"Full state of a notice batch, including its configured notice template and processing progress.","properties":{"Id":{"type":"string","format":"uuid"},"State":{"type":"string","enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]},"Submitter":{"type":"string","description":"Display name of the user who created the batch."},"SubmitterId":{"type":"string"},"SiteName":{"type":"string"},"SiteId":{"type":"string","format":"uuid"},"Description":{"type":"string"},"CreationDate":{"type":"string","format":"date-time"},"ScheduledFor":{"type":"string","format":"date-time","description":"Scheduled execution date and time in UTC."},"StartedOn":{"type":"string","format":"date-time"},"ProcessedOn":{"type":"string","format":"date-time"},"SubmittedOn":{"type":"string","format":"date-time"},"InvalidOn":{"type":"string","format":"date-time"},"LastUpdated":{"type":"string","format":"date-time"},"TotalCount":{"type":"integer","description":"Total number of recipients in the batch."},"EviNotice":{"$ref":"#/components/schemas/EviNoticeBatchTemplate"},"BatchPushNotificationUrl":{"type":"string","format":"uri"},"SentCount":{"type":"integer","description":"Number of notices dispatched so far."},"FailedCount":{"type":"integer","description":"Number of notices that failed."},"ProgressPercentage":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing progress as a percentage (0–100)."},"children":[]}]}]}]},"ExtraFields":{"type":"array","description":"Names of the custom recipient columns detected in the uploaded CSV.","items":{"type":"string"}},"InvalidReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation when the batch is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]},"CsvId":{"type":"string","format":"uuid"},"Outcome":{"type":"string"}}}},"components/schemas/EviNoticeBatchPatchRequest":{"id":"components/schemas/EviNoticeBatchPatchRequest","kind":"json-schema","title":"EviNoticeBatchPatchRequest","data":{"type":"object","description":"Batch metadata and notice template options. All fields are optional; only supplied fields are changed.","properties":{"IssuerName":{"type":"string"},"Subject":{"type":"string","description":"Subject line of the notice. (The body is set with the Body endpoint.)"},"ScheduledDate":{"type":"string","format":"date-time","description":"Scheduled execution date and time in UTC."},"State":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transitions the batch to a new state (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start processing)."},"children":[]}]}]}],"enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]},"Description":{"type":"string","maxLength":255},"From":{"type":"string"},"DisableSenderHeader":{"type":"boolean"},"ReplyTo":{"type":"string"},"TimeToLive":{"type":"integer","description":"Delivery/accessibility window in minutes."},"CostCentre":{"type":"string"},"CertificationLevel":{"type":"string","description":"Certification level applied to every notice in the batch.","enum":["None","Standard","Advanced","QERDS","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE","QERDS_ES","QERDS_IT"]},"AffidavitKinds":{"type":"array","items":{"$ref":"#/components/schemas/EviNoticeAffidavitKindValue"}},"Language":{"type":"string","description":"BCP 47 language tag for the hosted notice UI."},"AffidavitLanguage":{"type":"string","description":"BCP 47 language tag for generated affidavits."},"OnlineRetentionPeriod":{"type":"integer"},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables post-close LTA storage for every notice generated from the batch. Each notice is stored after its own tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site."},"children":[]}]}]}]},"PushNotificationUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push notification URL propagated to every notice generated from the batch — it becomes each notice's own callback URL for the normal per-notice lifecycle callbacks. Alias of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BatchPushNotificationUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (both set the same value; if both are supplied, this one is applied last). The batch itself has no separate lifecycle callback — track batch progress with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"PushNotificationFilter":{"type":"array","items":{"$ref":"#/components/schemas/EviNoticePushNotificationValue"}},"PushNotificationExtraData":{"type":"string"},"CommitmentOptions":{"type":"string","enum":["Disabled","Accept","Reject","AcceptOrReject"]},"CommitmentCommentsAllowed":{"type":"boolean"},"RejectReasons":{"type":"array","items":{"type":"string"}},"AcceptReasons":{"type":"array","items":{"type":"string"}},"RequireRejectReason":{"type":"boolean"},"RequireAcceptReason":{"type":"boolean"},"DeliveryAppearance":{"type":"string","enum":["Certified","AsIs"]},"BatchPushNotificationUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PushNotificationUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — both set the same value. It is propagated to every notice generated from the batch as that notice's own callback URL; the batch has no separate lifecycle callback. Track batch progress with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"AllowRefusal":{"type":"boolean"},"OwnerNotificationTemplate":{"type":"string"},"Channel":{"type":"string","description":"Notification channel for the batch."}}}},"components/schemas/EviNoticeBatchRecipient":{"id":"components/schemas/EviNoticeBatchRecipient","kind":"json-schema","title":"EviNoticeBatchRecipient","data":{"type":"object","properties":{"LookupKey":{"type":"string"},"DisplayName":{"type":"string"},"LegalName":{"type":"string"},"Address":{"type":"string","description":"Recipient email address or mobile number."},"ExtraFields":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom per-recipient fields supplied as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed CSV columns."},"children":[]}]}]}]},"CustodyChallenge":{"type":"string"},"CustodyChallengeResponse":{"type":"string"},"DeliveryOtpChannel":{"type":"string"},"DeliveryOtpAddress":{"type":"string"},"EvidenceUniqueId":{"type":"string","format":"uuid","description":"ID of the generated EviNotice for this recipient, once the batch has been processed."},"Channel":{"type":"string"},"DeliveryChallenge":{"type":"string"},"DeliveryChallengeResponse":{"type":"string"}}}},"components/schemas/EviNoticeBatchRecipientsQueryResponse":{"id":"components/schemas/EviNoticeBatchRecipientsQueryResponse","kind":"json-schema","title":"EviNoticeBatchRecipientsQueryResponse","data":{"type":"object","properties":{"Cursor":{"type":"string","description":"Opaque cursor for the next page of recipients."},"Results":{"type":"array","items":{"$ref":"#/components/schemas/EviNoticeBatchRecipient"}}}}},"components/schemas/EviNoticeBatchAttachmentInfo":{"id":"components/schemas/EviNoticeBatchAttachmentInfo","kind":"json-schema","title":"EviNoticeBatchAttachmentInfo","data":{"type":"object","properties":{"Id":{"type":"string","format":"uuid"},"DisplayName":{"type":"string"},"FileName":{"type":"string"},"MimeType":{"type":"string"},"Size":{"type":"integer","description":"Size of the attachment in bytes."},"ContentEncoding":{"type":"string"},"ContentId":{"type":"string"}}}},"components/schemas/EviNoticeBatchAttachmentPostResponse":{"id":"components/schemas/EviNoticeBatchAttachmentPostResponse","kind":"json-schema","title":"EviNoticeBatchAttachmentPostResponse","data":{"type":"object","properties":{"AttachmentId":{"type":"string","format":"uuid","description":"Unique identifier of the added attachment."}}}},"components/schemas/EviMailRecipient":{"id":"components/schemas/EviMailRecipient","kind":"json-schema","title":"EviMailRecipient","data":{"type":"object","required":["EmailAddress"],"properties":{"LegalName":{"type":"string","description":"Optional legal name of the recipient."},"EmailAddress":{"type":"string","format":"email"}}}},"components/schemas/EviMailCarbonCopy":{"id":"components/schemas/EviMailCarbonCopy","kind":"json-schema","title":"EviMailCarbonCopy","data":{"type":"object","required":["EmailAddress"],"properties":{"Name":{"type":"string","description":"Optional name of the carbon copy recipient."},"EmailAddress":{"type":"string","format":"email"}}}},"components/schemas/EviMailAttachment":{"id":"components/schemas/EviMailAttachment","kind":"json-schema","title":"EviMailAttachment","data":{"type":"object","properties":{"ContentId":{"type":"string","description":"Attachment content identifier."},"DisplayName":{"type":"string"},"Filename":{"type":"string"},"MimeType":{"type":"string","description":"Attachment MIME type."},"ContentDescription":{"type":"string"},"ContentDisposition":{"type":"string"},"ContentLocation":{"type":"string"},"ContentEncoding":{"type":"string"},"Data":{"type":"string","description":"Base64-encoded file content."},"Attributes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment key-value attributes. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludeOnAffidavits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key with value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"true\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reference the attachment in generated affidavits (PDF attachments only; not valid with basic affidavit content)."},"children":[]}]}]}],"items":{"type":"object","properties":{"Key":{"type":"string"},"Value":{"type":"string"}}}}}}},"components/schemas/EviMailOptions":{"id":"components/schemas/EviMailOptions","kind":"json-schema","title":"EviMailOptions","data":{"type":"object","properties":{"CertificationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certification level for EviMail v1. Supported values include the bare "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" levels and their regional variants, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Availability depends on the account."},"children":[]}]}]}],"enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE"]},"TimeToLive":{"type":"integer","minimum":1,"maximum":86400,"description":"Tracking duration in minutes. The platform default is normally 10080 minutes (7 days)."},"DeliveryAppearance":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the visual appearance of the delivery notification page. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Certified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default branded certified-delivery appearance) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AsIs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (plain appearance without certification branding)."},"children":[]}]}]}],"enum":["Certified","AsIs"]},"Language":{"type":"string","description":"Defaults to English on sites using current defaults. Sites using legacy language defaults can resolve a different value.","enum":["en","es","ca","it","pt","pt-BR","fr","de","ro","el"]},"AffidavitLanguage":{"type":"string","description":"Defaults to English on sites using current defaults. Sites using legacy language defaults can resolve a different value.","enum":["en","es","ca","it","pt","pt-BR","fr","de","ro","el"]},"AffidavitKinds":{"type":"array","items":{"type":"string","enum":["Submitted","SubmittedAdvanced","TransmissionResult","DeliveryResult","Read","Committed","CommittedAdvanced","Closed","ClosedAdvanced","Complete","CompleteAdvanced","OnDemand","Event","Failed"]}},"CommitmentOptions":{"type":"string","description":"Formal acceptance or rejection mode. If omitted, the platform default is normally AcceptOrReject.","enum":["Disabled","Accept","Reject","AcceptOrReject"]},"CommitmentCommentsAllowed":{"type":"boolean"},"PushNotificationFilter":{"type":"array","items":{"type":"string","enum":["Ready","Sent","Dispatched","Delivered","Read","Replied","Failed","Closed","AffidavitPublished"]}},"PushNotificationUrl":{"type":"string","format":"uri"},"PushNotificationExtraData":{"type":"string"},"EvidenceAccessControlMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how recipients access the evidence record. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutoChallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When omitted, the account's configured default method applies."},"children":[]}]}]}],"enum":["AutoChallenge","Public","Challenge"]},"EvidenceAccessControlChallenge":{"type":"string"},"EvidenceAccessControlChallengeResponse":{"type":"string"},"RequireAcceptReason":{"type":"boolean","description":"Requires CommitmentCommentsAllowed true and an accept-capable commitment mode."},"AcceptReasons":{"type":"array","description":"Requires CommitmentCommentsAllowed true and an accept-capable commitment mode.","items":{"type":"string"}},"RequireRejectReason":{"type":"boolean","description":"Requires CommitmentCommentsAllowed true and a reject-capable commitment mode."},"RejectReasons":{"type":"array","description":"Requires CommitmentCommentsAllowed true and a reject-capable commitment mode.","items":{"type":"string"}},"OnlineRetentionPeriod":{"type":"integer"},"CostCentre":{"type":"string"},"OwnerNotificationTemplate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of an enabled custom template used for the issuer's status notification email. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/it/products/namirialnotify/dev/templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using communication templates from the API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OwnerNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate."},"CustomLayoutLogoUrl":{"type":"string","format":"uri","description":"URL of a custom logo to display in the certified email layout."},"DisablePlatformReferences":{"type":"boolean","description":"When true, internal platform references are suppressed in the generated affidavits."},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the evidence for this transaction is stored in Namirial Archive during post-close processing after tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnlineRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separately controls online accessibility."},"children":[]}]}]}]},"NotaryRetentionPeriod":{"type":"integer","description":"Notarial deposit retention period in years. Requires NotaryProfile to be set."},"NotaryProfile":{"type":"string","description":"The notary profile identifier to use for notarial deposit."}}}},"components/schemas/EviMailSubmitRequest":{"id":"components/schemas/EviMailSubmitRequest","kind":"json-schema","title":"EviMailSubmitRequest","data":{"type":"object","required":["Subject","Body","Recipient"],"properties":{"Subject":{"type":"string","maxLength":1024},"Body":{"type":"string","maxLength":10485760,"description":"HTML body. HTTP request-size limits can also apply."},"LookupKey":{"type":"string","maxLength":35},"IssuerName":{"type":"string","maxLength":135},"From":{"type":"string","format":"email"},"ReplyTo":{"type":"string","format":"email"},"DisableSenderHeader":{"type":"boolean"},"Recipient":{"$ref":"#/components/schemas/EviMailRecipient"},"CarbonCopy":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/EviMailCarbonCopy"}},"Attachments":{"type":"array","maxItems":15,"description":"Each decoded file must be smaller than 8 MiB. All decoded files together can total up to 25 MiB.","items":{"$ref":"#/components/schemas/EviMailAttachment"}},"Options":{"$ref":"#/components/schemas/EviMailOptions"}}}},"components/schemas/EviMailSubmitResponse":{"id":"components/schemas/EviMailSubmitResponse","kind":"json-schema","title":"EviMailSubmitResponse","data":{"type":"object","required":["eviId"],"properties":{"eviId":{"type":"string"}}}},"components/schemas/EviMailError":{"id":"components/schemas/EviMailError","kind":"json-schema","title":"EviMailError","data":{"type":"object","description":"V1 service-style error response returned by EviMail Submit on 400.","properties":{"responseStatus":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"}}}}}}}}},"components/schemas/EviMailAffidavitInfo":{"id":"components/schemas/EviMailAffidavitInfo","kind":"json-schema","title":"EviMailAffidavitInfo","data":{"type":"object","description":"Affidavit metadata and optional legacy Base64 content associated with a certified email.","properties":{"uniqueId":{"type":"string","format":"uuid","description":"Unique identifier of the affidavit."},"date":{"type":"string","format":"date-time","description":"Timestamp when the affidavit was generated."},"evidenceUniqueId":{"type":"string","format":"uuid","description":"Unique identifier of the email this affidavit belongs to."},"partyUniqueId":{"type":"string","format":"uuid","description":"Identifier of the related delivery/party, when applicable."},"bytes":{"type":"string","format":"byte","nullable":true,"deprecated":true,"description":"Base64-encoded affidavit PDF when binary content is included. Set IncludeAffidavitBlobs to false explicitly to omit it."},"description":{"type":"string","description":"Human-readable description of the affidavit."},"kind":{"type":"string","description":"Technical identifier of the affidavit kind, for example EviMail:Complete."},"additionalData":{"type":"object","description":"Additional affidavit metadata as key-value pairs.","additionalProperties":{"type":"string"}}}}},"components/schemas/EviMailAttachmentInfo":{"id":"components/schemas/EviMailAttachmentInfo","kind":"json-schema","title":"EviMailAttachmentInfo","data":{"type":"object","description":"Metadata for a single attachment associated with a certified email.","properties":{"uniqueId":{"type":"string","format":"uuid","description":"Unique identifier of the attachment."},"evidenceUniqueId":{"type":"string","format":"uuid","description":"Unique identifier of the email this attachment belongs to."},"filename":{"type":"string","description":"File name including extension."},"displayName":{"type":"string","description":"Human-readable label of the attachment."},"mimeType":{"type":"string","description":"MIME type of the attachment."},"contentId":{"type":"string","description":"Content-ID used to reference the attachment inline in the body."},"contentDescription":{"type":"string","description":"Optional human-readable description of the attachment."},"contentDisposition":{"type":"string","description":"Content-Disposition of the attachment (e.g. inline or attachment)."},"contentLocation":{"type":"string","description":"Content-Location header value for the attachment."},"contentEncoding":{"type":"string","description":"Encoding of the attachment content."},"contentLength":{"type":"integer","description":"Size of the attachment in bytes."},"hash":{"type":"string","description":"Cryptographic hash of the attachment content."},"data":{"type":"string","format":"byte","description":"Base64 file contents when attachment binary content is included. Set IncludeAttachmentBlobs to false explicitly to omit it."}}}},"components/schemas/EviMailQueryResult":{"id":"components/schemas/EviMailQueryResult","kind":"json-schema","title":"EviMailQueryResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual query result object. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affidavits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" arrays are included only when the corresponding include flags are set on the request."},"children":[]}]}]}],"properties":{"uniqueId":{"type":"string","description":"Unique identifier (EviId) of the certified email."},"linkedId":{"type":"string","format":"uuid","description":"Identifier of a related certified email, when this message is linked to another."},"lookupKey":{"type":"string","description":"Locator assigned by the issuer at submission."},"issuer":{"type":"object","properties":{"legalName":{"type":"string"},"emailAddress":{"type":"string","format":"email"}}},"recipient":{"type":"object","properties":{"legalName":{"type":"string"},"emailAddress":{"type":"string","format":"email"}}},"carbonCopy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"emailAddress":{"type":"string","format":"email"}}}},"subject":{"type":"string"},"body":{"type":"string","description":"HTML body of the email."},"state":{"type":"string","enum":["Draft","New","Ready","Sent","Dispatched","Delivered","Read","Replied","Closed","Failed"]},"outcome":{"type":"string","enum":["None","Certified","Sent","Delivered","Read","Accepted","Rejected","Failed"]},"acceptOrRejectComments":{"type":"string","description":"Comments provided by the recipient during acceptance or rejection."},"creationDate":{"type":"string","format":"date-time"},"lastStateChangeDate":{"type":"string","format":"date-time"},"newOn":{"type":"string","format":"date-time"},"readyOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"},"dispatchedOn":{"type":"string","format":"date-time"},"deliveredOn":{"type":"string","format":"date-time"},"readOn":{"type":"string","format":"date-time"},"repliedOn":{"type":"string","format":"date-time"},"acceptedOn":{"type":"string","format":"date-time"},"rejectedOn":{"type":"string","format":"date-time"},"failedOn":{"type":"string","format":"date-time"},"expiredOn":{"type":"string","format":"date-time"},"timeToLive":{"type":"integer","description":"Minutes before the message tracking closes."},"onlineRetentionPeriod":{"type":"integer","description":"Years of online retention."},"notaryRetentionPeriod":{"type":"integer","description":"Years of notarial custody, when notarial retention is configured."},"notaryProfile":{"type":"string","description":"Identifier of the notary profile applied for custody."},"sourceChannel":{"type":"string","enum":["Web","Api","Smtp"]},"allowRefusal":{"type":"boolean","description":"Whether the recipient was allowed to refuse the message without opening it."},"costCentre":{"type":"string"},"affidavitKinds":{"type":"array","items":{"type":"string"}},"xmissionResult":{"type":"boolean","description":"Whether the transmission was successful."},"xmissionSummary":{"type":"string","description":"Human-readable summary of the transmission result."},"from":{"type":"string","description":"From header value used in the email."},"customLayoutLogoUrl":{"type":"string","format":"uri"},"siteName":{"type":"string"},"affidavits":{"type":"array","description":"Affidavit entries. Present when IncludeAffidavits is true. Set IncludeAffidavitBlobs to false explicitly to omit PDF bytes.","items":{"$ref":"#/components/schemas/EviMailAffidavitInfo"}},"attachments":{"type":"array","description":"Attachment metadata. Present only when IncludeAttachments is true on the request.","items":{"$ref":"#/components/schemas/EviMailAttachmentInfo"}}},"additionalProperties":true}},"components/schemas/EviMailQueryResponse":{"id":"components/schemas/EviMailQueryResponse","kind":"json-schema","title":"EviMailQueryResponse","data":{"type":"object","properties":{"totalMatches":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EviMailQueryResult"}}}}},"components/schemas/EviMailAffidavitRequest":{"id":"components/schemas/EviMailAffidavitRequest","kind":"json-schema","title":"EviMailAffidavitRequest","data":{"type":"object","required":["UniqueId"],"properties":{"UniqueId":{"type":"string","format":"uuid","description":"Unique ID of the EviMail to generate an affidavit for."},"IncludeBody":{"type":"boolean","description":"Include the email body in the affidavit."},"IncludeAttachments":{"type":"boolean","description":"Include email attachments in the affidavit. Attachments must have been submitted with IncludeOnAffidavits true."},"IncludeEvents":{"type":"boolean","description":"Include detailed event information in the affidavit."}}}},"components/schemas/EviMailAffidavitResponse":{"id":"components/schemas/EviMailAffidavitResponse","kind":"json-schema","title":"EviMailAffidavitResponse","data":{"type":"object","required":["requestId"],"properties":{"requestId":{"type":"string"}}}},"components/schemas/EviMailAffidavitError":{"id":"components/schemas/EviMailAffidavitError","kind":"json-schema","title":"EviMailAffidavitError","data":{"type":"object","properties":{"responseStatus":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}},"components/schemas/EviMailBatchSummary":{"id":"components/schemas/EviMailBatchSummary","kind":"json-schema","title":"EviMailBatchSummary","data":{"type":"object","properties":{"Id":{"type":"string","format":"uuid"},"State":{"type":"string","enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]},"Submitter":{"type":"string"},"SubmitterId":{"type":"string"},"SiteId":{"type":"string","format":"uuid"},"SiteName":{"type":"string"},"Description":{"type":"string"},"CreationDate":{"type":"string","format":"date-time"},"ScheduledFor":{"type":"string","format":"date-time","description":"Scheduled execution date and time in UTC."},"StartedOn":{"type":"string","format":"date-time"},"ProcessedOn":{"type":"string","format":"date-time"},"LastUpdated":{"type":"string","format":"date-time"},"TotalCount":{"type":"integer"},"TotalSent":{"type":"integer"},"TotalFailed":{"type":"integer"}}}},"components/schemas/EviMailBatchesQueryResponse":{"id":"components/schemas/EviMailBatchesQueryResponse","kind":"json-schema","title":"EviMailBatchesQueryResponse","data":{"type":"object","properties":{"Cursor":{"type":"string"},"HasMoreResults":{"type":"boolean"},"Results":{"type":"array","items":{"$ref":"#/components/schemas/EviMailBatchSummary"}}}}},"components/schemas/EviMailBatchCreateRequest":{"id":"components/schemas/EviMailBatchCreateRequest","kind":"json-schema","title":"EviMailBatchCreateRequest","data":{"type":"object","required":["Description"],"properties":{"Description":{"type":"string","maxLength":255,"description":"Human-readable description of the batch."}}}},"components/schemas/EviMailBatchCreateResponse":{"id":"components/schemas/EviMailBatchCreateResponse","kind":"json-schema","title":"EviMailBatchCreateResponse","data":{"type":"object","properties":{"BatchId":{"type":"string","format":"uuid","description":"Unique identifier of the created batch. Use it in all other batch operations."}}}},"components/schemas/EviMailBatchCertificationLevelValue":{"id":"components/schemas/EviMailBatchCertificationLevelValue","kind":"json-schema","title":"EviMailBatchCertificationLevelValue","data":{"type":"string","enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE"]}},"components/schemas/EviMailBatchAffidavitKindValue":{"id":"components/schemas/EviMailBatchAffidavitKindValue","kind":"json-schema","title":"EviMailBatchAffidavitKindValue","data":{"type":"string","enum":["Submitted","SubmittedAdvanced","TransmissionResult","DeliveryResult","Read","Committed","CommittedAdvanced","Closed","ClosedAdvanced","Complete","CompleteAdvanced","OnDemand","Event","Failed"]}},"components/schemas/EviMailBatchPushNotificationValue":{"id":"components/schemas/EviMailBatchPushNotificationValue","kind":"json-schema","title":"EviMailBatchPushNotificationValue","data":{"type":"string","enum":["Ready","Sent","Dispatched","Delivered","Read","Replied","Closed","Failed","AffidavitPublished"]}},"components/schemas/EviMailBatchTemplate":{"id":"components/schemas/EviMailBatchTemplate","kind":"json-schema","title":"EviMailBatchTemplate","data":{"type":"object","description":"The email template configured for the batch (the per-email settings applied to every recipient).","properties":{"Subject":{"type":"string"},"Body":{"type":"string","description":"HTML body of the email."},"IssuerName":{"type":"string"},"CostCentre":{"type":"string"},"From":{"type":"string"},"DisableSenderHeader":{"type":"boolean"},"ReplyTo":{"type":"string"},"TimeToLive":{"type":"integer"},"CertificationLevel":{"$ref":"#/components/schemas/EviMailBatchCertificationLevelValue"},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables post-close LTA storage for every email generated from the batch. Each email is stored after its own tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site."},"children":[]}]}]}]},"AffidavitKinds":{"type":"array","items":{"$ref":"#/components/schemas/EviMailBatchAffidavitKindValue"}},"Language":{"type":"string"},"AffidavitLanguage":{"type":"string"},"OnlineRetentionPeriod":{"type":"integer"},"PushNotificationUrl":{"type":"string","format":"uri"},"PushNotificationFilter":{"type":"array","items":{"$ref":"#/components/schemas/EviMailBatchPushNotificationValue"}},"PushNotificationExtraData":{"type":"string"},"CommitmentOptions":{"type":"string","enum":["Disabled","Accept","Reject","AcceptOrReject"]},"CommitmentCommentsAllowed":{"type":"boolean"},"RejectReasons":{"type":"array","items":{"type":"string"}},"AcceptReasons":{"type":"array","items":{"type":"string"}},"RequireRejectReason":{"type":"boolean"},"RequireAcceptReason":{"type":"boolean"},"DeliveryAppearance":{"type":"string","enum":["Certified","AsIs"]},"OwnerNotificationTemplate":{"type":"string"}}}},"components/schemas/EviMailBatchGetResponse":{"id":"components/schemas/EviMailBatchGetResponse","kind":"json-schema","title":"EviMailBatchGetResponse","data":{"type":"object","description":"Full state of an email batch, including its configured email template and processing progress.","properties":{"Id":{"type":"string","format":"uuid"},"State":{"type":"string","enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]},"Submitter":{"type":"string"},"SubmitterId":{"type":"string"},"SiteName":{"type":"string"},"SiteId":{"type":"string","format":"uuid"},"Description":{"type":"string"},"CreationDate":{"type":"string","format":"date-time"},"ScheduledFor":{"type":"string","format":"date-time","description":"Scheduled execution date and time in UTC."},"StartedOn":{"type":"string","format":"date-time"},"ProcessedOn":{"type":"string","format":"date-time"},"SubmittedOn":{"type":"string","format":"date-time"},"InvalidOn":{"type":"string","format":"date-time"},"LastUpdated":{"type":"string","format":"date-time"},"TotalCount":{"type":"integer"},"EviMail":{"$ref":"#/components/schemas/EviMailBatchTemplate"},"BatchPushNotificationUrl":{"type":"string","format":"uri"},"SentCount":{"type":"integer"},"FailedCount":{"type":"integer"},"ProgressPercentage":{"type":"number","format":"float"},"ExtraFields":{"type":"array","items":{"type":"string"}},"InvalidReason":{"type":"string"},"CsvId":{"type":"string","format":"uuid"},"Outcome":{"type":"string"}}}},"components/schemas/EviMailBatchPatchRequest":{"id":"components/schemas/EviMailBatchPatchRequest","kind":"json-schema","title":"EviMailBatchPatchRequest","data":{"type":"object","description":"Batch metadata and email template options. Submitting a batch requires State and ScheduledDate together and a complete message configuration.","properties":{"IssuerName":{"type":"string"},"Subject":{"type":"string","description":"Subject line of the email. (The body is set with the Body endpoint.)"},"ScheduledDate":{"type":"string","format":"date-time","description":"Future execution date and time in UTC. Required when submitting a Draft or Invalid batch."},"State":{"type":"string","description":"Set Submitted to submit an editable batch or Draft to return a Submitted or Scheduled batch to editing.","enum":["Draft","Submitted"]},"Description":{"type":"string","maxLength":255},"From":{"type":"string"},"DisableSenderHeader":{"type":"boolean"},"ReplyTo":{"type":"string"},"TimeToLive":{"type":"integer"},"CostCentre":{"type":"string"},"CertificationLevel":{"$ref":"#/components/schemas/EviMailBatchCertificationLevelValue"},"AffidavitKinds":{"type":"array","items":{"$ref":"#/components/schemas/EviMailBatchAffidavitKindValue"}},"Language":{"type":"string"},"AffidavitLanguage":{"type":"string"},"OnlineRetentionPeriod":{"type":"integer"},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables post-close LTA storage for every email generated from the batch. Each email is stored after its own tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site."},"children":[]}]}]}]},"PushNotificationUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push notification URL propagated to every email generated from the batch — it becomes each email's own callback URL for the normal per-email lifecycle callbacks. Alias of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BatchPushNotificationUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (both set the same value; if both are supplied, this one is applied last). The batch itself has no separate lifecycle callback — track batch progress with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"PushNotificationFilter":{"type":"array","items":{"$ref":"#/components/schemas/EviMailBatchPushNotificationValue"}},"PushNotificationExtraData":{"type":"string"},"CommitmentOptions":{"type":"string","enum":["Disabled","Accept","Reject","AcceptOrReject"]},"CommitmentCommentsAllowed":{"type":"boolean"},"RejectReasons":{"type":"array","items":{"type":"string"}},"AcceptReasons":{"type":"array","items":{"type":"string"}},"RequireRejectReason":{"type":"boolean"},"RequireAcceptReason":{"type":"boolean"},"DeliveryAppearance":{"type":"string","enum":["Certified","AsIs"]},"BatchPushNotificationUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PushNotificationUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — both set the same value. It is propagated to every email generated from the batch as that email's own callback URL; the batch has no separate lifecycle callback. Track batch progress with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OwnerNotificationTemplate":{"type":"string"}}}},"components/schemas/EviMailBatchRecipient":{"id":"components/schemas/EviMailBatchRecipient","kind":"json-schema","title":"EviMailBatchRecipient","data":{"type":"object","properties":{"LookupKey":{"type":"string"},"DisplayName":{"type":"string"},"LegalName":{"type":"string"},"Address":{"type":"string","description":"Recipient email address."},"ExtraFields":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom per-recipient fields supplied as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed CSV columns."},"children":[]}]}]}]},"EvidenceAccessControlChallenge":{"type":"string"},"EvidenceAccessControlChallengeResponse":{"type":"string"},"EvidenceUniqueId":{"type":"string","format":"uuid","description":"ID of the generated EviMail for this recipient, once the batch has been processed."}}}},"components/schemas/EviMailBatchRecipientsQueryResponse":{"id":"components/schemas/EviMailBatchRecipientsQueryResponse","kind":"json-schema","title":"EviMailBatchRecipientsQueryResponse","data":{"type":"object","properties":{"Cursor":{"type":"string"},"Results":{"type":"array","items":{"$ref":"#/components/schemas/EviMailBatchRecipient"}}}}},"components/schemas/EviMailBatchAttachmentInfo":{"id":"components/schemas/EviMailBatchAttachmentInfo","kind":"json-schema","title":"EviMailBatchAttachmentInfo","data":{"type":"object","properties":{"Id":{"type":"string","format":"uuid"},"DisplayName":{"type":"string"},"FileName":{"type":"string"},"MimeType":{"type":"string"},"Size":{"type":"integer","description":"Size of the attachment in bytes."},"ContentEncoding":{"type":"string"},"ContentId":{"type":"string"}}}},"components/schemas/EviMailBatchAttachmentPostResponse":{"id":"components/schemas/EviMailBatchAttachmentPostResponse","kind":"json-schema","title":"EviMailBatchAttachmentPostResponse","data":{"type":"object","properties":{"AttachmentId":{"type":"string","format":"uuid"}}}},"components/schemas/EviSmsRecipient":{"id":"components/schemas/EviSmsRecipient","kind":"json-schema","title":"EviSmsRecipient","data":{"type":"object","required":["PhoneNumber"],"properties":{"LegalName":{"type":"string"},"PhoneNumber":{"type":"string","description":"International mobile number."}}}},"components/schemas/EviSmsOptions":{"id":"components/schemas/EviSmsOptions","kind":"json-schema","title":"EviSmsOptions","data":{"type":"object","properties":{"CertificationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and their regional variants, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Availability depends on the account."},"children":[]}]}]}],"enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE"]},"CostCentre":{"type":"string"},"DeliveryChannels":{"type":"array","uniqueItems":true,"description":"Ordered channels. Omitted or empty uses SMS. RCS requires site enablement.","items":{"type":"string","enum":["RCS","SMS"]}},"AffidavitKinds":{"type":"array","description":"The Read affidavit requires RCS in DeliveryChannels.","items":{"type":"string","enum":["Submitted","SubmittedAdvanced","TransmissionResult","DeliveryResult","Read","Closed","ClosedAdvanced","Complete","CompleteAdvanced","Event"]}},"TimeToLive":{"type":"integer","minimum":1,"maximum":86400,"description":"Tracking window in minutes. If omitted, the configured default applies."},"Language":{"type":"string","enum":["en","es","ca","it","pt","pt-BR","fr","de","ro"]},"AffidavitLanguage":{"type":"string","enum":["en","es","ca","it","pt","pt-BR","fr","de","ro","el"]},"EvidenceAccessControlMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how recipients access the evidence record. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AutoChallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When omitted, the account's configured default method applies."},"children":[]}]}]}],"enum":["AutoChallenge","Public","Challenge"]},"EvidenceAccessControlChallenge":{"type":"string"},"EvidenceAccessControlChallengeResponse":{"type":"string"},"OnlineRetentionPeriod":{"type":"integer"},"NotaryRetentionPeriod":{"type":"integer"},"NotaryProfile":{"type":"string"},"PushNotificationFilter":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State transitions that trigger a push notification callback to PushNotificationUrl. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitPublished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a platform meta-event that fires when affidavit generation completes — it is not a lifecycle state."},"children":[]}]}]}],"items":{"type":"string","enum":["Ready","Sent","Dispatched","Delivered","Read","Failed","Closed","AffidavitPublished"]}},"PushNotificationUrl":{"type":"string","format":"uri"},"PushNotificationExtraData":{"type":"string"},"DeliveryAppearance":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the visual appearance of the delivery page. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Certified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the branded certified-delivery appearance; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AsIs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a plain appearance without certification branding."},"children":[]}]}]}],"enum":["Certified","AsIs"]},"OwnerNotificationTemplate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of an enabled custom template used for the issuer's status notification email. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/it/products/namirialnotify/dev/templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using communication templates from the API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OwnerNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate."},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the evidence for this transaction is stored in Namirial Archive during post-close processing after tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnlineRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separately controls online accessibility."},"children":[]}]}]}]}}}},"components/schemas/EviSmsSubmitRequest":{"id":"components/schemas/EviSmsSubmitRequest","kind":"json-schema","title":"EviSmsSubmitRequest","data":{"type":"object","required":["Text","Recipient"],"properties":{"Text":{"type":"string"},"LookupKey":{"type":"string"},"IssuerName":{"type":"string","description":"Legal name or short identifier for the sending organisation, recorded in the certification evidence. This is not the sender shown in the recipient's inbox (that sender is configured at the account level).\n"},"Recipient":{"$ref":"#/components/schemas/EviSmsRecipient"},"Options":{"$ref":"#/components/schemas/EviSmsOptions"}}}},"components/schemas/EviSmsSubmitResponse":{"id":"components/schemas/EviSmsSubmitResponse","kind":"json-schema","title":"EviSmsSubmitResponse","data":{"type":"object","required":["eviId"],"properties":{"eviId":{"type":"string"}}}},"components/schemas/EviSmsError":{"id":"components/schemas/EviSmsError","kind":"json-schema","title":"EviSmsError","data":{"type":"object","properties":{"responseStatus":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}},"components/schemas/EviSmsAffidavitInfo":{"id":"components/schemas/EviSmsAffidavitInfo","kind":"json-schema","title":"EviSmsAffidavitInfo","data":{"type":"object","description":"Affidavit metadata and optional legacy Base64 content associated with a certified SMS.","properties":{"uniqueId":{"type":"string","format":"uuid","description":"Unique identifier of the affidavit."},"date":{"type":"string","format":"date-time","description":"Timestamp when the affidavit was generated."},"evidenceUniqueId":{"type":"string","format":"uuid","description":"Unique identifier of the SMS this affidavit belongs to."},"partyUniqueId":{"type":"string","format":"uuid","description":"Identifier of the related delivery/party, when applicable."},"bytes":{"type":"string","format":"byte","nullable":true,"deprecated":true,"description":"Base64-encoded affidavit PDF. Present when the effective IncludeAffidavitBlobs value is true."},"description":{"type":"string","description":"Human-readable description of the affidavit."},"kind":{"type":"string","description":"Technical identifier of the affidavit kind, for example EviSms:Closed."},"additionalData":{"type":"object","description":"Additional affidavit metadata as key-value pairs.","additionalProperties":{"type":"string"}}}}},"components/schemas/EviSmsQueryResult":{"id":"components/schemas/EviSmsQueryResult","kind":"json-schema","title":"EviSmsQueryResult","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual query result object. The nested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"affidavits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array is included only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludeAffidavits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set on the request."},"children":[]}]}]}],"properties":{"uniqueId":{"type":"string","description":"Unique identifier (EviId) of the certified SMS."},"lookupKey":{"type":"string","description":"Locator assigned by the issuer at submission."},"text":{"type":"string","description":"Content of the SMS message."},"issuer":{"type":"object","properties":{"legalName":{"type":"string"},"phoneNumber":{"type":"string"}}},"recipient":{"type":"object","properties":{"legalName":{"type":"string"},"phoneNumber":{"type":"string"}}},"state":{"type":"string","enum":["Draft","New","Ready","Sent","Dispatched","Delivered","Read","Closed","Failed"]},"outcome":{"type":"string","enum":["None","Certified","Sent","Delivered","Read","Failed"]},"creationDate":{"type":"string","format":"date-time"},"lastStateChangeDate":{"type":"string","format":"date-time"},"newOn":{"type":"string","format":"date-time"},"readyOn":{"type":"string","format":"date-time","description":"Set when Ready is recorded, with the original admission time from newOn."},"sentOn":{"type":"string","format":"date-time"},"dispatchedOn":{"type":"string","format":"date-time"},"deliveredOn":{"type":"string","format":"date-time"},"readOn":{"type":"string","format":"date-time"},"failedOn":{"type":"string","format":"date-time"},"expiredOn":{"type":"string","format":"date-time"},"timeToLive":{"type":"integer","description":"Minutes before the message tracking closes."},"costCentre":{"type":"string","description":"Cost-centre label recorded with the transaction for internal billing allocation."},"onlineRetentionPeriod":{"type":"integer","description":"Years of online retention."},"notaryRetentionPeriod":{"type":"integer","description":"Years of retention at the notary office."},"notaryProfile":{"type":"string","description":"Notary identifier for custody."},"sourceChannel":{"type":"string","enum":["Web","Api","Smtp"]},"deliveryChannels":{"type":"array","items":{"type":"string"},"description":"Channels used to deliver the SMS (e.g., RCS, SMS)."},"affidavitKinds":{"type":"array","items":{"type":"string"}},"affidavits":{"type":"array","description":"Affidavit entries. Bytes are present if affidavit blobs are enabled for the request.","items":{"$ref":"#/components/schemas/EviSmsAffidavitInfo"}}},"additionalProperties":true}},"components/schemas/EviSmsQueryResponse":{"id":"components/schemas/EviSmsQueryResponse","kind":"json-schema","title":"EviSmsQueryResponse","data":{"type":"object","properties":{"totalMatches":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EviSmsQueryResult"}}}}},"components/schemas/EviSmsBatchSummary":{"id":"components/schemas/EviSmsBatchSummary","kind":"json-schema","title":"EviSmsBatchSummary","data":{"type":"object","properties":{"Id":{"type":"string","format":"uuid"},"State":{"type":"string","enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]},"Submitter":{"type":"string"},"SubmitterId":{"type":"string"},"SiteId":{"type":"string","format":"uuid"},"SiteName":{"type":"string"},"Description":{"type":"string"},"CreationDate":{"type":"string","format":"date-time"},"ScheduledFor":{"type":"string","format":"date-time","description":"Scheduled execution date and time in UTC."},"StartedOn":{"type":"string","format":"date-time"},"ProcessedOn":{"type":"string","format":"date-time"},"LastUpdated":{"type":"string","format":"date-time"},"TotalCount":{"type":"integer"},"TotalSent":{"type":"integer"},"TotalFailed":{"type":"integer"}}}},"components/schemas/EviSmsBatchesQueryResponse":{"id":"components/schemas/EviSmsBatchesQueryResponse","kind":"json-schema","title":"EviSmsBatchesQueryResponse","data":{"type":"object","properties":{"Cursor":{"type":"string"},"HasMoreResults":{"type":"boolean"},"Results":{"type":"array","items":{"$ref":"#/components/schemas/EviSmsBatchSummary"}}}}},"components/schemas/EviSmsBatchCreateRequest":{"id":"components/schemas/EviSmsBatchCreateRequest","kind":"json-schema","title":"EviSmsBatchCreateRequest","data":{"type":"object","required":["Description"],"properties":{"Description":{"type":"string","maxLength":255,"description":"Human-readable description of the batch."}}}},"components/schemas/EviSmsBatchCreateResponse":{"id":"components/schemas/EviSmsBatchCreateResponse","kind":"json-schema","title":"EviSmsBatchCreateResponse","data":{"type":"object","properties":{"BatchId":{"type":"string","format":"uuid","description":"Unique identifier of the created batch. Use it in all other batch operations."}}}},"components/schemas/EviSmsBatchAffidavitKindValue":{"id":"components/schemas/EviSmsBatchAffidavitKindValue","kind":"json-schema","title":"EviSmsBatchAffidavitKindValue","data":{"type":"string","enum":["Submitted","SubmittedAdvanced","TransmissionResult","DeliveryResult","Read","Closed","ClosedAdvanced","Complete","CompleteAdvanced","Event"]}},"components/schemas/EviSmsBatchPushNotificationValue":{"id":"components/schemas/EviSmsBatchPushNotificationValue","kind":"json-schema","title":"EviSmsBatchPushNotificationValue","data":{"type":"string","enum":["Ready","Sent","Dispatched","Delivered","Read","Closed","Failed","AffidavitPublished"]}},"components/schemas/EviSmsBatchTemplate":{"id":"components/schemas/EviSmsBatchTemplate","kind":"json-schema","title":"EviSmsBatchTemplate","data":{"type":"object","description":"The message template configured for the batch (the per-message settings applied to every recipient).","properties":{"Text":{"type":"string","description":"The SMS message content."},"IssuerName":{"type":"string"},"CostCentre":{"type":"string"},"TimeToLive":{"type":"integer"},"CertificationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and their regional variants, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Availability depends on the account."},"children":[]}]}]}],"enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE"]},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables post-close LTA storage for every message generated from the batch. Each message is stored after its own tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site."},"children":[]}]}]}]},"AffidavitKinds":{"type":"array","items":{"$ref":"#/components/schemas/EviSmsBatchAffidavitKindValue"}},"Language":{"type":"string"},"AffidavitLanguage":{"type":"string"},"OnlineRetentionPeriod":{"type":"integer"},"PushNotificationUrl":{"type":"string","format":"uri"},"PushNotificationFilter":{"type":"array","items":{"$ref":"#/components/schemas/EviSmsBatchPushNotificationValue"}},"PushNotificationExtraData":{"type":"string"},"DeliveryAppearance":{"type":"string","enum":["Certified","AsIs"]},"OwnerNotificationTemplate":{"type":"string"}}}},"components/schemas/EviSmsBatchGetResponse":{"id":"components/schemas/EviSmsBatchGetResponse","kind":"json-schema","title":"EviSmsBatchGetResponse","data":{"type":"object","description":"Full state of an SMS batch, including its configured message template and processing progress.","properties":{"Id":{"type":"string","format":"uuid"},"State":{"type":"string","enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]},"Submitter":{"type":"string"},"SubmitterId":{"type":"string"},"SiteName":{"type":"string"},"SiteId":{"type":"string","format":"uuid"},"Description":{"type":"string"},"CreationDate":{"type":"string","format":"date-time"},"ScheduledFor":{"type":"string","format":"date-time","description":"Scheduled execution date and time in UTC."},"StartedOn":{"type":"string","format":"date-time"},"ProcessedOn":{"type":"string","format":"date-time"},"SubmittedOn":{"type":"string","format":"date-time"},"InvalidOn":{"type":"string","format":"date-time"},"LastUpdated":{"type":"string","format":"date-time"},"TotalCount":{"type":"integer"},"EviSms":{"$ref":"#/components/schemas/EviSmsBatchTemplate"},"BatchPushNotificationUrl":{"type":"string","format":"uri"},"SentCount":{"type":"integer"},"FailedCount":{"type":"integer"},"ProgressPercentage":{"type":"number","format":"float"},"ExtraFields":{"type":"array","items":{"type":"string"}},"InvalidReason":{"type":"string"},"CsvId":{"type":"string","format":"uuid"},"Outcome":{"type":"string"}}}},"components/schemas/EviSmsBatchPatchRequest":{"id":"components/schemas/EviSmsBatchPatchRequest","kind":"json-schema","title":"EviSmsBatchPatchRequest","data":{"type":"object","description":"Batch metadata and message template options. ScheduledDate is required when submitting a batch.","properties":{"IssuerName":{"type":"string","description":"Legal name or short identifier for the sending organisation, recorded in the certification evidence. This is not the sender shown in the recipient's inbox (that sender is configured at the account level).\n"},"ScheduledDate":{"type":"string","format":"date-time","description":"Future execution date and time in UTC. Required with State Submitted."},"State":{"type":"string","enum":["Draft","Submitted"]},"Description":{"type":"string","maxLength":255},"Text":{"type":"string","description":"The SMS message content for this batch."},"TimeToLive":{"type":"integer"},"CostCentre":{"type":"string"},"CertificationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and their regional variants, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Availability depends on the account."},"children":[]}]}]}],"enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE"]},"AffidavitKinds":{"type":"array","description":"Batches use SMS. Do not select the RCS-only Read affidavit.","items":{"$ref":"#/components/schemas/EviSmsBatchAffidavitKindValue"}},"Language":{"type":"string"},"AffidavitLanguage":{"type":"string"},"OnlineRetentionPeriod":{"type":"integer"},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables post-close LTA storage for every message generated from the batch. Each message is stored after its own tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site."},"children":[]}]}]}]},"PushNotificationUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push notification URL propagated to every message generated from the batch — it becomes each message's own callback URL for the normal per-message lifecycle callbacks. Alias of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BatchPushNotificationUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (both set the same value; if both are supplied, this one is applied last). The batch itself has no separate lifecycle callback — track batch progress with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"PushNotificationFilter":{"type":"array","items":{"$ref":"#/components/schemas/EviSmsBatchPushNotificationValue"}},"PushNotificationExtraData":{"type":"string"},"DeliveryAppearance":{"type":"string","enum":["Certified","AsIs"]},"BatchPushNotificationUrl":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PushNotificationUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — both set the same value. It is propagated to every message generated from the batch as that message's own callback URL; the batch has no separate lifecycle callback. Track batch progress with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET .../{BatchId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OwnerNotificationTemplate":{"type":"string"}}}},"components/schemas/EviSmsBatchRecipient":{"id":"components/schemas/EviSmsBatchRecipient","kind":"json-schema","title":"EviSmsBatchRecipient","data":{"type":"object","properties":{"LookupKey":{"type":"string"},"LegalName":{"type":"string"},"PhoneNumber":{"type":"string","description":"Recipient mobile number."},"ExtraFields":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom per-recipient fields supplied as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed CSV columns."},"children":[]}]}]}]},"EvidenceAccessControlChallenge":{"type":"string"},"EvidenceAccessControlChallengeResponse":{"type":"string"},"EvidenceUniqueId":{"type":"string","format":"uuid","description":"ID of the generated EviSMS for this recipient, once the batch has been processed."}}}},"components/schemas/EviSmsBatchRecipientsQueryResponse":{"id":"components/schemas/EviSmsBatchRecipientsQueryResponse","kind":"json-schema","title":"EviSmsBatchRecipientsQueryResponse","data":{"type":"object","properties":{"Cursor":{"type":"string"},"Results":{"type":"array","items":{"$ref":"#/components/schemas/EviSmsBatchRecipient"}}}}},"components/schemas/v1.EviSignSubmit._SigningParty._SigningMethod":{"id":"components/schemas/v1.EviSignSubmit._SigningParty._SigningMethod","kind":"json-schema","title":"v1.EviSignSubmit._SigningParty._SigningMethod","data":{"enum":["WebClick","MobilePin","EmailPin","Challenge","Handwriting","ExternalHandwriting","UserCertificate"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signing methods supported for EviSign signing parties."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WebClick"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature by web click confirmation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MobilePin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature with mobile PIN verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EmailPin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature with email PIN verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature with challenge-response verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Handwriting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature by handwriting input."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalHandwriting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature by external handwriting provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserCertificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature using a user digital certificate."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignSubmit._SigningParty._SignatureQuestion":{"id":"components/schemas/v1.EviSignSubmit._SigningParty._SignatureQuestion","kind":"json-schema","title":"v1.EviSignSubmit._SigningParty._SignatureQuestion","data":{"type":"object","properties":{"Key":{"type":"string","description":"Question key identifier.","nullable":true},"Label":{"type":"string","description":"Question label shown to the signer.","nullable":true},"TypeName":{"type":"string","description":"Field type name for the question input.","nullable":true},"DefaultValue":{"type":"string","description":"Default value used when no explicit value is provided.","nullable":true},"Required":{"type":"boolean","description":"Indicates whether the question is mandatory.","nullable":true},"ValidationRegex":{"type":"string","description":"Validation regex applied to the question value.","nullable":true},"ValidationMessage":{"type":"string","description":"Validation message returned when regex validation fails.","nullable":true},"ToolTip":{"type":"string","description":"Tooltip text shown for the question.","nullable":true},"SelectListItems":{"type":"array","items":{"type":"string"},"description":"Available options when TypeName is a select-list field.","nullable":true},"UseWikiText":{"type":"boolean","description":"Indicates whether Label should be rendered as wiki text."}},"additionalProperties":false,"description":"Additional question presented to a signer during the signature flow."}},"components/schemas/v1.EviSignSubmit._SigningParty._GeoLocationPolicy":{"id":"components/schemas/v1.EviSignSubmit._SigningParty._GeoLocationPolicy","kind":"json-schema","title":"v1.EviSignSubmit._SigningParty._GeoLocationPolicy","data":{"enum":["Disabled","Enabled","Required"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geolocation policy applied during signer delivery and interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Geolocation capture is disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Geolocation capture is enabled when available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Geolocation capture is mandatory."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignSubmit._SigningParty._WhatsAppPinPolicy":{"id":"components/schemas/v1.EviSignSubmit._SigningParty._WhatsAppPinPolicy","kind":"json-schema","title":"v1.EviSignSubmit._SigningParty._WhatsAppPinPolicy","data":{"enum":["Disabled","Optional","Fallback"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WhatsApp PIN behavior policy for signer verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": WhatsApp PIN is disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Optional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": WhatsApp PIN is allowed as an optional method."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fallback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": WhatsApp PIN is used as a fallback method."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignSubmit._SigningParty":{"id":"components/schemas/v1.EviSignSubmit._SigningParty","kind":"json-schema","title":"v1.EviSignSubmit._SigningParty","data":{"type":"object","properties":{"Name":{"type":"string","description":"Signing party display name.","nullable":true},"Address":{"type":"string","description":"Notification address used to deliver signature access.","nullable":true},"SigningMethod":{"allOf":[{"$ref":"#/components/schemas/v1.EviSignSubmit._SigningParty._SigningMethod"}],"description":"Signature method for this party. Submit uses WebClick when omitted or null."},"SignatureAppearances":{"type":"string","description":"Signature appearance descriptors (JSON format).","nullable":true},"SignatureQuestions":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._SigningParty._SignatureQuestion"},"description":"Additional questions shown during signing.","nullable":true},"PhoneNumber":{"type":"string","description":"Phone number used for SMS PIN signature.","nullable":true},"SignDelivery":{"type":"boolean","description":"Indicates whether delivery must be signed first.","nullable":true},"EmailAddress":{"type":"string","description":"Email address used for email PIN signature.","nullable":true},"SignatureChallenge":{"type":"string","description":"Challenge question used for Challenge signing.","nullable":true},"SignatureChallengeResponse":{"type":"string","description":"Challenge response used for Challenge signing.","nullable":true},"LegalName":{"type":"string","description":"Legal name of the signing party.","nullable":true},"AddressType":{"enum":["Email","PhoneNumber","MobileDevice","Sms",null],"type":"string","description":"Address type of the signing party.","nullable":true},"DisableSignRequests":{"type":"boolean","description":"Indicates whether signature request notifications are disabled.","nullable":true},"RequiresCaptcha":{"type":"boolean","description":"Indicates whether captcha is required for this party.","nullable":true},"Language":{"type":"string","description":"Language used for this signing party.","nullable":true},"SigningOrder":{"type":"integer","description":"Signing order position for this party.","format":"int32","nullable":true},"Role":{"enum":["Signer","Reviewer","Interested",null],"type":"string","description":"Role assigned to this party.","nullable":true},"DisableFinalNotification":{"type":"boolean","description":"Indicates whether final notifications are disabled for this party.","nullable":true},"DisableStateNotifications":{"type":"boolean","description":"Indicates whether state change notifications are disabled for this party.","nullable":true},"Required":{"type":"boolean","description":"Indicates whether this party is required to sign.","nullable":true},"TimeToWait":{"type":"integer","description":"Time to wait for this signer, in minutes.","format":"int32","nullable":true},"SignStep":{"enum":["Begin","BeforeDoc","AfterDoc","End",null],"type":"string","description":"Signature step used for commitment/signature flow.","nullable":true},"FinalNotificationAddress":{"type":"string","description":"Address used for final notifications.","nullable":true},"DeliverySubDomain":{"type":"string","description":"Delivery subdomain used for this party.","nullable":true},"DeliveryCustomUrl":{"type":"string","description":"Custom redirect URL used with DeliverySubDomain.","nullable":true},"DeliveryWebView":{"type":"string","description":"Delivery WebView target for this party.","nullable":true},"AllowVoicePinFallback":{"type":"boolean","description":"Indicates whether voice PIN fallback is allowed."},"DeliveryProfile":{"type":"string","description":"Delivery profile identifier for this party.","nullable":true},"SignerGeoLocationPolicy":{"allOf":[{"$ref":"#/components/schemas/v1.EviSignSubmit._SigningParty._GeoLocationPolicy"}],"description":"Geolocation policy applied during delivery."},"EntityIdKind":{"enum":["TaxId","VatId",null],"type":"string","description":"Legal identifier type of the entity.","nullable":true},"EntityId":{"type":"string","description":"Legal identifier value of the entity.","nullable":true},"PersonIdKind":{"enum":["PassportId","NationalId","DrivingLicenseId",null],"type":"string","description":"Legal identifier type of the signer.","nullable":true},"PersonId":{"type":"string","description":"Legal identifier value of the signer.","nullable":true},"DelegatedSignature":{"type":"object","properties":{"WhatsAppPinPolicy":{"allOf":[{"$ref":"#/components/schemas/v1.EviSignSubmit._SigningParty._WhatsAppPinPolicy"}],"description":"WhatsApp PIN policy applied to delegated signature flows."}},"additionalProperties":false,"description":"Delegated signature configuration.","nullable":true},"WhatsAppPinPolicy":{"allOf":[{"$ref":"#/components/schemas/v1.EviSignSubmit._SigningParty._WhatsAppPinPolicy"}],"description":"WhatsApp PIN policy."},"SignatureRequestPolicy":{"enum":["SmsOnly","WhatsAppOnly","SmsThenWhatsApp","WhatsAppThenSms",null],"type":"string","description":"Channel policy for signature request delivery attempts.","nullable":true},"SignatureRequestTemplate":{"type":"string","description":"Template name for signature request email notifications.","nullable":true},"SignatureRequestTemplateValues":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Placeholder values used to render SignatureRequestTemplate.","nullable":true},"ProgressNotificationTemplate":{"type":"string","description":"Template name for progress email notifications.","nullable":true},"ProgressNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Placeholder values used to render ProgressNotificationTemplate.","nullable":true},"FinalNotificationTemplate":{"type":"string","description":"Template name for final email notifications.","nullable":true},"FinalNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Placeholder values used to render FinalNotificationTemplate.","nullable":true},"SignatureReminderTemplate":{"type":"string","description":"Template name for signature reminder email notifications.","nullable":true},"SignatureReminderTemplateValues":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Placeholder values used to render SignatureReminderTemplate.","nullable":true},"LiteFlow":{"type":"boolean","description":"Indicates whether LiteFlow is enabled for this party.","nullable":true}},"additionalProperties":false,"description":"Signing party included in an EviSign submission."}},"components/schemas/v1.EviSignSubmit._InterestedParty":{"id":"components/schemas/v1.EviSignSubmit._InterestedParty","kind":"json-schema","title":"v1.EviSignSubmit._InterestedParty","data":{"type":"object","properties":{"Address":{"type":"string","description":"Interested party email address.","nullable":true},"ProgressNotificationTemplate":{"type":"string","description":"Notification template identifier used for progress updates.","nullable":true},"ProgressNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Placeholder values used to render ProgressNotificationTemplate.","nullable":true}},"additionalProperties":false,"description":"Interested party notified about EviSign progress updates."}},"components/schemas/v1.EviSignSubmit._Options._CustomField":{"id":"components/schemas/v1.EviSignSubmit._Options._CustomField","kind":"json-schema","title":"v1.EviSignSubmit._Options._CustomField","data":{"required":["Key","Label","Value"],"type":"object","properties":{"Key":{"minLength":1,"type":"string","description":"Custom field key identifier."},"Label":{"minLength":1,"type":"string","description":"Display label for the custom field."},"Value":{"minLength":1,"type":"string","description":"Submitted value for the custom field."},"IsLookupKey":{"type":"boolean","description":"Indicates whether this field is used as lookup key."},"TypeName":{"type":"string","description":"Field type identifier used by dynamic form rendering.","nullable":true},"DefaultValue":{"type":"string","description":"Default value used when no explicit value is provided.","nullable":true},"Required":{"type":"boolean","description":"Indicates whether a value is required for this field."},"ValidationRegex":{"type":"string","description":"Validation regex applied to the field value.","nullable":true},"ValidationMessage":{"type":"string","description":"Validation message returned when regex validation fails.","nullable":true}},"additionalProperties":false,"description":"Custom field definition attached to EviSign submission options."}},"components/schemas/v1.EviSignSubmit._Options._PushNotification":{"id":"components/schemas/v1.EviSignSubmit._Options._PushNotification","kind":"json-schema","title":"v1.EviSignSubmit._Options._PushNotification","data":{"enum":["Processed","Sent","Delivered","Signed","Rejected","FullySigned","Closed","FullySent","FullyDelivered","AffidavitPublished"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push notification events emitted during EviSign processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The signing workflow was prepared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A party’s signature or review request was attempted, sent or abandoned. Inspect AdditionalData.TransmissionSuccess and AdditionalData.EventDescription."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Delivery of a party’s signature or review request was reported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Signed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A signer completed the signature action."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A signer rejected the signature request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FullySigned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All signing and review parties completed their approval or signing step."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign lifecycle was closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FullySent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Aggregate sending milestone for the signing and review parties."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FullyDelivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Aggregate delivery milestone for the workflow."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitPublished"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An affidavit was generated and published."},"children":[]}]}]}]}]}},"components/schemas/DayOfWeek":{"id":"components/schemas/DayOfWeek","kind":"json-schema","title":"DayOfWeek","data":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"components/schemas/v1.EviSignSubmit._Options._AffidavitKind":{"id":"components/schemas/v1.EviSignSubmit._Options._AffidavitKind","kind":"json-schema","title":"v1.EviSignSubmit._Options._AffidavitKind","data":{"enum":["Submitted","SubmittedAdvanced","SignatureRequestDispatched","SignatureRequestResult","FinalNotificationDispatched","FinalNotificationResult","PartyCommitted","Attachment","Main","OnDemand","Summary","Event","Failed","AttachmentMasked"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affidavit kinds that can be requested for an EviSign submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit generated when the EviSign is submitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubmittedAdvanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Advanced affidavit generated at submission time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestDispatched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for signature request dispatch."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestResult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for signature request result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationDispatched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for final notification dispatch."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationResult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for final notification result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartyCommitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for party commitment events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for attachment evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for main document evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnDemand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit generated on demand."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Summary affidavit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for generic event evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for failure outcome evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AttachmentMasked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for masked attachment evidence."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignSubmit._Attachment._KeyValue":{"id":"components/schemas/v1.EviSignSubmit._Attachment._KeyValue","kind":"json-schema","title":"v1.EviSignSubmit._Attachment._KeyValue","data":{"type":"object","properties":{"Key":{"type":"string","description":"Attribute key.","nullable":true},"Value":{"type":"string","description":"Attribute value.","nullable":true},"Values":{"type":"array","items":{"type":"string"},"description":"Attribute values.","nullable":true}},"additionalProperties":false,"description":"Key/value metadata item for an attachment."}},"components/schemas/v1.EviSignSubmit._Attachment":{"id":"components/schemas/v1.EviSignSubmit._Attachment","kind":"json-schema","title":"v1.EviSignSubmit._Attachment","data":{"type":"object","properties":{"ContentId":{"type":"string","description":"Attachment content identifier.","nullable":true},"DisplayName":{"type":"string","description":"Attachment display name.","nullable":true},"Filename":{"type":"string","description":"Attachment file name.","nullable":true},"MimeType":{"type":"string","description":"Attachment MIME type.","nullable":true},"ContentDescription":{"type":"string","description":"Attachment content description.","nullable":true},"ContentDisposition":{"type":"string","description":"Attachment content disposition.","nullable":true},"ContentLocation":{"type":"string","description":"Attachment content location.","nullable":true},"ContentEncoding":{"type":"string","description":"Content encoding of the attachment payload.","nullable":true},"Data":{"type":"string","description":"Attachment binary content.","format":"byte","nullable":true},"Attributes":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._Attachment._KeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment key-value attributes (for example, RequireContentCommitment=true)."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":"Attachment payload included in an EviSign submission."}},"components/schemas/v1.EviSignSubmit":{"id":"components/schemas/v1.EviSignSubmit","kind":"json-schema","title":"v1.EviSignSubmit","data":{"required":["Document","Subject"],"type":"object","properties":{"LookupKey":{"type":"string","description":"Client-provided identifier used to look up a specific EviSign.","nullable":true},"Subject":{"minLength":1,"type":"string","description":"Subject line used for the EviSign submission.","pattern":"\\S"},"Document":{"type":"string","description":"Base64-encoded binary content of the main document to be signed.","format":"byte","minLength":1},"SigningParties":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._SigningParty"},"description":"List of signing parties required to sign the document.","nullable":true},"InterestedParties":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._InterestedParty"},"description":"List of interested parties notified about the EviSign lifecycle.","nullable":true},"Options":{"type":"object","properties":{"TimeToLive":{"type":"integer","description":"Lifetime in minutes. Minimum 60, request ceiling 86400; deployment configuration can impose a lower maximum.","format":"int32","nullable":true,"minimum":60,"maximum":86400},"SignatureRequestInfoText":{"type":"string","description":"Informational text shown in signature request notifications.","nullable":true},"LandingPageInfoText":{"type":"string","description":"Informational text shown on the signing landing page.","nullable":true},"FinalNotificationInfoText":{"type":"string","description":"Informational text shown in the final notification.","nullable":true},"SignedRedirectUrl":{"type":"string","description":"URL where signers are redirected after signing successfully.","nullable":true},"EvidenceAccessControlMethod":{"enum":["Public","Challenge","AutoChallenge",null],"type":"string","description":"Access control method required to open evidence in custody.","nullable":true},"EvidenceAccessControlChallenge":{"type":"string","description":"Challenge question used when EvidenceAccessControlMethod is Challenge.","nullable":true},"EvidenceAccessControlChallengeResponse":{"type":"string","description":"Challenge answer used when EvidenceAccessControlMethod is Challenge.","nullable":true},"AttachToSignatureRequest":{"enum":["Nothing","EvidenceAttachments","EvidenceContent","EvidenceContentAndAttachments",null],"type":"string","description":"Indicates how attachments are included in signature request notifications.","nullable":true},"AttachToFinalNotification":{"enum":["Nothing","EvidenceAttachments","EvidenceContent","EvidenceContentAndAttachments",null],"type":"string","description":"Indicates how attachments are included in final notifications.","nullable":true},"AdditionalCommitments":{"type":"array","items":{"type":"string"},"description":"Additional commitments shown during the signing process.","nullable":true},"CustomFields":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._Options._CustomField"},"description":"Custom fields stored as additional metadata on the submitted EviSign.","nullable":true},"NotaryRetentionPeriod":{"type":"integer","description":"Notary custody selection in years. Zero disables notary custody; the current service maps any nonzero requested value to five years. A notary profile is required when enabled.","format":"int32","nullable":true},"NotaryProfile":{"type":"string","description":"Notary profile identifier. Required with a nonzero NotaryRetentionPeriod; a profile without a nonzero period is rejected.","nullable":true},"OnlineRetentionPeriod":{"type":"integer","description":"Online retention period in years.","format":"int32","nullable":true},"CertificationLevel":{"enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE",null],"type":"string","description":"Certification level applied to the submitted evidence.","nullable":true},"FinalRejectedNotificationInfoText":{"type":"string","description":"Informational text shown in rejection notifications.","nullable":true},"SignatureReminderInfoText":{"type":"string","description":"Informational text shown in signature reminder notifications.","nullable":true},"ExpiredNotificationInfoText":{"type":"string","description":"Informational text shown in expiration notifications.","nullable":true},"Language":{"type":"string","description":"UI/content language used for signer-facing pages and notifications.","nullable":true},"AffidavitLanguage":{"type":"string","description":"Language used for affidavit generation.","nullable":true},"SecurityTags":{"type":"array","items":{"type":"string"},"description":"At most one security tag is accepted.","nullable":true,"maxItems":1},"PushNotificationUrl":{"type":"string","description":"Callback URL that receives POST push notifications for message events.","nullable":true},"PushNotificationFilter":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._Options._PushNotification"},"description":"Push notification events to send to PushNotificationUrl.","nullable":true},"CostCentre":{"type":"string","description":"Cost center identifier associated with the submission.","nullable":true},"CommitmentOptions":{"enum":["Accept","Reject","AcceptOrReject",null],"type":"string","description":"Commitment behavior options used in signer interactions.","nullable":true},"CommitmentCommentsAllowed":{"type":"boolean","description":"Indicates whether commitment comments are allowed.","nullable":true},"InterestedPartiesNotifications":{"type":"array","items":{"type":"string"},"description":"Interested-party notification event names to emit.","nullable":true},"GenerateSignedDocument":{"type":"boolean","description":"Indicates whether the signed document should be generated."},"Reminders":{"type":"object","properties":{"Initial":{"type":"string","description":"Initial delay before sending the first reminder.","nullable":true},"Repeat":{"type":"string","description":"Interval used to send repeated reminders.","nullable":true},"Days":{"type":"array","items":{"$ref":"#/components/schemas/DayOfWeek"},"description":"Days of the week when reminders can be sent.","nullable":true},"TimeRange":{"type":"array","items":{"type":"string"},"description":"Allowed daily time range for sending reminders.","nullable":true},"Max":{"type":"integer","description":"Maximum number of reminders to send.","format":"int32"},"Stop":{"type":"string","description":"Condition or limit that stops reminder delivery.","nullable":true},"TimeZone":{"type":"string","description":"Time zone used to evaluate reminder schedule settings.","nullable":true}},"additionalProperties":false,"description":"Reminder scheduling configuration.","nullable":true},"PushNotificationExtraData":{"type":"string","description":"Extra payload included in each push notification callback.","nullable":true},"GenerateSignedDocumentOptions":{"type":"object","properties":{"CertificationCertificate":{"type":"string","description":"Certificate identifier used to generate the signed document.","nullable":true}},"additionalProperties":false,"description":"Configuration used when GenerateSignedDocument is enabled.","nullable":true},"RequireRejectReason":{"type":"boolean","description":"Indicates whether signers must provide a reject reason when rejecting."},"RejectReasons":{"type":"array","items":{"type":"string"},"description":"List of allowed reject reasons presented to signers.","nullable":true},"SummaryAffidavit":{"type":"object","properties":{"Masking":{"type":"array","items":{"type":"string"},"description":"List of masking patterns applied to affidavit content.","nullable":true},"IncludeDocument":{"type":"boolean","description":"Indicates whether the main document is included."},"IncludeAttachments":{"type":"boolean","description":"Indicates whether attachments are included."},"IncludeEvents":{"type":"boolean","description":"Indicates whether events are included."},"IncludedCommitments":{"enum":["None","Signers",null],"type":"string","description":"Optional. Include None or Signers. The generation job uses None when omitted.","nullable":true}},"additionalProperties":false,"description":"Summary affidavit generation settings.","nullable":true},"AffidavitKinds":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._Options._AffidavitKind"},"description":"Explicit affidavit kinds requested for this submission.","nullable":true},"DisablePlatformReferences":{"type":"boolean","description":"Indicates whether platform references should be hidden in generated artifacts.","nullable":true},"OwnerNotificationTemplate":{"type":"string","description":"Owner notification template identifier.","nullable":true},"OwnerNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Placeholder values used to render OwnerNotificationTemplate.","nullable":true},"LtaStorage":{"type":"boolean","description":"Indicates whether long-term archive storage is requested.","nullable":true},"CustomLayoutLogoUrl":{"type":"string","description":"Custom logo URL used by the signature layout.","nullable":true}},"additionalProperties":false,"description":"Optional settings that customize EviSign submission behavior.","nullable":true},"Attachments":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignSubmit._Attachment"},"description":"Optional supporting attachments included with the EviSign submission.","nullable":true},"Issuer":{"type":"string","description":"Display name of the issuer shown to parties.","nullable":true},"From":{"type":"string","description":"Sender email address used for recipient-facing communications.","nullable":true},"DisableSenderHeader":{"type":"boolean","description":"Controls whether the sender header is omitted. Omission sets false, overriding the site default.","default":false},"ReplyTo":{"type":"string","description":"Reply-to email address for recipient responses.","nullable":true}},"additionalProperties":false,"description":"V1 submit contract for creating an EviSign."}},"components/schemas/v1.ErrorResponse._ResponseStatus._Error":{"id":"components/schemas/v1.ErrorResponse._ResponseStatus._Error","kind":"json-schema","title":"v1.ErrorResponse._ResponseStatus._Error","data":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"fieldName":{"type":"string","nullable":true},"message":{"type":"string","nullable":true}},"additionalProperties":false}},"components/schemas/v1.ErrorResponse":{"id":"components/schemas/v1.ErrorResponse","kind":"json-schema","title":"v1.ErrorResponse","data":{"type":"object","properties":{"responseStatus":{"type":"object","properties":{"errorCode":{"type":"string","description":"Holds the custom ErrorCode enum if provided in ValidationException\notherwise will hold the name of the Exception type, e.g. typeof(Exception).Name\n\nA value of non-null means the service encountered an error while processing the request.","nullable":true},"message":{"type":"string","description":"A human friendly error message","nullable":true},"stackTrace":{"type":"string","nullable":true},"errors":{"type":"array","items":{"$ref":"#/components/schemas/v1.ErrorResponse._ResponseStatus._Error"},"description":"For multiple detailed validation errors.\nCan hold a specific error message for each named field.","nullable":true}},"additionalProperties":false,"nullable":true}},"additionalProperties":false,"description":"Legacy ServiceStack-compatible error response contract extracted to a shared plumbing type for V1 endpoints."}},"components/schemas/v1.EviSignSubmit._Result":{"id":"components/schemas/v1.EviSignSubmit._Result","kind":"json-schema","title":"v1.EviSignSubmit._Result","data":{"type":"object","properties":{"uniqueId":{"type":"string","description":"If submission is successful, the unique ID assigned to this EviSign. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","nullable":true,"pattern":"^[0-9a-fA-F]{32}$"}},"additionalProperties":false,"description":"Response envelope for EviSign submit operations."}},"components/schemas/v1.EviSignQuery._State":{"id":"components/schemas/v1.EviSignQuery._State","kind":"json-schema","title":"v1.EviSignQuery._State","data":{"enum":["Draft","Submitted","Processed","Sent","Closed","Forwarded","Received"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing state values for an EviSign entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign is in draft state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign was submitted for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign was processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature requests were sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign lifecycle was closed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Forwarded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Defined state. Matches or describes a stored value; the normal workflow has no transition into it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Defined state. Matches or describes a stored value; the normal workflow has no transition into it."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignQuery._Outcome":{"id":"components/schemas/v1.EviSignQuery._Outcome","kind":"json-schema","title":"v1.EviSignQuery._Outcome","data":{"enum":["None","Signed","Rejected","Failed","Expired","Cancelled"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final outcome values for an EviSign lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"None"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign has no final outcome yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Signed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign was signed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A signing or review party rejected the document and the workflow closed with that result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign processing failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": EviSign expired before completion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cancellation was processed and the EviSign closed."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignQuery._Result._EviSign._SigningParty._SigningMethod":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._SigningParty._SigningMethod","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._SigningParty._SigningMethod","data":{"enum":["WebClick","MobilePin","EmailPin","Challenge","Handwriting","ExternalHandwriting","UserCertificate"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signing methods supported for EviSign signing parties."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WebClick"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature by web click confirmation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MobilePin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature with mobile PIN verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EmailPin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature with email PIN verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature with challenge-response verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Handwriting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature by handwriting input."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ExternalHandwriting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature by external handwriting provider."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserCertificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signature using a user digital certificate."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignQuery._Result._EviSign._SignatureField":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._SignatureField","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._SignatureField","data":{"type":"object","properties":{"key":{"type":"string","description":"Field key.","nullable":true},"value":{"type":"string","description":"Field value.","nullable":true}},"additionalProperties":false,"description":"Key/value field captured as part of a signature."}},"components/schemas/v1.EviSignQuery._Result._EviSign._SigningParty":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._SigningParty","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._SigningParty","data":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier of the signing party. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"name":{"type":"string","description":"Display name of the signing party.","nullable":true},"address":{"type":"string","description":"Notification address used to reach the signer.","nullable":true},"signingMethod":{"allOf":[{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._SigningParty._SigningMethod"}],"description":"Signature method used by the party."},"signatureFields":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._SignatureField"},"description":"Signature field values captured for the party.","nullable":true},"signatureComments":{"type":"string","description":"Optional signature comments configured for the party.","nullable":true},"legalName":{"type":"string","description":"Legal name of the signing party.","nullable":true},"role":{"enum":["Signer","Reviewer","Interested",null],"type":"string","description":"Role assigned to the party in the signing flow.","nullable":true},"finalNotificationAddress":{"type":"string","description":"Address used for final notifications.","nullable":true},"signingOrder":{"type":"integer","description":"Sequential signing order assigned to this party.","format":"int32","nullable":true},"personIdKind":{"type":"string","description":"Type of personal identifier associated with the signer.","nullable":true},"personId":{"type":"string","description":"Value of the personal identifier associated with the signer.","nullable":true},"entityIdKind":{"type":"string","description":"Type of entity identifier associated with the signer.","nullable":true},"entityId":{"type":"string","description":"Value of the entity identifier associated with the signer.","nullable":true},"signatureRequestPolicy":{"enum":["SmsOnly","WhatsAppOnly","SmsThenWhatsApp","WhatsAppThenSms",null],"type":"string","description":"Preferred channel policy for signature request notifications.","nullable":true}},"additionalProperties":false,"description":"Signing party linked to an EviSign entry."}},"components/schemas/v1.EviSignQuery._Result._EviSign._InterestedParty":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._InterestedParty","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._InterestedParty","data":{"type":"object","properties":{"partyId":{"type":"string","description":"Unique identifier of the interested party. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"address":{"type":"string","description":"Notification address of the interested party.","nullable":true}},"additionalProperties":false,"description":"Interested party linked to an EviSign entry."}},"components/schemas/v1.EviSignQuery._Result._EviSign._Affidavit":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._Affidavit","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._Affidavit","data":{"type":"object","properties":{"uniqueId":{"type":"string","description":"Unique identifier of the affidavit. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"date":{"type":"string","description":"Date and time when the affidavit was issued.","format":"date-time"},"evidenceUniqueId":{"type":"string","description":"Unique identifier of the related evidence. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"partyUniqueId":{"type":"string","description":"Unique identifier of the related party. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"bytes":{"type":"string","description":"Raw affidavit document bytes.","format":"byte","nullable":true},"description":{"type":"string","description":"Affidavit description.","nullable":true},"kind":{"type":"string","description":"Affidavit kind identifier.","nullable":true},"additionalData":{"type":"object","additionalProperties":{"type":"string","nullable":true},"description":"Additional affidavit metadata as key-value pairs.","nullable":true}},"additionalProperties":false,"description":"Affidavit metadata and optional binary payload associated with an EviSign entry."}},"components/schemas/v1.EviSignQuery._Result._EviSign._Attachment._KeyValue":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._Attachment._KeyValue","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._Attachment._KeyValue","data":{"type":"object","properties":{"key":{"type":"string","description":"Attribute key.","nullable":true},"value":{"type":"string","description":"Attribute value.","nullable":true}},"additionalProperties":false,"description":"Key/value attribute item attached to an attachment."}},"components/schemas/v1.EviSignQuery._Result._EviSign._Attachment":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._Attachment","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._Attachment","data":{"type":"object","properties":{"uniqueId":{"type":"string","description":"Unique identifier of the attachment. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"creationDate":{"type":"string","description":"Date and time when the attachment was created.","format":"date-time","nullable":true},"evidenceUniqueId":{"type":"string","description":"Unique identifier of the related evidence. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"partyId":{"type":"string","description":"Related party identifier, when available. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","nullable":true,"pattern":"^[0-9a-fA-F]{32}$"},"contentId":{"type":"string","description":"Content identifier of the attachment.","nullable":true},"displayName":{"type":"string","description":"Display name of the attachment.","nullable":true},"filename":{"type":"string","description":"File name of the attachment.","nullable":true},"mimeType":{"type":"string","description":"MIME type of the attachment content.","nullable":true},"contentDescription":{"type":"string","description":"Content description.","nullable":true},"contentDisposition":{"type":"string","description":"Content disposition.","nullable":true},"contentLocation":{"type":"string","description":"Content location.","nullable":true},"contentEncoding":{"type":"string","description":"Content encoding.","nullable":true},"contentLength":{"type":"integer","description":"Content length in bytes.","format":"int32"},"hash":{"type":"string","description":"Content hash.","nullable":true},"data":{"type":"string","description":"Raw attachment data.","format":"byte","nullable":true},"attributes":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._Attachment._KeyValue"},"description":"Attachment attributes as key-value pairs.","nullable":true}},"additionalProperties":false,"description":"Attachment metadata and optional binary payload associated with an EviSign entry."}},"components/schemas/v1.EviSignQuery._Result._EviSign._Signature":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._Signature","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._Signature","data":{"type":"object","properties":{"partyId":{"type":"string","description":"Identifier of the party that produced the signature. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"deliveredOn":{"type":"string","description":"Date and time when the signature request was delivered.","format":"date-time","nullable":true},"signedOn":{"type":"string","description":"Date and time when the party signed.","format":"date-time","nullable":true},"accepted":{"type":"boolean","description":"Indicates whether the party accepted the document.","nullable":true},"signatureFields":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._SignatureField"},"description":"Signature field values submitted by the party.","nullable":true},"signatureComments":{"type":"string","description":"Optional comments provided by the party when signing.","nullable":true},"additionalCommitments":{"type":"array","items":{"type":"string"},"description":"Additional commitments accepted by the party.","nullable":true}},"additionalProperties":false,"description":"Signature evidence captured for a signing party."}},"components/schemas/v1.EviSignQuery._Result._EviSign._Document":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._Document","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._Document","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"kind":{"type":"string","description":"Document kind identifier.","nullable":true},"createdOn":{"type":"string","description":"Date and time when the document was created.","format":"date-time"},"eventId":{"type":"string","description":"Related event identifier when available. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","nullable":true,"pattern":"^[0-9a-fA-F]{32}$"},"eventType":{"type":"string","description":"Related event type when available.","nullable":true},"partyId":{"type":"string","description":"Related party identifier when available. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","nullable":true,"pattern":"^[0-9a-fA-F]{32}$"},"hash":{"type":"string","description":"Document content hash.","nullable":true},"length":{"type":"integer","description":"Document content length in bytes.","format":"int32"}},"additionalProperties":false,"description":"Document metadata generated for an EviSign entry."}},"components/schemas/v1.EviSignQuery._Result._EviSign._AffidavitKind":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign._AffidavitKind","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign._AffidavitKind","data":{"enum":["Submitted","SubmittedAdvanced","SignatureRequestDispatched","SignatureRequestResult","FinalNotificationDispatched","FinalNotificationResult","PartyCommitted","Attachment","Main","OnDemand","Summary","Event","Failed","AttachmentMasked"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affidavit kinds that can be requested for an EviSign submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit generated when the EviSign is submitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubmittedAdvanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Advanced affidavit generated at submission time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestDispatched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for signature request dispatch."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SignatureRequestResult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for signature request result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationDispatched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for final notification dispatch."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FinalNotificationResult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for final notification result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PartyCommitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for party commitment events."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for attachment evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Main"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for main document evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnDemand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit generated on demand."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Summary affidavit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for generic event evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for failure outcome evidence."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AttachmentMasked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Affidavit for masked attachment evidence."},"children":[]}]}]}]}]}},"components/schemas/v1.EviSignQuery._Result._EviSign":{"id":"components/schemas/v1.EviSignQuery._Result._EviSign","kind":"json-schema","title":"v1.EviSignQuery._Result._EviSign","data":{"type":"object","properties":{"evidenceId":{"type":"string","description":"Unique identifier of the EviSign evidence. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","pattern":"^[0-9a-fA-F]{32}$"},"lookupKey":{"type":"string","description":"Client-provided lookup key.","nullable":true},"subject":{"type":"string","description":"Subject associated with the EviSign entry.","nullable":true},"document":{"type":"string","description":"Main document bytes when included in the response.","format":"byte","nullable":true},"state":{"allOf":[{"$ref":"#/components/schemas/v1.EviSignQuery._State"}],"description":"Current processing state."},"outcome":{"allOf":[{"$ref":"#/components/schemas/v1.EviSignQuery._Outcome"}],"description":"Current or final processing outcome."},"creationDate":{"type":"string","description":"Creation date of the EviSign entry.","format":"date-time"},"lastStateChangeDate":{"type":"string","description":"Date of the most recent state transition.","format":"date-time"},"submittedOn":{"type":"string","description":"Date when the EviSign was submitted.","format":"date-time","nullable":true},"processedOn":{"type":"string","description":"Date when the EviSign was processed.","format":"date-time","nullable":true},"sentOn":{"type":"string","description":"Date when signature requests were sent.","format":"date-time","nullable":true},"closedOn":{"type":"string","description":"Date when the EviSign lifecycle was closed.","format":"date-time","nullable":true},"signedOn":{"type":"string","description":"Date associated with closure with the Signed outcome.","format":"date-time","nullable":true},"rejectedOn":{"type":"string","description":"Date when the EviSign was rejected.","format":"date-time","nullable":true},"failedOn":{"type":"string","description":"Date when the EviSign failed.","format":"date-time","nullable":true},"expiredOn":{"type":"string","description":"Date when the EviSign expired.","format":"date-time","nullable":true},"signingParties":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._SigningParty"},"description":"Signing parties linked to this EviSign entry.","nullable":true},"interestedParties":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._InterestedParty"},"description":"Interested parties linked to this EviSign entry.","nullable":true},"affidavits":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._Affidavit"},"description":"Affidavits linked to this EviSign entry.","nullable":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._Attachment"},"description":"Attachments included in the EviSign entry.","nullable":true},"issuer":{"type":"string","description":"Issuer associated with the EviSign entry.","nullable":true},"timeToLive":{"type":"integer","description":"Time to live configured for the EviSign lifecycle.","format":"int32"},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._Signature"},"description":"Signatures captured for the EviSign parties.","nullable":true},"costCentre":{"type":"string","description":"Cost center associated with the EviSign entry.","nullable":true},"onlineRetentionPeriod":{"type":"integer","description":"Online retention period configured for the evidence.","format":"int32","nullable":true},"notaryRetentionPeriod":{"type":"integer","description":"Notary retention period configured for the evidence.","format":"int32","nullable":true},"notaryProfile":{"type":"string","description":"Notary profile identifier used for retention.","nullable":true},"documents":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._Document"},"description":"Documents generated for this EviSign entry.","nullable":true},"sourceChannel":{"type":"string","description":"Source channel used to create the EviSign entry.","nullable":true},"reminder":{"type":"object","properties":{"initial":{"type":"string","description":"Initial delay before sending the first reminder.","nullable":true},"repeat":{"type":"string","description":"Interval used to send repeated reminders.","nullable":true},"days":{"type":"array","items":{"$ref":"#/components/schemas/DayOfWeek"},"description":"Days of the week when reminders can be sent.","nullable":true},"timeRange":{"type":"array","items":{"type":"string"},"description":"Allowed daily time range for sending reminders.","nullable":true},"max":{"type":"integer","description":"Maximum number of reminders to send.","format":"int32"},"stop":{"type":"string","description":"Condition or limit that stops reminder delivery.","nullable":true},"timeZone":{"type":"string","description":"Time zone used to evaluate reminder schedule settings.","nullable":true}},"additionalProperties":false,"description":"Reminder configuration used for signer notifications.","nullable":true},"cancelComments":{"type":"string","description":"Comments provided when the EviSign was cancelled.","nullable":true},"affidavitKinds":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign._AffidavitKind"},"description":"Requested affidavit kinds for this EviSign entry.","nullable":true},"from":{"type":"string","description":"Sender address used in notifications.","nullable":true}},"additionalProperties":false,"description":"EviSign entry returned by the query operation."}},"components/schemas/v1.EviSignQuery._Result":{"id":"components/schemas/v1.EviSignQuery._Result","kind":"json-schema","title":"v1.EviSignQuery._Result","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v1.EviSignQuery._Result._EviSign"},"description":"Query results.","nullable":true},"totalMatches":{"type":"integer","description":"Total number of entries that match the query criteria.","format":"int32","nullable":true}},"additionalProperties":false,"description":"Response envelope for EviSign query results."}},"components/schemas/v1.EviSignCancel":{"id":"components/schemas/v1.EviSignCancel","kind":"json-schema","title":"v1.EviSignCancel","data":{"required":["UniqueId","Comments"],"type":"object","properties":{"UniqueId":{"type":"string","description":"Unique identifier of the EviSign to cancel.","format":"uuid","not":{"enum":["00000000-0000-0000-0000-000000000000"]}},"Comments":{"minLength":1,"type":"string","description":"Required, nonblank reason for cancelling. Maximum 2048 characters.","maxLength":2048,"pattern":"\\S"},"Quietly":{"type":"boolean","description":"Indicates whether cancellation should be processed without notifying parties."}},"additionalProperties":false,"description":"V1 request contract for cancelling an existing EviSign."}},"components/schemas/v1.EviSignCancel._Result":{"id":"components/schemas/v1.EviSignCancel._Result","kind":"json-schema","title":"v1.EviSignCancel._Result","data":{"type":"object","properties":{"uniqueId":{"type":"string","description":"Unique identifier of the cancelled EviSign. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","nullable":true,"pattern":"^[0-9a-fA-F]{32}$"}},"additionalProperties":false,"description":"Response envelope for EviSign cancellation requests."}},"components/schemas/v1.EviSignResend":{"id":"components/schemas/v1.EviSignResend","kind":"json-schema","title":"v1.EviSignResend","data":{"required":["UniqueId","NotificationAddress"],"type":"object","properties":{"UniqueId":{"type":"string","description":"Unique identifier of the EviSign for which the signature request will be resent.","format":"uuid","not":{"enum":["00000000-0000-0000-0000-000000000000"]}},"NotificationAddress":{"minLength":1,"type":"string","description":"Notification address of the signing party to whom the signature request will be resent."}},"additionalProperties":false,"description":"V1 request contract for resending a signature request for an existing EviSign."}},"components/schemas/v1.EviSignResend._Result":{"id":"components/schemas/v1.EviSignResend._Result","kind":"json-schema","title":"v1.EviSignResend._Result","data":{"type":"object","properties":{"uniqueId":{"type":"string","description":"Unique identifier of the related EviSign. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","nullable":true,"pattern":"^[0-9a-fA-F]{32}$"},"notificationAddress":{"type":"string","description":"Party notification address to which the signature request was resent.","nullable":true}},"additionalProperties":false,"description":"Response envelope for EviSign resend requests."}},"components/schemas/v1.EviSignAffidavitRequest":{"id":"components/schemas/v1.EviSignAffidavitRequest","kind":"json-schema","title":"v1.EviSignAffidavitRequest","data":{"type":"object","properties":{"UniqueId":{"type":"string","description":"Unique identifier of the EviSign for which an on-demand affidavit is requested.","format":"uuid","not":{"enum":["00000000-0000-0000-0000-000000000000"]}},"IncludeDocument":{"type":"boolean","description":"Indicates whether the affidavit should include EviSign document content."},"IncludeAttachments":{"type":"boolean","description":"Indicates whether the affidavit should include EviSign attachments.\nOnly attachments submitted with RequireContentCommitment enabled are included."},"IncludeEvents":{"type":"boolean","description":"Indicates whether the affidavit should include detailed EviSign event information."},"IncludedCommitments":{"enum":["None","Signers",null],"type":"string","description":"Optional. Include None or Signers. The generation job uses None when omitted.","nullable":true},"Masking":{"type":"array","items":{"type":"string"},"description":"Optional masking directives to obfuscate sensitive data in the generated affidavit output.","nullable":true}},"additionalProperties":false,"description":"V1 request contract for requesting on-demand affidavit generation for an existing EviSign.","required":["UniqueId"]}},"components/schemas/v1.EviSignAffidavitRequest._Result":{"id":"components/schemas/v1.EviSignAffidavitRequest._Result","kind":"json-schema","title":"v1.EviSignAffidavitRequest._Result","data":{"type":"object","properties":{"requestId":{"type":"string","description":"Unique identifier assigned to this affidavit request for correlation. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.","nullable":true,"pattern":"^[0-9a-fA-F]{32}$"}},"additionalProperties":false,"description":"Response envelope for on-demand EviSign affidavit requests."}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}},"components/schemas/EviSignSignLinkAttribute":{"id":"components/schemas/EviSignSignLinkAttribute","kind":"json-schema","title":"EviSignSignLinkAttribute","data":{"type":"object","required":["Key","Value"],"properties":{"Key":{"type":"string","enum":["ReturnUrl"]},"Value":{"type":"string","format":"uri","pattern":"^https?://","description":"Absolute HTTP(S) redirect URL. uniqueId and accepted query parameters are added after the party finishes."},"Values":{"type":"array","items":{"type":"string"},"description":"Legacy contract member; ignored. Omit it."}}}},"components/schemas/EviSignSignLinkRequest":{"id":"components/schemas/EviSignSignLinkRequest","kind":"json-schema","title":"EviSignSignLinkRequest","data":{"type":"object","required":["UniqueIds","Party"],"properties":{"UniqueIds":{"type":"array","minItems":1,"items":{"type":"string","format":"uuid"},"description":"EviSign identifiers. A configured maximum defaults to 25; duplicate input identifiers count towards the limit."},"Party":{"type":"string","minLength":1,"description":"Email address or phone number of exactly one signer or reviewer per included EviSign."},"Attributes":{"type":"array","items":{"$ref":"#/components/schemas/EviSignSignLinkAttribute"},"description":"Only ReturnUrl is supported. Each key must occur once."},"DiscardedThreshold":{"type":"integer","default":0,"minimum":0,"description":"Maximum count of discarded EviSigns, not a percentage. At least one valid item must remain."},"LiteFlow":{"type":"boolean","nullable":true,"description":"Single-item flow only. True requests Lite Flow; false forces standard flow; omitted uses delivery configuration. Ignored for multiple valid items."},"Language":{"type":"string","enum":["ca","de","en","es","fr","it","pt","pt-BR","ro","el"],"description":"Case-sensitive language for multiple-item flow. Validated but not applied for single-item flow."}}}},"components/schemas/EviSignSignLinkItem":{"id":"components/schemas/EviSignSignLinkItem","kind":"json-schema","title":"EviSignSignLinkItem","data":{"type":"object","properties":{"evidenceId":{"type":"string","description":"Requested EviSign identifier.","format":"uuid"},"discarded":{"type":"boolean"},"discardReason":{"type":"string","description":"Reason for exclusion; null for accepted items.","nullable":true},"lookupKey":{"type":"string","description":"Client lookup key.","nullable":true},"state":{"type":"string","nullable":true,"enum":["Draft","Submitted","Processed","Sent","Closed","Forwarded","Received"]},"outcome":{"type":"string","nullable":true,"enum":["None","Signed","Rejected","Failed","Expired","Cancelled"]},"creationDate":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","format":"date-time"},"lastStateChangeDate":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"submittedOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"processedOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"sentOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"closedOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"signedOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"rejectedOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"failedOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"expiredOn":{"type":"string","description":"EviSign timestamp; unavailable metadata on discarded items must not be interpreted.","nullable":true,"format":"date-time"},"timeToLive":{"type":"integer","description":"Lifetime in minutes from submittedOn; ignore default values for discarded items."}}}},"components/schemas/EviSignSignLinkResponse":{"id":"components/schemas/EviSignSignLinkResponse","kind":"json-schema","title":"EviSignSignLinkResponse","data":{"type":"object","properties":{"uniqueId":{"type":"string","description":"SignLink operation ID, not the EviSign ID.","format":"uuid"},"url":{"type":"string","description":"Sensitive opaque signing URL. Use exactly as returned; its host follows the configured brand.","format":"uri"},"expiresAt":{"type":"string","description":"UTC expiration, one hour after creation.","format":"date-time"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EviSignSignLinkItem"}}}}},"components/schemas/EviSignSignLinkError":{"id":"components/schemas/EviSignSignLinkError","kind":"json-schema","title":"EviSignSignLinkError","data":{"type":"object","properties":{"responseStatus":{"type":"object","properties":{"errorCode":{"type":"string","description":"Diagnostic text: may be an exception name or a localized status description. Branch on HTTP status, not this value."},"message":{"type":"string"},"stackTrace":{"type":"string","nullable":true},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"fieldName":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"stackTrace":{"type":"string","nullable":true}}}},"errorId":{"type":"string","format":"uuid"},"statusCode":{"type":"integer"}}}}}},"components/schemas/EviPostAddress":{"id":"components/schemas/EviPostAddress","kind":"json-schema","title":"EviPostAddress","data":{"type":"object","required":["StreetAddress","PostalCode","Locality","Country"],"properties":{"StreetAddress":{"type":"string","description":"Street name and number. Maximum 100 characters for the recipient and 255 for the issuer."},"PostalCode":{"type":"string","description":"Postal code."},"Locality":{"type":"string","description":"City or town."},"Region":{"type":"string","description":"Province or region. Required in RecipientAddress when PostServiceType is Registered. The issuer region must also be present, either supplied in IssuerAddress or filled from the site address.\n"},"Country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. ES)."},"PostOfficeBoxAddress":{"type":"string","description":"Post office box address, if applicable."}}}},"components/schemas/EviPostCustomField":{"id":"components/schemas/EviPostCustomField","kind":"json-schema","title":"EviPostCustomField","data":{"type":"object","required":["Key","Label","Value","TypeName"],"properties":{"Key":{"type":"string","description":"Identifier of the custom field."},"Label":{"type":"string","description":"Display label for the field."},"Value":{"type":"string","description":"Value of the custom field."},"IsLookupKey":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, this value is indexed and surfaced in query results under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"TypeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field type. Currently only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"enum":["Text"]},"DefaultValue":{"type":"string"},"DefaultValueIsForced":{"type":"boolean"},"Required":{"type":"boolean"},"ValidationRegex":{"type":"string","description":"Regex expression to validate the field value."},"ValidationMessage":{"type":"string","description":"Message shown when validation fails."},"MaxLength":{"type":"integer","description":"Maximum character length of the field value."}}}},"components/schemas/EviPostOptions":{"id":"components/schemas/EviPostOptions","kind":"json-schema","title":"EviPostOptions","data":{"type":"object","properties":{"PostServiceType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the type of postal delivery. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sends a certified postal communication equivalent to a burofax (via the national postal operator, Correos); enabling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receipt, attempt or disposal options or passing non-zero attempts or disposal days returns 400. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sends to a printing and enveloping provider (MRW). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a single-attempt printed letter available only within mainland Spain; omit the attempt and disposal options. Sites billed per submission cannot use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}],"enum":["Registered","Letter","LetterLite"],"default":"Registered"},"PostServiceProfile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional provider profile for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit it unless support has given you a profile identifier."},"children":[]}]}]}]},"CertificationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal framework and geographic variant for certification. Supported values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and their regional variants, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Availability depends on the account. EviPost does not support QERDS certification levels. Supply the level explicitly; the API does not use the Web form’s account default."},"children":[]}]}]}],"enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE"]},"AffidavitProfile":{"type":"string","description":"Controls which affidavits are generated during the process.","enum":["None","Basic","AdvancedContentOnSubmit","AdvancedContentOnClose","AdvancedContentOnSubmitAndOnClose"]},"AffidavitsOnDemandEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set at Submit for an advanced content profile to enable on-demand affidavit requests on an open "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A configurable limit applies per communication. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts the flag at Submit but cannot use AffidavitRequest."},"children":[]}]}]}]},"OnlineRetentionPeriod":{"type":"integer","description":"Online evidence retention in years. Currently 1 year by default.","minimum":1,"maximum":20},"NotaryRetentionPeriod":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to 5 for five years of custody or 0 to disable. Any non-zero value applies five years. Supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotaryProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a positive value."},"children":[]}]}]}]},"NotaryProfile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioned notary profile. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotaryRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than 0; omit otherwise. Use non-empty alphanumeric segments separated by colons, up to 50 characters in total."},"children":[]}]}]}],"pattern":"^[A-Za-z0-9]+(:[A-Za-z0-9]+)*$","maxLength":50},"EvidenceAccessControlMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how recipients access the evidence record. If omitted, the API uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no access challenge). Set the method explicitly. When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlChallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlChallengeResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be supplied."},"children":[]}]}]}],"enum":["AutoChallenge","Public","Challenge"]},"EvidenceAccessControlChallenge":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenge question. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"EvidenceAccessControlChallengeResponse":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Answer to the challenge question. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Language":{"type":"string","description":"Language for the evidence record and generated affidavits. Defaults to the site's configured language when omitted.\n","enum":["en","es","ca","it","pt","pt-BR","fr","de","ro"]},"CostCentre":{"type":"string","description":"Optional billing group identifier. Groups submissions for invoicing and expense allocation.\n"},"EnableDeliveryReceipt":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type only. Enables delivery receipt tracking."},"children":[]}]}]}]},"EnableDeliveryAttempts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": set to true with a positive DeliveryAttemptsNumber."},"children":[]}]}]}]},"DeliveryAttemptsNumber":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive number requires EnableDeliveryAttempts: true. The maximum is currently 2 by default."},"children":[]}]}]}],"minimum":0},"CustomFields":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of custom key-value fields attached to the submission. Fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IsLookupKey: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are indexed and returned in query results under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", concatenated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not combine them with a top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/EviPostCustomField"}},"PushNotificationUrl":{"type":"string","format":"uri","description":"URL to receive HTTP POST callbacks when the postal communication changes state.\n"},"PushNotificationFilter":{"type":"array","description":"Event names that trigger callbacks. Supply both the URL and a non-empty filter, or omit both. Submit returns 400 if only one is set or if the filter repeats a value. AffidavitPublished is an event, not a state.\n","uniqueItems":true,"items":{"type":"string","enum":["Processed","Dispatched","Sent","Delivered","Closed","Cancelled","Issued","Disposed","AffidavitPublished"]}},"PushNotificationExtraData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text value included in every callback payload under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdditionalData.ExtraData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"EnableDisposal":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; set to true with a positive DisposalDaysAmmount."},"children":[]}]}]}]},"DisposalDaysAmmount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": set to 0 for no disposal, or 1 to 15 with EnableDisposal set to true. The field retains its original spelling."},"children":[]}]}]}],"minimum":0,"maximum":15},"OwnerNotificationTemplate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of an enabled custom template used for the issuer's status notification email. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/it/products/namirialnotify/dev/templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using communication templates from the API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OwnerNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate."},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the evidence for this transaction is stored in Namirial Archive during post-close processing after tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnlineRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separately controls online accessibility."},"children":[]}]}]}]}}}},"components/schemas/EviPostSubmitRequest":{"id":"components/schemas/EviPostSubmitRequest","kind":"json-schema","title":"EviPostSubmitRequest","data":{"type":"object","required":["Document","RecipientName","RecipientAddress"],"properties":{"LookupKey":{"type":"string","description":"Optional identifier set by the issuer. Can be used later to locate the evidence via the Query endpoint.\n"},"Document":{"type":"string","description":"The document or letter to be sent, base64-encoded PDF."},"RecipientName":{"type":"string","description":"Non-blank display name of the recipient.","pattern":"\\S"},"RecipientLegalName":{"type":"string","description":"Legal name or corporate name of the recipient."},"RecipientAddress":{"$ref":"#/components/schemas/EviPostAddress"},"RecipientPhone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient phone number. Use + followed by the country code and phone number, with digits only."},"children":[]}]}]}]},"RecipientEmail":{"type":"string","format":"email","description":"Email address of the recipient."},"IssuerName":{"type":"string","description":"Display name of the sender. Supply it explicitly to record it in the evidence."},"IssuerLegalName":{"type":"string","description":"Legal or corporate name of the sender. Supply it explicitly to record it in the evidence."},"IssuerAddress":{"$ref":"#/components/schemas/EviPostAddress"},"IssuerPhone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuer phone number. Use + followed by the country code and phone number, with digits only."},"children":[]}]}]}]},"IssuerEmail":{"type":"string","format":"email","description":"Email address of the issuer."},"IssuerComments":{"type":"string","description":"Optional additional comments from the issuer."},"Options":{"$ref":"#/components/schemas/EviPostOptions"}}}},"components/schemas/EviPostSubmitResponse":{"id":"components/schemas/EviPostSubmitResponse","kind":"json-schema","title":"EviPostSubmitResponse","data":{"type":"object","required":["uniqueId"],"properties":{"uniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the submitted postal communication. Serialized as 32 hexadecimal characters without dashes."}}}},"components/schemas/EviPostError":{"id":"components/schemas/EviPostError","kind":"json-schema","title":"EviPostError","data":{"type":"object","properties":{"responseStatus":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}},"components/schemas/EviPostAffidavit":{"id":"components/schemas/EviPostAffidavit","kind":"json-schema","title":"EviPostAffidavit","data":{"type":"object","description":"Affidavit metadata and optional legacy Base64 content associated with a postal communication.","properties":{"uniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the affidavit. Serialized as 32 hexadecimal characters without dashes."},"date":{"type":"string","format":"date-time","description":"Creation timestamp of the affidavit."},"evidenceUniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the evidence this affidavit belongs to. Serialized as 32 hexadecimal characters without dashes."},"partyUniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Identifier of the related delivery/party, when applicable. Serialized as 32 hexadecimal characters without dashes."},"bytes":{"type":"string","format":"byte","nullable":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded affidavit PDF, populated when blob inclusion is enabled. Send IncludeAffidavitBlobsOnResult=false for metadata only."},"children":[]}]}]}]},"description":{"type":"string","description":"Human-readable description of the affidavit."},"kind":{"type":"string","description":"Technical identifier of the affidavit kind, when available."},"additionalData":{"type":"object","description":"Additional affidavit metadata as key-value pairs.","additionalProperties":{"type":"string"}}}}},"components/schemas/EviPostQueryResult":{"id":"components/schemas/EviPostQueryResult","kind":"json-schema","title":"EviPostQueryResult","data":{"type":"object","description":"Individual query result object. Unlike the request body (which uses PascalCase field names), the v1 EviPost query response serialises field names in camelCase.\n","properties":{"evidenceId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the postal communication. Serialized as 32 hexadecimal characters without dashes."},"lookupKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lookup key set at submission. If multiple CustomFields were indexed, values are concatenated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"recipientName":{"type":"string"},"address":{"type":"object","description":"Recipient postal address. Returned with camelCase field names.","properties":{"streetAddress":{"type":"string"},"postalCode":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. ES)."},"postOfficeBoxAddress":{"type":"string"}}},"document":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded original document. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludeDocumentOnResult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true."},"children":[]}]}]}]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current lifecycle state. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Undelivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records reported non-delivery but does not itself close tracking. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with delivery tracking enabled, the platform accepts a later valid delivery report before closure; the operator sequence is unconfirmed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot complete normal closure with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once non-delivery has been recorded. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" workflow configured for disposal can continue to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a later failure report for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can instead lead to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before closure. Individual delivery attempts are events and do not necessarily change the state. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may appear for transitional internal states; contact support if seen in production responses."},"children":[]}]}]}],"enum":["Draft","Submitted","Processed","Sent","Dispatched","Delivered","Missing","Closed","Issued","Failed","Undelivered","Disposed","Cancelled"]},"stateDate":{"type":"string","format":"date-time","description":"Date of the recorded state."},"lastStateChangeDate":{"type":"string","format":"date-time","description":"Date when the platform last updated the state or online retention expiry."},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result recorded so far; it may change while the communication is open. Treat this as the final postal result when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Undelivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not by itself identify an item awaiting collection or a return-to-sender action. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is listed in the contract but is not supported as the outcome of normal postal closure. A tracking timeout does not automatically assign "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; check the current state with Query and contact support if it appears. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may appear for transitional internal states; contact support if seen in production responses."},"children":[]}]}]}],"enum":["None","Delivered","Dispatched","Acknowledged","Declined","Hindered","Cancelled","Expired","Failed","Sent","Rejected","Undelivered","Disposed"]},"outcomeDate":{"type":"string","format":"date-time","description":"Date assigned to the outcome."},"creationDate":{"type":"string","format":"date-time"},"submittedOn":{"type":"string","format":"date-time"},"processedOn":{"type":"string","format":"date-time"},"dispatchedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"},"deliveredOn":{"type":"string","format":"date-time"},"closedOn":{"type":"string","format":"date-time"},"issuedOn":{"type":"string","format":"date-time","description":"Timestamp when the postal item was issued."},"timeToLive":{"type":"integer","description":"Tracking window in minutes: 50400 for Registered and 21600 for Letter or LetterLite. A timeout does not set the Expired outcome.\n"},"costCentre":{"type":"string","description":"Cost-centre label recorded with the transaction for internal billing allocation."},"onlineRetentionPeriod":{"type":"integer"},"notaryRetentionPeriod":{"type":"integer"},"notaryProfile":{"type":"string"},"sourceChannel":{"type":"string","enum":["Web","Api","Smtp"]},"enableDeliveryReceipt":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. Whether delivery receipt tracking is enabled."},"children":[]}]}]}]},"deliveryAttemptsNumber":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. Number of delivery attempts configured before the process ends."},"children":[]}]}]}]},"disposalDaysAmmount":{"type":"integer","description":"Number of days after which an undelivered postal item is disposed of. (Note: the field name retains its original spelling in the API.)\n"},"affidavits":{"type":"array","description":"Affidavit entries. Set IncludeAffidavitsOnResult to true to retrieve metadata. Some deployments embed PDFs unless IncludeAffidavitBlobsOnResult is explicitly false.\n","items":{"$ref":"#/components/schemas/EviPostAffidavit"}}}}},"components/schemas/EviPostQueryResponse":{"id":"components/schemas/EviPostQueryResponse","kind":"json-schema","title":"EviPostQueryResponse","data":{"type":"object","properties":{"totalMatches":{"type":"integer","description":"Total number of records matching the query filters."},"results":{"type":"array","items":{"$ref":"#/components/schemas/EviPostQueryResult"}}}}},"components/schemas/EviPostAffidavitRequest":{"id":"components/schemas/EviPostAffidavitRequest","kind":"json-schema","title":"EviPostAffidavitRequest","data":{"type":"object","required":["UniqueId"],"properties":{"UniqueId":{"type":"string","format":"uuid","description":"Unique ID of the EviPost to generate an affidavit for."},"IncludeDocument":{"type":"boolean","description":"If true, the document is included in the affidavit."},"IncludeEvents":{"type":"boolean","description":"If true, detailed event information is included in the affidavit.\n"}}}},"components/schemas/EviPostAffidavitResponse":{"id":"components/schemas/EviPostAffidavitResponse","kind":"json-schema","title":"EviPostAffidavitResponse","data":{"type":"object","required":["requestId"],"properties":{"requestId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Identifier of the affidavit generation request, serialized as 32 hexadecimal characters without dashes."}}}},"components/schemas/EviPostCancelRequest":{"id":"components/schemas/EviPostCancelRequest","kind":"json-schema","title":"EviPostCancelRequest","data":{"type":"object","required":["UniqueId"],"properties":{"UniqueId":{"type":"string","format":"uuid","description":"The unique ID of the postal communication to cancel, as returned at submission."}}}},"components/schemas/EviPostCancelResponse":{"id":"components/schemas/EviPostCancelResponse","kind":"json-schema","title":"EviPostCancelResponse","data":{"type":"object","properties":{"uniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"The unique ID of the communication whose cancellation request was accepted; cancellation is not yet confirmed. Serialized as 32 hexadecimal characters without dashes."}}}},"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"type":"object","description":"Attachment metadata and base64-encoded content.","properties":{"uniqueId":{"type":"string","format":"uuid","description":"Unique identifier of the attachment."},"creationDate":{"type":"string","format":"date-time","description":"Date and time the attachment was created."},"evidenceUniqueId":{"type":"string","format":"uuid","description":"Identifier of the evidence the attachment belongs to."},"partyId":{"type":"string","format":"uuid","nullable":true,"description":"Identifier of the related party, when applicable."},"contentId":{"type":"string","description":"Content identifier of the attachment."},"displayName":{"type":"string","description":"Display name of the attachment."},"filename":{"type":"string","description":"File name of the attachment."},"mimeType":{"type":"string","description":"MIME type of the attachment content."},"contentDescription":{"type":"string","description":"Content description."},"contentDisposition":{"type":"string","description":"Content disposition."},"contentLocation":{"type":"string","description":"Content location."},"contentEncoding":{"type":"string","description":"Content encoding."},"contentLength":{"type":"integer","format":"int32","description":"Length of the attachment content in bytes."},"hash":{"type":"string","description":"Hash of the content (algorithm and value)."},"data":{"type":"string","format":"byte","description":"Attachment content, Base64-encoded."},"attributes":{"type":"array","description":"Optional key-value attributes; omitted when empty.","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}}}}},"components/schemas/AttachmentDownloadResponse":{"id":"components/schemas/AttachmentDownloadResponse","kind":"json-schema","title":"AttachmentDownloadResponse","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"totalMatches":{"type":"integer","description":"Total number of attachments matching the requested IDs."},"responseStatus":{"type":"object","additionalProperties":true,"description":"Error details when automatic exception handling returns one."}}}},"components/schemas/UniqueIdsRequest":{"id":"components/schemas/UniqueIdsRequest","kind":"json-schema","title":"UniqueIdsRequest","data":{"type":"object","required":["UniqueIds"],"properties":{"UniqueIds":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"components/schemas/AffidavitUniqueIdsRequest":{"id":"components/schemas/AffidavitUniqueIdsRequest","kind":"json-schema","title":"AffidavitUniqueIdsRequest","data":{"type":"object","required":["UniqueIds"],"properties":{"UniqueIds":{"type":"array","description":"Affidavit UUIDs to include. Duplicate values are invalid and should not be retried unchanged.","items":{"type":"string","format":"uuid"}}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["New"],"description":"Idempotency outcome for the submission request."}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["Replay"],"description":"Idempotency outcome for the submission request."}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["Conflict"],"description":"Idempotency outcome for the submission request."}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["Draft","Submitted","Scheduled","Processing","Processed","Invalid","Failed"]}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","enum":["None","LastUpdated","ScheduledFor","StartedOn"],"default":"LastUpdated"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","enum":["None","Ascending","Descending"],"default":"Ascending"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","enum":["None","Forward","Backward"],"default":"Forward"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1000},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","enum":["None","Ascending","Descending"]},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"Content":{"type":"string","format":"binary","description":"The attachment file content."},"DisplayName":{"type":"string"},"Filename":{"type":"string"},"ContentId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Content-ID that can be referenced with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cid:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body HTML to embed the attachment inline."},"children":[]}]}]}]},"MimeType":{"type":"string"},"ContentDescription":{"type":"string"},"ContentDisposition":{"type":"string"},"ContentLocation":{"type":"string"},"ContentEncoding":{"type":"string"},"IncludeOnAffidavits":{"type":"boolean"}},"required":["Content"]},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EviNoticeBatchAttachmentInfo"}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","enum":["Draft","New","Ready","Sent","Dispatched","Delivered","Read","Replied","Closed","Failed"]},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","enum":["None","Certified","Sent","Delivered","Read","Accepted","Rejected","Failed"]},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","enum":["CreationDate"]},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"integer","minimum":0,"maximum":100},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"Content":{"type":"string","format":"binary","description":"The attachment file content."},"DisplayName":{"type":"string"},"ContentId":{"type":"string"},"ContentDescription":{"type":"string"},"ContentDisposition":{"type":"string"},"ContentLocation":{"type":"string"},"ContentEncoding":{"type":"string"},"IncludeOnAffidavits":{"type":"boolean","description":"Validated on upload. Do not rely on this flag to include the file in individual EviMail affidavits."}},"required":["Content"]},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EviMailBatchAttachmentInfo"}},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string","enum":["Draft","New","Ready","Sent","Dispatched","Delivered","Read","Closed","Failed"]},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["New"],"description":"Idempotency outcome when a token is supplied."}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["Replay"],"description":"Idempotency outcome when a token is supplied."}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["Conflict"]}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"enum":["CreationDate"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field options for EviSign query results."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sort results by creation date."},"children":[]}]}]}]}]},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"integer","format":"int32","nullable":true,"default":0},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"integer","format":"int32","nullable":true,"maximum":100},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"boolean","nullable":true,"default":false},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"boolean","nullable":true,"default":true},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"string","description":"Cooldown in seconds, when available."}}},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-Error-Id":{"type":"string","format":"uuid","description":"Error correlation ID; also returned in responseStatus.errorId."}}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","enum":["Draft","Submitted","Processed","Sent","Dispatched","Delivered","Missing","Closed","Issued","Failed","Undelivered","Disposed","Cancelled"]},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"string","enum":["None","Delivered","Dispatched","Acknowledged","Declined","Hindered","Cancelled","Expired","Failed","Sent","Rejected","Undelivered","Disposed"]},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","example":"attachment;filename=\"affidavits.zip\"","description":"Suggested archive filename."}}},"id":"schema_39"}},"exampleStore":{"paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/standardSimple":{"value":{"Subject":"Subject of the certified communication","Body":"We inform you that today is a very interesting day.<br>Best Regards,","LookupKey":"05","TimeToLive":10080,"RecipientAddress":"recipient@example.com","RecipientDisplayName":"Jane Doe","RecipientLegalName":"Acme Corp","CertificationLevel":"Standard_EU","IssuerLegalName":"Sender Co.","EvidenceAccessControlMethod":"Public","DeliverySignMethod":"WebClick","CommitmentChoice":"Disabled","Language":"en","AffidavitLanguage":"en","NotificationLayout":"Certified"},"key":"standardSimple","summary":"Standard certification, email delivery, minimal options","id":"paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/standardSimple"},"paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/advancedComplete":{"value":{"Subject":"Contract review required","Body":"<p>Please review and accept the attached contract.</p>","LookupKey":"CONTRACT-001","TimeToLive":10080,"RecipientAddress":"recipient@example.com","RecipientDisplayName":"Jane Doe","RecipientLegalName":"Acme Corp","CertificationLevel":"Advanced_EU","IssuerLegalName":"Sender Co.","Attachments":[{"Data":"JVBERi0xLjQgZXhhbXBsZQ==","Filename":"contract.pdf","DisplayName":"Contract 2026","MimeType":"application/pdf","IncludeOnAffidavits":false}],"AffidavitKinds":["SubmittedAdvanced","TransmissionResult","DeliveryResult","Received","Read","CommittedAdvanced","Refused","Event","Complete","Failed"],"EvidenceAccessControlMethod":"AutoChallenge","DeliverySignMethod":"MobilePin","DeliverySignFixedMobile":"+34600000000","MobilePinChannels":[["SMS","RCS","WhatsApp"],["SMS","RCS","WhatsApp"],["SMS","RCS","WhatsApp"]],"CommitmentChoice":"AcceptOrReject","CommitmentCommentsAllowed":true,"RejectReasons":["I do not agree with the terms","The information is incorrect"],"RequireRejectReason":false,"AcceptReasons":["I accept the terms","I confirm the information"],"RequireAcceptReason":false,"PushNotificationFilter":["Processed","Sent","Dispatched","Delivered","Read","Replied"],"PushNotificationUrl":"https://your-system.example.com/callbacks/notify","Language":"en","AffidavitLanguage":"en","NotificationLayout":"Certified","Reminders":{"Initial":"P2D","Repeat":"P1D","Days":["Monday","Tuesday","Wednesday","Thursday","Friday"],"TimeRange":["FROM08TO10","FROM10TO12","FROM12TO15","FROM15TO19"],"Max":5,"Stop":"P15D","TimeZone":"Etc/GMT-1"}},"key":"advancedComplete","summary":"Advanced certification with MobilePin, commitment, attachments, reminders","description":"Illustrative payload only; replace the example Data with a real base64-encoded PDF before use. The sample bytes are not a validated PDF, so IncludeOnAffidavits is false.","id":"paths/~1v2~1EviNotice~1Submit/post/requestBody/content/application~1json/examples/advancedComplete"},"paths/~1v2~1EviNotice~1Submit/post/responses/200/content/application~1json/example":{"value":{"Id":"550e8400-e29b-41d4-a716-446655440000"},"id":"paths/~1v2~1EviNotice~1Submit/post/responses/200/content/application~1json/example"},"paths/~1v2~1EviNotice~1Submit/post/responses/202/content/application~1json/example":{"value":{"Id":"550e8400-e29b-41d4-a716-446655440000"},"id":"paths/~1v2~1EviNotice~1Submit/post/responses/202/content/application~1json/example"},"paths/~1v2~1EviNotice~1{Id}/get/responses/200/content/application~1json/example":{"value":{"Id":"550e8400-e29b-41d4-a716-446655440000","Subject":"Contract review required","LookupKey":"CONTRACT-001","Issuer":"Sender Co.","IssuerEmail":"sender@example.com","RecipientAddress":"recipient@example.com","RecipientDisplayName":"Jane Doe","RecipientLegalName":"Acme Corp","State":"Read","Outcome":"None","CreationDate":"2026-01-15T09:00:00Z","LastUpdateDate":"2026-01-16T11:23:00Z","SubmittedOn":"2026-01-15T09:00:01Z","ProcessedOn":"2026-01-15T09:00:01Z","SentOn":"2026-01-15T09:00:10Z","DispatchedOn":"2026-01-15T09:00:03Z","DeliveredOn":"2026-01-15T09:15:00Z","ReceivedOn":"2026-01-16T11:20:00Z","ReadOn":"2026-01-16T11:23:00Z","TimeToLive":10080,"AllowRefusal":false,"NotaryRetention":false,"OnlineRetentionPeriod":1,"SourceChannel":"Api","AffidavitKinds":["TransmissionResult","DeliveryResult","Read"],"SiteName":"acme-corp","XmissionResult":true,"XmissionSummary":"250 OK"},"id":"paths/~1v2~1EviNotice~1{Id}/get/responses/200/content/application~1json/example"},"paths/~1v2~1EviNotice~1Query/post/responses/200/content/application~1json/example":{"value":{"Cursor":"AQAAAADFDwwAAAAAABVOhADim0HUo3Jm+wAAAAAAAAA=","Results":[{"Id":"550e8400-e29b-41d4-a716-446655440000","Subject":"Contract review required","LookupKey":"CONTRACT-001","Issuer":"Sender Co.","IssuerEmail":"sender@example.com","RecipientAddress":"recipient@example.com","RecipientDisplayName":"Jane Doe","State":"Closed","Outcome":"Received","CreationDate":"2026-01-15T09:00:00Z","SubmittedOn":"2026-01-15T09:00:01Z","ProcessedOn":"2026-01-15T09:00:01Z","DispatchedOn":"2026-01-15T09:00:03Z","SentOn":"2026-01-15T09:00:10Z","ReceivedOn":"2026-01-15T10:00:00Z","ExpiredOn":"2026-01-16T09:00:20Z","TimeToLive":1440,"AffidavitKinds":["TransmissionResult","DeliveryResult","Read"]}]},"id":"paths/~1v2~1EviNotice~1Query/post/responses/200/content/application~1json/example"},"paths/~1v2~1EviNotice~1Batches/post/requestBody/content/application~1json/example":{"value":{"Description":"March 2026 customer notices"},"id":"paths/~1v2~1EviNotice~1Batches/post/requestBody/content/application~1json/example"},"paths/~1v2~1EviNotice~1Batches/post/responses/201/content/application~1json/example":{"value":{"BatchId":"550e8400-e29b-41d4-a716-446655440000"},"id":"paths/~1v2~1EviNotice~1Batches/post/responses/201/content/application~1json/example"},"paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example":{"value":{"Subject":"Important notice regarding your account","IssuerName":"Sender Co.","CertificationLevel":"Advanced_EU","Language":"en","State":"Submitted"},"id":"paths/~1v2~1EviNotice~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"},"paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example":{"value":"<p>We inform you that today is a very interesting day.</p>","id":"paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"},"paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example":{"value":"address;legalname;displayname;*orderid\njane@example.com;Acme Corp;Jane Doe;ORD-001\njohn@example.com;Beta Ltd;John Roe;ORD-002\n","id":"paths/~1v2~1EviNotice~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"},"paths/~1v1~1EviMail~1Submit/post/requestBody/content/application~1json/examples/emailOk":{"value":{"Subject":"Certified email example","Body":"<p>Hello, this is a certified email.</p>","LookupKey":"MAIL-001","IssuerName":"Sender Corp.","From":"sender@example.com","ReplyTo":"reply@example.com","DisableSenderHeader":false,"Recipient":{"LegalName":"Recipient Corp.","EmailAddress":"recipient@example.com"},"CarbonCopy":[{"Name":"Legal Team","EmailAddress":"legal@example.com"}],"Attachments":[{"DisplayName":"Contract","Filename":"contract.txt","MimeType":"text/plain","Data":"Q29udHJhY3QgZXhhbXBsZQo="}],"Options":{"CertificationLevel":"Advanced_EU","TimeToLive":1440,"Language":"en","AffidavitLanguage":"en","AffidavitKinds":["Submitted","DeliveryResult","Read","Closed"],"PushNotificationFilter":["Sent","Delivered","Read","Failed"],"PushNotificationUrl":"https://example-callback.invalid/","EvidenceAccessControlMethod":"Public","OnlineRetentionPeriod":1}},"key":"emailOk","summary":"emailOk","id":"paths/~1v1~1EviMail~1Submit/post/requestBody/content/application~1json/examples/emailOk"},"paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"87ffa214-e773-4bd5-9b8d-a8ef00fd80f8","IncludeBody":true,"IncludeAttachments":true,"IncludeEvents":true},"id":"paths/~1v1~1EviMail~1AffidavitRequest/post/requestBody/content/application~1json/example"},"paths/~1v1~1EviMail~1AffidavitRequest/post/responses/200/content/application~1json/example":{"value":{"requestId":"79726a87000c1f7042aca3ea149f9438"},"id":"paths/~1v1~1EviMail~1AffidavitRequest/post/responses/200/content/application~1json/example"},"paths/~1v2~1EviMail~1Batches/post/requestBody/content/application~1json/example":{"value":{"Description":"March 2026 customer emails"},"id":"paths/~1v2~1EviMail~1Batches/post/requestBody/content/application~1json/example"},"paths/~1v2~1EviMail~1Batches/post/responses/201/content/application~1json/example":{"value":{"BatchId":"550e8400-e29b-41d4-a716-446655440000"},"id":"paths/~1v2~1EviMail~1Batches/post/responses/201/content/application~1json/example"},"paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example":{"value":{"Subject":"Your March statement","From":"sender@example.com","TimeToLive":1440,"OnlineRetentionPeriod":1,"CommitmentOptions":"Disabled","IssuerName":"Sender Corp.","CertificationLevel":"Advanced_EU","Language":"en","State":"Submitted","ScheduledDate":"2030-04-01T09:00:00Z"},"id":"paths/~1v2~1EviMail~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"},"paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example":{"value":"<p>Hello, this is a certified email.</p>","id":"paths/~1v2~1EviMail~1Batches~1{BatchId}~1Body/put/requestBody/content/text~1html/example"},"paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example":{"value":"emailaddress;legalname;displayname;*orderid\njane@example.com;Acme Corp;Jane Doe;ORD-001\njohn@example.com;Beta Ltd;John Roe;ORD-002\n","id":"paths/~1v2~1EviMail~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"},"paths/~1v1~1EviSms~1Submit/post/requestBody/content/application~1json/examples/smsOk":{"value":{"Text":"We inform you that your request has been processed.","LookupKey":"SMS-001","IssuerName":"SendCo","Recipient":{"LegalName":"Recipient Corp.","PhoneNumber":"+34600000000"},"Options":{"CertificationLevel":"Advanced_EU","DeliveryChannels":["SMS"],"TimeToLive":11400,"Language":"es","AffidavitLanguage":"es","AffidavitKinds":["Submitted","TransmissionResult","DeliveryResult","Closed","CompleteAdvanced"],"PushNotificationFilter":["Ready","Sent","Dispatched","Delivered","Failed","Closed","AffidavitPublished"],"PushNotificationUrl":"https://your-system.example.com/callbacks/evisms","EvidenceAccessControlMethod":"Challenge","EvidenceAccessControlChallenge":"What is your mother's maiden name?","EvidenceAccessControlChallengeResponse":"Smith","OnlineRetentionPeriod":1}},"key":"smsOk","summary":"smsOk","id":"paths/~1v1~1EviSms~1Submit/post/requestBody/content/application~1json/examples/smsOk"},"paths/~1v2~1EviSms~1Batches/post/requestBody/content/application~1json/example":{"value":{"Description":"March 2026 customer SMS"},"id":"paths/~1v2~1EviSms~1Batches/post/requestBody/content/application~1json/example"},"paths/~1v2~1EviSms~1Batches/post/responses/201/content/application~1json/example":{"value":{"BatchId":"550e8400-e29b-41d4-a716-446655440000"},"id":"paths/~1v2~1EviSms~1Batches/post/responses/201/content/application~1json/example"},"paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example":{"value":{"Text":"We inform you that your request has been processed.","IssuerName":"SendCo","CertificationLevel":"Advanced_EU","TimeToLive":1440,"OnlineRetentionPeriod":5,"Language":"es","State":"Submitted","ScheduledDate":"2030-01-15T10:30:00Z"},"id":"paths/~1v2~1EviSms~1Batches~1{BatchId}/patch/requestBody/content/application~1json/example"},"paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example":{"value":"phonenumber;legalname;lookupkey;*orderid\n+34600000000;Acme Corp;SMS-001;ORD-001\n+34600000001;Beta Ltd;SMS-002;ORD-002\n","id":"paths/~1v2~1EviSms~1Batches~1{BatchId}~1Recipients/post/requestBody/content/text~1csv/example"},"paths/~1v1~1evisign~1submit/post/requestBody/content/application~1json/example":{"value":{"LookupKey":"CONTRACT-001","Subject":"Contract for signature","Document":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAzMDAgMjAwXSAvQ29udGVudHMgNCAwIFIgL1Jlc291cmNlcyA8PCAvRm9udCA8PCAvRjEgNSAwIFIgPj4gPj4gPj4KZW5kb2JqCjQgMCBvYmoKPDwgL0xlbmd0aCA0OCA+PgpzdHJlYW0KQlQgL0YxIDEyIFRmIDMwIDEwMCBUZCAoRXhhbXBsZSBjb250cmFjdCkgVGogRVQKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjw8IC9UeXBlIC9Gb250IC9TdWJ0eXBlIC9UeXBlMSAvQmFzZUZvbnQgL0hlbHZldGljYSA+PgplbmRvYmoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAowMDAwMDAwMjQxIDAwMDAwIG4gCjAwMDAwMDAzMzggMDAwMDAgbiAKdHJhaWxlcgo8PCAvU2l6ZSA2IC9Sb290IDEgMCBSID4+CnN0YXJ0eHJlZgo0MDgKJSVFT0YK","SigningParties":[{"Name":"Alex Example","Address":"signer@example.com","AddressType":"Email","SigningMethod":"WebClick","Role":"Signer"}],"Options":{"TimeToLive":1440,"CommitmentOptions":"AcceptOrReject","PushNotificationUrl":"https://integrator.example.com/callbacks/evisign","PushNotificationFilter":["Processed","FullySigned","Closed","AffidavitPublished"],"AffidavitKinds":["Submitted","PartyCommitted","Main","OnDemand"]}},"id":"paths/~1v1~1evisign~1submit/post/requestBody/content/application~1json/example"},"paths/~1v1~1evisign~1cancel/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"d11caec2-70bd-4739-afd5-aa7600920538","Comments":"Contract superseded by a revised version.","Quietly":false},"id":"paths/~1v1~1evisign~1cancel/post/requestBody/content/application~1json/example"},"paths/~1v1~1evisign~1resend/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"d11caec2-70bd-4739-afd5-aa7600920538","NotificationAddress":"signer@example.com"},"id":"paths/~1v1~1evisign~1resend/post/requestBody/content/application~1json/example"},"paths/~1v1~1evisign~1affidavitrequest/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"d11caec2-70bd-4739-afd5-aa7600920538","IncludeDocument":true,"IncludeAttachments":false,"IncludeEvents":true,"IncludedCommitments":"Signers"},"id":"paths/~1v1~1evisign~1affidavitrequest/post/requestBody/content/application~1json/example"},"paths/~1EviSign~1SignLink/post/requestBody/content/application~1json/example":{"value":{"UniqueIds":["d11caec2-70bd-4739-afd5-aa7600920538"],"Party":"signer@example.com","LiteFlow":true},"id":"paths/~1EviSign~1SignLink/post/requestBody/content/application~1json/example"},"paths/~1EviSign~1SignLink/post/responses/200/content/application~1json/example":{"value":{"uniqueId":"c7451684-b831-46af-8417-28e378e9ddaa","url":"https://app.ecertia.com/Public/EviSign/Delivery/Start?eid=OPAQUE_VALUE&lf=true","expiresAt":"2026-10-22T13:00:00.0000000Z","results":[{"evidenceId":"d11caec2-70bd-4739-afd5-aa7600920538","discarded":false,"discardReason":null,"lookupKey":"CONTRACT-001","state":"Processed","outcome":"None","creationDate":"2026-10-22T11:59:00.0000000Z","lastStateChangeDate":"2026-10-22T12:00:00.0000000Z","submittedOn":"2026-10-22T11:59:00.0000000Z","processedOn":"2026-10-22T12:00:00.0000000Z","sentOn":null,"closedOn":null,"signedOn":null,"rejectedOn":null,"failedOn":null,"expiredOn":null,"timeToLive":1440}]},"id":"paths/~1EviSign~1SignLink/post/responses/200/content/application~1json/example"},"paths/~1v1~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost":{"value":{"LookupKey":"a2R4S25kWiu79fsbubSXkw==","Document":"<base64-encoded PDF>","RecipientName":"Juan Valido","RecipientLegalName":"Juan Valido","RecipientAddress":{"StreetAddress":"Gran Via 74, 5 A","PostalCode":"28014","Locality":"Madrid","Region":"Madrid","Country":"ES"},"RecipientPhone":"+34677000111","RecipientEmail":"recipient@example.com","IssuerName":"Pedro Comprador","IssuerLegalName":"Pedro Valido","IssuerAddress":{"StreetAddress":"C/ Gran Via, 1, 1-A","PostalCode":"28001","Locality":"Madrid","Region":"Madrid","Country":"ES"},"IssuerPhone":"+34677888777","IssuerEmail":"pedro.comprador@example.com","IssuerComments":"Sending in March.","Options":{"PostServiceType":"Registered","Language":"es","CertificationLevel":"Advanced_EU","AffidavitProfile":"AdvancedContentOnSubmit","AffidavitsOnDemandEnabled":false,"OnlineRetentionPeriod":1,"NotaryRetentionPeriod":5,"NotaryProfile":"notary:profile","EvidenceAccessControlMethod":"AutoChallenge","CostCentre":"dept-legal","PushNotificationUrl":"https://your-server.example.com/callbacks/evipost","PushNotificationFilter":["Processed","Sent","Delivered","Closed"],"PushNotificationExtraData":"{\"myId\": \"order-12345\"}"}},"key":"registeredPost","summary":"Registered postal communication","id":"paths/~1v1~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"},"paths/~1v1~1EviPost~1Submit/post/responses/200/content/application~1json/example":{"value":{"uniqueId":"69819c3e0c0e42b3a792a33b014a13a2"},"id":"paths/~1v1~1EviPost~1Submit/post/responses/200/content/application~1json/example"},"paths/~1v1~1EviPost~1Query/get/responses/200/content/application~1json/example":{"value":{"results":[{"evidenceId":"3977d143a6cb4642abc6a33b016cbec2","lookupKey":"a2R4S25kWiu79fsbubSXkw==","recipientName":"Juan Valido","address":{"streetAddress":"Gran Via 74, 5 A","postalCode":"28014","locality":"Madrid","region":"Madrid","country":"ES"},"state":"Sent","stateDate":"2026-01-15T10:00:07Z","lastStateChangeDate":"2026-01-15T10:00:11Z","outcome":"Sent","outcomeDate":"2026-01-15T10:00:07Z","creationDate":"2026-01-15T10:00:00Z","submittedOn":"2026-01-15T10:00:00Z","processedOn":"2026-01-15T10:00:03Z","sentOn":"2026-01-15T10:00:07Z","timeToLive":50400,"costCentre":"dept-legal","affidavits":[{"uniqueId":"000c1f7042aca3ea149f943879726a87","date":"2026-01-15T10:00:12Z","evidenceUniqueId":"3977d143a6cb4642abc6a33b016cbec2","description":"Certification of postal communication"}]}],"totalMatches":1},"id":"paths/~1v1~1EviPost~1Query/get/responses/200/content/application~1json/example"},"paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"87ffa214-e773-4bd5-9b8d-a8ef00fd80f8","IncludeDocument":true,"IncludeEvents":true},"id":"paths/~1v1~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"},"paths/~1v1~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example":{"value":{"requestId":"79726a87000c1f7042aca3ea149f9438"},"id":"paths/~1v1~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"},"paths/~1v1~1EviPost~1Cancel/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"69819c3e-0c0e-42b3-a792-a33b014a13a2"},"id":"paths/~1v1~1EviPost~1Cancel/post/requestBody/content/application~1json/example"},"paths/~1v1~1EviPost~1Cancel/post/responses/200/content/application~1json/example":{"value":{"uniqueId":"69819c3e0c0e42b3a792a33b014a13a2"},"id":"paths/~1v1~1EviPost~1Cancel/post/responses/200/content/application~1json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"}},"specVersion":"3.0.3","servers":[{"url":"https://api.evicertia.com","description":"Production"},{"url":"https://api.ecertia.com","description":"Pre-production / QA"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/it/products/namirialnotify/apis/oas/namirialnotify-api.json?download"},{"url":"/_bundle/@l10n/it/products/namirialnotify/apis/oas/namirialnotify-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Namirial Notify APIs","description":"Unified OpenAPI reference for the Namirial Notify service APIs. This specification aggregates EviNotice, EviMail, EviSMS, EviSign, EviPost, and shared affidavit and attachment download endpoints. EviNotice, EviMail, and EviSMS each group their single-message and batch operations together. In the public Namirial Notify API environments, single-message operations for EviMail, EviSMS, and EviPost use the `/v1` base path. EviMail and EviSMS batch operations use `/v2/EviMail/Batches` and `/v2/EviSms/Batches`, respectively. EviSign issuer operations use `/v1/evisign`; Bundle uses `/v2/evisign/{Id}/bundle`. SignLink overrides the server to the application host and uses `/EviSign/SignLink`. Some lower-level technical artifacts may show those V1 routes without the prefix. For customer integrations, use the public paths shown in this specification. For the public Namirial Notify API environments, EviNotice routes use the `/v2` base path. The legacy `/api/v2/...` form is still accepted for backward compatibility.\n"}},"baseSlug":"/it/products/namirialnotify/apis/oas/namirialnotify-api","routesMapping":{}}