{ "openapi": "3.0.1", "info": { "title": "Conga.ESign.Service.API", "version": "v1" }, "paths": { "/api/esign/v1/health/live": { "get": { "tags": [ "HealthCheck" ], "summary": "Check for service liveness", "description": "Checks whether the service is operational.", "responses": { "503": { "description": "Service Temporarily Unavailable" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckSummary" }, "example": {"Status":"Healthy","ServiceVersion":"22.6.0.34","Duration":1.9753,"StatusCode":0} } } } } } }, "/api/esign/v1/health/ready": { "get": { "tags": [ "HealthCheck" ], "summary": "Check for service readiness", "description": "Checks whether the service is ready to execute the request.", "responses": { "503": { "description": "Service Temporarily Unavailable" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckSummary" }, "example": {"Status":"Healthy","ServiceVersion":"22.6.0.34","ComponentHealthSummary":[{"Name":"Index Cache","Status":"Healthy","Duration":314.4967},{"Name":"Data Cache","Status":"Healthy","Duration":385.204},{"Name":"Data Config","Status":"Healthy","Duration":418.9651},{"Name":"Queue","Status":"Healthy","Duration":446.0765},{"Name":"Topic","Status":"Healthy","Duration":373.9502}],"Duration":460.0827,"StatusCode":0} } } } } } }, "/api/esign/v1/esignatures": { "post": { "tags": [ "Sign" ], "summary": "Create an envelope", "description": "Creates an envelope for DocuSign, an agreement for Adobe Sign, or a package for Conga Sign based on the selected eSignature service provider in the parameters. \r\n This API returns the package ID and tag URL. \r\n You can use the package ID to get transaction details such as envelope status, signed date, and declined reason. \r\n You can use the tag URL to open the document inside the eSignature service provider console, add signature tags and additional fields, and send the document for eSignature.", "parameters": [ { "name": "signProviderType", "in": "query", "description": "Select an eSignature service provider from the list.", "schema": { "$ref": "#/components/schemas/SignProviderType" } } ], "requestBody": { "description": "Envelope data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignRequest" }, "examples": { "DocuSign": { "value": {"ObjectId":"ffd6b894-e2c9-46dc-b59b-266a2f567f4c","ObjectType":"Agreement","Name":"Envelope","Email":{"EmailSubject":"DocuSign Sample Envelope","EmailContent":"Sample Envelope."},"Recipients":[{"Email":"abc@conga.com","FirstName":"Abc","LastName":"A","Role":"Signer","RoutingOrder":1,"ReciepentIdentityVerification":null},{"Email":"abc@conga.com","FirstName":"Abc","LastName":"A","Role":"CarbonCopy","RoutingOrder":1,"ReciepentIdentityVerification":null}],"Cc":null,"Bcc":null,"DocumentIds":["077fc471-ad8c-4c74-b6c2-0094d76e7287"],"AdditionalAttachments":null,"IsPasswordProtected":false,"DocumentPassword":null,"ReciepentIdentityVerification":null,"Reminder":null,"Expiration":null,"ReturnUrl":"https://localhost:44373/api/esign/swagger/index.html"} }, "CongaSign": { "value": {"ObjectId":"ffd6b894-e2c9-46dc-b59b-266a2f567f4c","ObjectType":"Agreement","Name":"CongaSign","Email":{"EmailSubject":"Conga Sign Sample Envelope","EmailContent":"Sample Envelope."},"Recipients":[{"Email":"abc@conga.com","FirstName":"Abc","LastName":"A","Role":"Signer","RoutingOrder":1,"ReciepentIdentityVerification":null},{"Email":"abc@conga.com","FirstName":"Abc","LastName":"A","Role":"Signer","RoutingOrder":1,"ReciepentIdentityVerification":null}],"Cc":null,"Bcc":null,"DocumentIds":["077fc471-ad8c-4c74-b6c2-0094d76e7287"],"AdditionalAttachments":null,"IsPasswordProtected":false,"DocumentPassword":null,"ReciepentIdentityVerification":null,"Reminder":null,"Expiration":null,"ReturnUrl":null} }, "AdobeSign": { "value": {"ObjectId":"ffd6b894-e2c9-46dc-b59b-266a2f567f4c","ObjectType":"Agreement","Name":"AdobeSign","Email":{"EmailSubject":"Adobe Sign Sample Envelope","EmailContent":"Sample Envelope."},"Recipients":[{"Email":"abc@conga.com","FirstName":"Abc","LastName":"A","Role":"Signer","RoutingOrder":1,"ReciepentIdentityVerification":null},{"Email":"abc@conga.com","FirstName":"Abc","LastName":"A","Role":"CarbonCopy","RoutingOrder":1,"ReciepentIdentityVerification":null}],"Cc":null,"Bcc":null,"DocumentIds":["077fc471-ad8c-4c74-b6c2-0094d76e7287"],"AdditionalAttachments":null,"IsPasswordProtected":false,"DocumentPassword":null,"ReciepentIdentityVerification":null,"Reminder":null,"Expiration":null,"ReturnUrl":null} }, "WetSign": { "value": {"ObjectId":"ffd6b894-e2c9-46dc-b59b-266a2f567f4c","ObjectType":"Agreement","Name":"WetSign","Email":{"EmailSubject":"Adobe Sign Sample Envelope","EmailContent":"Sample Envelope."},"Recipients":[{"Email":"abc@conga.com","FirstName":"Abc","LastName":"Xyz","Role":null,"RoutingOrder":0,"ReciepentIdentityVerification":null}],"Cc":[{"Email":"abc@conga.com","FirstName":"Abc","LastName":"Xyz","Role":null,"RoutingOrder":0,"ReciepentIdentityVerification":null}],"Bcc":[{"Email":"abc@conga.com","FirstName":"Abc","LastName":"A","Role":null,"RoutingOrder":0,"ReciepentIdentityVerification":null}],"DocumentIds":["077fc471-ad8c-4c74-b6c2-0094d76e7287"],"AdditionalAttachments":null,"IsPasswordProtected":false,"DocumentPassword":null,"ReciepentIdentityVerification":null,"Reminder":null,"Expiration":null,"ReturnUrl":null} } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIResponseError" } }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Please provide valid value."}]} } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseError" }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignResponseAPIResponse" }, "example": {"Success":true,"Data":{"PackageId":"590a79ce-0fe0-4486-b5d5-3b3af8fff0d2","TagUrl":"https://appdemo.docusign.com/auth-from-console?code=361107f5-84a2-42a3-8732-1242947b4158&t=88245e3e-d469-4fba-8418-bd3f042f5bf4&from=https%3A%2F%2Fdemo.docusign.net&r=https%3A%2F%2Flocalhost%3A44373%2Fapi%2Fesign%2Fswagger%2Findex.html&view=true&DocuEnvelope=590a79ce-0fe0-4486-b5d5-3b3af8fff0d2&e=590a79ce-0fe0-4486-b5d5-3b3af8fff0d2&send=1&accountId=30045fe5-642e-40f9-b11a-36484b3dd92a&a=tag","Status":null},"Errors":null} } } } } } }, "/api/esign/v1/esignatures/{transactionId}": { "get": { "tags": [ "Sign" ], "summary": "Retrieve transaction details by transaction ID", "description": "Retrieves transaction details based on the transaction ID provided in the parameters.\r\n The transaction ID is the package ID obtained during envelope creation.\r\n This API returns such transaction details as the status of the envelope, \r\n the dates when the envelope was sent and signed, and the reason for decline if the recipient declined.", "parameters": [ { "name": "transactionId", "in": "path", "description": "Provide the unique transaction ID.", "required": true, "schema": { "type": "string" }, "example": "d717a075-9cbf-480c-b230-837e0e6dee75" } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIResponseError" } }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Please provide valid value."}]} } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseError" }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" }, "example": {"Success":true,"Data":{"Name":"Envelope","ExternalESignId":"30f428ae-6f49-423a-a130-2e399ca348dc","ParentObjectId":"ffd6b894-e2c9-46dc-b59b-266a2f567f4c","ParentObjectType":"Agreement","ESignProvider":"DocuSign","DocumentIds":"077fc471-ad8c-4c74-b6c2-0094d76e7287","Id":"3a742f32-c61f-4a1e-9c66-a88bf6a821df","CreatedBy":{"Id":"fd25d4d9-5c87-4b66-aece-bacc637de514","Name":"Test User"},"CreatedDate":"2023-01-13T12:50:38","ModifiedBy":{"Id":"fd25d4d9-5c87-4b66-aece-bacc637de514","Name":"Test User"},"ModifiedDate":"2023-01-15T12:50:38","DateSigned":"2023-01-15T12:50:38","Status":"Signed","RecallReason":null,"DateSent":"2023-01-13T12:50:38","FullySignedDocumentId":"fd25d4d9-a597-4b66-aece-bacc637de514"},"Errors":null} } } } } } }, "/api/esign/v1/esignatures/transactionByObjectId/{objectId}": { "get": { "tags": [ "Sign" ], "summary": "Retrieve transaction details by object ID", "description": "Retrieves transaction details based on the object ID provided in the parameters. Provide the same object ID that you used when creating the envelope.\r\n This API returns such transaction details as the envelope's status, the dates when the envelope was sent and signed, and (if the recipient declined) their reason for declining.", "parameters": [ { "name": "objectId", "in": "path", "description": "Provide the unique object ID.", "required": true, "schema": { "type": "string" }, "example": "a65544f2-b4cb-400c-a014-1fd6b04861c9" } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIResponseError" } }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Please provide valid value."}]} } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseError" }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" }, "example": {"Success":true,"Data":{"Name":"Envelope","ExternalESignId":"30f428ae-6f49-423a-a130-2e399ca348dc","ParentObjectId":"ffd6b894-e2c9-46dc-b59b-266a2f567f4c","ParentObjectType":"Agreement","ESignProvider":"DocuSign","DocumentIds":"077fc471-ad8c-4c74-b6c2-0094d76e7287","Id":"3a742f32-c61f-4a1e-9c66-a88bf6a821df","CreatedBy":{"Id":"fd25d4d9-5c87-4b66-aece-bacc637de514","Name":"Test User"},"CreatedDate":"2023-01-13T12:50:38","ModifiedBy":{"Id":"fd25d4d9-5c87-4b66-aece-bacc637de514","Name":"Test User"},"ModifiedDate":"2023-01-15T12:50:38","DateSigned":"2023-01-15T12:50:38","Status":"Signed","RecallReason":null,"DateSent":"2023-01-13T12:50:38","FullySignedDocumentId":"fd25d4d9-a597-4b66-aece-bacc637de514"},"Errors":null} } } } } } }, "/api/esign/v1/esignatures/signertypes": { "get": { "tags": [ "Sign" ], "summary": "Retrieve the allowed signer types for an eSignature service provider", "description": "Retrieves the allowed signer types based on the eSignature service provider specified in the parameters. \r\n When creating the envelope, the signer type is provided in the Role field.", "parameters": [ { "name": "signProviderType", "in": "query", "description": "Select an eSignature service provider from the list.", "schema": { "$ref": "#/components/schemas/SignProviderType" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIResponseError" } }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Please provide valid value."}]} } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseError" }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListAPIResponse" }, "example": {"Success":true,"Data":["SignerTypes"],"Errors":null} } } } } } }, "/api/esign/v1/esignatures/usersearch/{searchString}": { "get": { "tags": [ "Sign" ], "summary": "Get the list of users", "description": "Retrieves a list of users based on the search criteria specified in the parameters from the User and Contact objects. \r\n In the search text, provide the user name or letters from the user name.", "parameters": [ { "name": "searchString", "in": "path", "description": "search text", "required": true, "schema": { "type": "string" }, "example": "John" } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIResponseError" } }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Please provide valid value."}]} } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIResponseError" }, "example": {"Success":false,"Data":null,"Errors":[{"Id":null,"Message":"Internal server error occurred. Please contact admin."}]} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientInfoListAPIResponse" }, "example": {"Success":true,"Data":[{"Id":"31562d74-2b58-4747-b117-843f0a8d870e","Name":"Test User","FirstName":"Test","LastName":"User","EmailId":"testuser@conga.com","RecipientType":"Contact"}],"Errors":null} } } } } } } }, "components": { "schemas": { "APIResponseError": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Data": { "type": "string", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true } }, "additionalProperties": false }, "ComponentHealthCheckSummary": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true }, "Error": { "type": "string", "nullable": true }, "Duration": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ContentType": { "type": "object", "properties": { "Boundary": { "type": "string", "nullable": true }, "CharSet": { "type": "string", "nullable": true }, "MediaType": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Parameters": { "type": "array", "items": { }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Email": { "type": "object", "properties": { "EmailSubject": { "type": "string", "nullable": true }, "EmailContent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailAttachment": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "ContentType": { "$ref": "#/components/schemas/ContentType" }, "FileData": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ErrorDetail": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Expiration": { "type": "object", "properties": { "ExpireEnabled": { "type": "boolean" }, "ExpireAfter": { "type": "string", "nullable": true }, "ExpireWarn": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HealthCheckSummary": { "type": "object", "properties": { "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "Status": { "type": "string", "nullable": true }, "ServiceVersion": { "type": "string", "nullable": true }, "ComponentHealthSummary": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentHealthCheckSummary" }, "nullable": true }, "Duration": { "type": "number", "format": "double" } }, "additionalProperties": false }, "HttpStatusCode": { "enum": [ "Continue", "SwitchingProtocols", "Processing", "EarlyHints", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "UnavailableForLegalReasons", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "type": "string" }, "Recipient": { "required": [ "Email" ], "type": "object", "properties": { "Email": { "minLength": 1, "type": "string" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Role": { "type": "string", "nullable": true }, "RoutingOrder": { "type": "integer", "format": "int32" }, "ReciepentIdentityVerification": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RecipientInfo": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "EmailId": { "type": "string", "nullable": true }, "RecipientType": { "$ref": "#/components/schemas/RecipientType" } }, "additionalProperties": false }, "RecipientInfoListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientInfo" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true } }, "additionalProperties": false }, "RecipientType": { "enum": [ "Contact", "Email", "User" ], "type": "string" }, "Reminder": { "type": "object", "properties": { "ReminderEnabled": { "type": "boolean" }, "ReminderDelay": { "type": "string", "nullable": true }, "ReminderFrequency": { "type": "string", "nullable": true }, "ReminderCount": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SignProviderType": { "enum": [ "AdobeSign", "CongaSign", "DocuSign", "WetSign" ], "type": "string" }, "SignRequest": { "required": [ "DocumentIds", "ObjectId", "ObjectType", "Recipients" ], "type": "object", "properties": { "ObjectId": { "minLength": 1, "type": "string" }, "ObjectType": { "minLength": 1, "type": "string" }, "Name": { "type": "string", "nullable": true }, "Email": { "$ref": "#/components/schemas/Email" }, "Recipients": { "type": "array", "items": { "$ref": "#/components/schemas/Recipient" } }, "Cc": { "type": "array", "items": { "$ref": "#/components/schemas/Recipient" }, "nullable": true }, "Bcc": { "type": "array", "items": { "$ref": "#/components/schemas/Recipient" }, "nullable": true }, "DocumentIds": { "type": "array", "items": { "type": "string" } }, "AdditionalAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/EmailAttachment" }, "nullable": true }, "IsPasswordProtected": { "type": "boolean" }, "DocumentPassword": { "type": "string", "nullable": true }, "ReciepentIdentityVerification": { "type": "string", "nullable": true }, "Reminder": { "$ref": "#/components/schemas/Reminder" }, "Expiration": { "$ref": "#/components/schemas/Expiration" }, "ReturnUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SignResponse": { "type": "object", "properties": { "PackageId": { "type": "string", "nullable": true }, "TagUrl": { "type": "string", "nullable": true }, "Status": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SignResponseAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Data": { "$ref": "#/components/schemas/SignResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true } }, "additionalProperties": false }, "StringListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true } }, "additionalProperties": false }, "StringObjectDictionaryAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Data": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "HealthCheck", "description": "Monitor the overall health of the Conga eSignature services" }, { "name": "Sign", "description": "Send documents for eSignature using Conga Sign, Adobe Sign, DocuSign, or wet signature" } ] }