Open eSign Connector Specifications
Each e-signature provider is required to build and host a connector that integrates Coupa with the provider's signing service using our Open eSign API. The connector is the integration middleware between Coupa and the provider's signing services.
This connector must be:
- Built by the provider, customer, or partner using their chosen programming language.
- Deployed and hosted by the provider or other third party.
- Adhere to Coupa's Open API Specifications listed below.
Coupa expects that any given e-signature provider only needs to create a single connector that can be utilized by any Coupa customer who wants to use that e-signature provider.
Open API specifications
Open API definitions
| Term | Meaning |
|---|---|
| Create Package | Used to create package in DRAFT status. This is the container on the provider side which holds the documents and recipients. |
| Add Documents to Package | Used to add Documents to the created package. |
| Add Recipients to Package | Used to add recipients to the created package. |
| Send Package for Signing | Used to start the e-signing process. This moves the package out of DRAFT status. |
| Get Package | Used to get information about the package. Includes details like the package status, recipients, and their signing status. |
| Get Signed Documents | Used to get the signed documents. Once all the signers have signed and the package status is COMPLETE, Coupa makes this call to get the Signed Document and any other related documents. This includes documents like the Completion Certificate or Audit trail, which shows details of when the Signers signed. |
| Delete Package | Used to delete, void, or achieve a package. Coupa makes this call when we want to invalidate the package. |
| Get Package Summary | Used to get package statuses like SIGNED or IN PROCESS. |
| Callbacks | Used to configuring a callback on the provider's platform. |
Connector infrastructure and testing requirements
The e-signature provider must provide:
- Have at least one pre-production environment to for end-to-end testing
- Create automation tests that validate the connector request and responses
- Performance metrics on the response time for the connector API and package load time
- Security validation metrics