CryptonMobile eVault API is a secure way of storing signed electronic documents that passes your bank requirements for e-signature vaulting.
Overview
\nAuthorization and value=Basic base64(API Key:Secret).Content-Type: application/json in the headers of every request.200 OK response means the call was successful. 4XX or 5XX response means there was an error on the API call.\"error\": {} key indicating the name of the error and a description.This endpoint allows you to verify your API credentials against your registered e-signature provider.
\nResponse Notes
\nThis endpoint verifies if a specific document identified by the DocumentId exists and is available for download from your registered e-signature provider.
\nResponse Notes
\nThis endpoint allows you to submit an e-signature document for e-vaulting. Our API will download them from your e-signature provider then apply the necessary e-vaulting processes required by banks. The resulting document will then be stored securely and will be available for download on the client portal or via the Download A Document endpoint.
\nRequest Notes
\nResponse Notes
\nThis endpoint allows you to submit directly a document file for e-vaulting instead of the document coming from an eSignature provider. The uploaded document will be processed for e-vaulting and will be available for download on the client portal or via the Download A Document endpoint.
\nRequest Notes
\nResponse Notes
\nThis endpoint allows you to get a document's status and other details. The Status can either be \"Queued\" or \"Vaulted\".
\nResponse Notes
\nAfter a document has been successfully posted and if there are cases that a document has to be downloaded or viewed, this endpoint allows you to securely download the document given the Document Id.
\nResponse Notes
\nThis endpoint allows you to send a copy of a document to someone via email. Just provide the DocumentId of the document you want to send, recipient's email address, email subject, and a message.
\n","urlObject":{"protocol":"https","path":["v1","document","send"],"host":["evaultapi","edocs","co"],"query":[],"variable":[]}},"response":[{"id":"3a321b6e-f119-4e1b-8beb-3d8a758ba28a","name":"Send A Document","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"documentId\": \"8f239833580f0b06b553bc2c66307070dafeded8\",\r\n\t\"recipientEmail\": \"johnsmith@test.com\",\r\n\t\"emailSubject\": \"This is the subject text\",\r\n \"emailMessage\": \"This is the message text.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://evaultapi.edocs.co/v1/document/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Strict-Transport-Security","value":"max-age=2592000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 11 Mar 2021 08:25:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"documentId\": \"8f239833580f0b06b553bc2c66307070dafeded8\",\n \"status\": \"Success\"\n}"}],"_postman_id":"02007520-90ca-4624-a39b-72314e386b72"},{"name":"Mark a Document as Paid","id":"b116e927-0ecb-41ee-96ab-f217d5e2a772","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"This endpoint allows you to mark a document as paid. A copy of the document will be watermarked and sent to a recipient via email. This is particularly useful for loan documents.\n
\nFor this request, you will need to provide the DocumentId of the document, recipient's email address, email message, and the watermark text and subtext you want applied to the document. The WatermarkText will appear on top of the WatermarkSubText.
This endpoint will delete the document from the e-vault. Once deleted, the document will no longer be available for download.
\nResponse Notes
\nThis endpoint allows you to upload an additional document that is linked to an existing document or contract.\n
\n
Request Notes
\nResponse Notes
\nThis endpoint allows you to get a list of uploaded additional documents linked to your main document.\n
\n
Response Notes
\nUse this endpoint to download a specific document or file. You will need to provide the FileId which is given in the response when you upload or by using the endpoint Get Additional Documents List.
\n","urlObject":{"protocol":"https","path":["v1","document","{DocumentId}","additionaldocument","{FileId}"],"host":["evaultapi","edocs","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"5760599a-cda4-44fa-9da4-23a4c9dd38e4"}],"id":"38ea76f8-e03c-42b6-a716-0cb02d7c3ee4","description":"Additional Documents are documents or files that you want to link to your main document or contract. These can be identification cards (e.g. drivers license) or pay stubs or any other documents. Valid file types are pdf, jpeg, and png.
\n","event":[{"listen":"prerequest","script":{"id":"f21b6c8d-685f-4894-b87a-1fd56debd31d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5d0b3a8e-823f-4279-b535-12018b4b5103","type":"text/javascript","exec":[""]}}],"_postman_id":"38ea76f8-e03c-42b6-a716-0cb02d7c3ee4"}],"event":[{"listen":"prerequest","script":{"id":"0fee1c74-a6e6-4827-99c3-bff2eae7f912","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5e6a74b1-1862-4e3b-91ab-59c8b5d57acf","type":"text/javascript","exec":[""]}}]}