You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Description of EVICERTIA web services



EVICERTIA provides a layer of web services ( REST ) in the following URL (http://app.evicertia.com/api/metadata) covering all platform operation needs and it can be consumed by the following standards:

  • REST+JSON


Base URLs for web services are listed below:

  • Production environment: https://app.evicertia.com/api/metadata
  • PRE-Production environment: https://app.ecertia.com/api/metadata --> This is the version for the integration tests

Safety Considerations

In order to consume EVICERTIA web services, you must have an active user in app.evicertia.com (or in PRE/QA environment), since the system requests should use "Basic HTTP" authentication.

Operating Considerations

Default parameters and user/site settings

Operation of web services vary slightly with regard to the web platform’s.

In the web platform there are several values ​​that are overwritten by different site, user or message settings, such as:

Default settings for platform > overwritten by > Site settings > sobrescrita por > User settings > overwritten by > Contract/message settings

However, with regard to web services, the platform settings is overwritten, so you must specify the values​​/parameters since they may not match the user or site settings. In a nut shell:

Default platform settings > overwritten by > Message/contract settings

URLs for access to the service

The only URLs that should be used are those that are provided directly as an answer or redirect, as a consequence of the consumption of our services.

The use of URLs composed by the consumer, as a result of concatenating a prefix or domain name with some identifier (self-concatenating https://app.evicertia.com/ <Path> / <identifier>) is not supported; although that URL may work, its long-term maintenance is not guaranteed, since the path or the format of the identifier may change without prior notice.

Evicertia only commits to keep available those URLs for access to the evidence displayed at the bottom of the affidavits (https://evicertia.com/evi/...), and for a limited time, those included as an answer from web services (for example, URL of EviSignBulkSign or that of the URL shortener service available at https://app.evicertia.com/).

Available Operations

The following sections describe the operations available in EVICERTIA web services:

Api V1

  • AttachmentDownload: Download request of attachments by means of an identifier.
  • EviMailAffidavitRequest: Request of affidavit generation for EviMail upon request (Certified E-mail)
  • EviMailQuery: Query and download of EviMail communications, attachments and affidavits.
  • EviMailSubmit: EviMail Submit.
  • EviPostAffidavitRequest: Request of affidavit generation under request for EviPost.(Postal certified communication) (if you want to use this service, you must apply to support@evicertia.com).
  • EviPostQuery: Query and download of EviPostcommunications, attachments and affidavits.
  • EviPostSubmit: EviPost submit.
  • EviSignBulkSign: Signature request of one or more EviSigns at the same time, without sending the signature notification request to the signers. Evisign is the Evicertia service that allows to sign contracts or electronic documents online.
  • EviSignCancel: Cancellation of contracts (EviSign) issued. EviSignQuery: Query and download of EviSign contracts, attachments and affidavits.
  • EviSignQuery: Query and download of EviSign contracts, attachments and affidavits.
  • EviSignSubmit: EviSign submit, signature of contracts or electronic documents online.
  • EviSMSQuery: Query and download of EviSMS communications and affidavits (Certified SMS).
  • EviSMSSubmit: EviSMS submit.

Api V2

  • EviNoticeAffidavitDownload: Download an affidavit using the affidavit's identifier.
  • EviNoticeAffidavitRequest: Request an affidavit on demand for a specified EviNotice.
  • EviNoticeAffidavitsDownload: Download a zip of affidavits using the EviNotice's identifier.
  • EviNoticeAttachmentsDownload: Download a zip of attachments using the EviNotice's identifier.
  • EviNoticeGet: Get basic information of one EviNotice.
  • EviNoticeQuery: Get basic information of multiple EviNotices.
  • EviNoticeSubmit: Submit a new EviNotice.
  • No labels