Before diving into the API, it is important to understand a few concepts about Pima.
\nPima's objective is to help your team automate the process of sharing confidential documents, usually related to compliance, with other companies interested in your product.
\nBefore Pima, when an Account Executive (AE) would get a request from a prospect about compliance documents, the process would usually go like that.
\nIn the description of the scenario above, you will see highlighted 4 different concepts that Pima tries to capture, in order to help you share confidential documents securely with your prospects.
\nCompliance documents most commonly requested to your team. SOC2, Pentest, Security Policies etc.
\nDocuments that must be signed by the other party for a step to move forward. Non Disclosure Agreements, Data Processing Addendums,
\nAn envelope is what Pima sends to your prospects and customers when they request documents. It can consist of one or more Documents, and Agreements can be combined with them as a pre-requisite, preventing the recipient from accessing the documents until the Agreement has been signed.
\nA request is what a prospect or a customer asks from you. It can be any Document or Agreement that you decide to publicly list for request. Requests can be approved both manually, or automatically based on a set of rules.
\nNote: All Documents and Agreements must be PDFs.
\nSign up for Pima.app and email sales@pima.app with the title \"Request to join API for [Company Name]\".
\nOnce approved, you will find your API key under https://my.pima.app/settings/developer
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"}],"owner":"13782429","collectionId":"a476b499-3507-4f84-88ca-3c67e916411d","publishedId":"TVmS9GHd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0075E0"},"publishDate":"2020-12-11T19:27:17.000Z"},"item":[{"name":"Resources","item":[{"name":"List Agreements","id":"a17c8971-9ad1-4c31-9008-457a33a78469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Anyone with this API key can get access to your Pima account. If it is compromised, immediately Regenerate or Delete the API key.
\n
Agreement File
\n","type":"file","src":"/Users/pierreuno/Projects/pima/public/pima_example.pdf"},{"key":"agreement_resource[name]","value":"My Agreement","description":"Agreement Name
\n","type":"text"},{"key":"agreement_resource[description]","value":"My Agreement Description","description":"Agreement Description
\n","type":"text"}]},"url":"http://my.pima.app/api/v1/agreements","urlObject":{"path":["agreements"],"host":["http://my.pima.app/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"01f01c2d-8b13-4df0-8a69-c1571a1a727b"},{"name":"List Documents","id":"31fc736f-a015-44e1-a902-d6160a87fa96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Document File
\n","type":"file","src":"/Users/pierreuno/Projects/pima/public/pima_example.pdf"},{"key":"document_resource[name]","value":"My Document","description":"Document Name
\n","type":"text"},{"key":"document_resource[description]","value":"My Document Description","description":"Document Description
\n","type":"text"}]},"url":"http://my.pima.app/api/v1/documents","urlObject":{"path":["documents"],"host":["http://my.pima.app/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"295d72ac-f72c-451e-9853-6b43bc514220"},{"name":"List Signed Agreements","id":"424e4cf5-3f59-4abd-82a4-de958b99f036","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://my.pima.app/api/v1/agreements/signed","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Name of the requester's Company
\n","type":"text","contentType":""},{"key":"request[email]","value":"expert@acme.com","description":"Requester's email
\n","type":"text"},{"key":"request[first_name]","value":"Security","description":"Requester's first name
\n","type":"text"},{"key":"request[last_name]","value":"Expert","description":"Requester's last name
\n","type":"text","contentType":""},{"key":"request[tos_accepted]","value":"1","description":"Request must accept TOS
\n","type":"text","contentType":""},{"key":"request[agreement_resource_ids]","value":"[1, 2, 3]","description":"Request agreement resources
\n","type":"text"},{"key":"request[document_resource_ids]","value":"[1, 2, 3]","description":"Request document resources
\n","type":"text"}]},"url":"http://my.pima.app/api/v1/requests","urlObject":{"path":["requests"],"host":["http://my.pima.app/api/v1"],"query":[],"variable":[]}},"response":[{"id":"844f0470-8c5c-43dd-ae4a-f869bb3bd80b","name":"Create Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"request[company_name]","value":"Acme","description":"Name of the requester's Company","type":"text","contentType":""},{"key":"request[email]","value":"expert@acme.com","description":"Requester's email","type":"text"},{"key":"request[first_name]","value":"Security","description":"Requester's first name","type":"text"},{"key":"request[last_name]","value":"Expert","description":"Requester's last name","type":"text","contentType":""},{"key":"request[tos_accepted]","value":"1","description":"Request must accept TOS","type":"text","contentType":""},{"key":"request[agreement_resource_ids]","value":"[1, 2, 3]","description":"Request agreement resources ","type":"text"},{"key":"request[document_resource_ids]","value":"[1, 2, 3]","description":"Request document resources","type":"text"}]},"url":"http://my.pima.app/api/v1/requests"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"e2c377ac8e0329869cb8e1a6e9a66812\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"be7e4dad-51e8-4a83-a847-74b0ca353d82"},{"key":"X-Runtime","value":"0.439643"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"expert@acme.com\",\n \"first_name\": \"Security\",\n \"last_name\": \"Expert\",\n \"slug\": \"pima-acme-request-b7f2efdf-d62d-40eb-81b7-5f9d421b1549\",\n \"status\": \"confirm_email\",\n \"created_at\": \"2020-12-11T09:39:13-08:00\"\n}"}],"_postman_id":"73f27718-467b-46a5-8dc2-e64e2f802b7a"}],"id":"354d4d79-f049-48fb-b669-97419131cf85","_postman_id":"354d4d79-f049-48fb-b669-97419131cf85","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Company Name
\n","type":"text"},{"key":"company[first_name]","value":"Security","description":"Company Contact First Name
\n","type":"text"},{"key":"company[last_name]","value":"Expert","description":"Company Contact Last Name
\n","type":"text"},{"key":"company[email]","value":"expert@acme.me","description":"Company Contact Email
\n","type":"text"}]},"url":"http://my.pima.app/api/v1/companies","urlObject":{"path":["companies"],"host":["http://my.pima.app/api/v1"],"query":[],"variable":[]}},"response":[{"id":"891ec057-7b17-4d7b-9658-548c270f3342","name":"Create Company","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"company[company_name]","value":"Acme","description":"Company Name","type":"text"},{"key":"company[first_name]","value":"Security","description":"Company Contact First Name","type":"text"},{"key":"company[last_name]","value":"Expert","description":"Company Contact Last Name","type":"text"},{"key":"company[email]","value":"expert@acme.me","description":"Company Contact Email","type":"text"}]},"url":"http://my.pima.app/api/v1/companies"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"469d713e1d3d108fe00c4e1eda757df0\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"91df4ae7-7ab5-46eb-b79d-022198fe9166"},{"key":"X-Runtime","value":"1.832012"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 25,\n \"domain\": \"acme.me\",\n \"name\": \"Acme\",\n \"slug\": \"acme-d7f04abd-61f3-4899-aa68-3b5a85da25d7\",\n \"contacts\": [\n {\n \"id\": 32,\n \"contact_has_received_documents\": false,\n \"email\": \"expert@acme.trucccc\",\n \"first_name\": \"Security\",\n \"last_name\": \"Expert\",\n \"user_id\": null\n }\n ],\n \"envelopes\": []\n}"}],"_postman_id":"146497d1-2274-4dc5-b144-496eebf155b3"},{"name":"Create Company's Contact","id":"a536c423-0f95-4517-9696-a8a9094902ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"Contact ID that will be assigned as Agreement signer
\n","type":"text"},{"key":"share[contact_ids]","value":"[30]","description":"Contact IDs that will be notified of new envelopee
\n","type":"text"},{"key":"share[agreement_resource_ids]","value":"[1]","description":"Agreement Resource IDs to add to envelope
\n","type":"text"},{"key":"share[document_resource_ids]","value":"[7, 8]","description":"Document Resource IDs to add to envelope
\n","type":"text"}]},"url":"http://my.pima.app/api/v1/companies/23/send_envelope","description":"Share agreements and documents to company's contacts
\n","urlObject":{"path":["companies","23","send_envelope"],"host":["http://my.pima.app/api/v1"],"query":[],"variable":[]}},"response":[{"id":"7ed62b11-55f4-4a48-8dd7-0ae1d6aaf139","name":"Send Envelope","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"share[signer_id]","value":"30","description":"Contact ID that will be assigned as Agreement signer","type":"text"},{"key":"share[contact_ids]","value":"[30]","description":"Contact IDs that will be notified of new envelopee","type":"text"},{"key":"share[agreement_resource_ids]","value":"[1]","description":"Agreement Resource IDs to add to envelope","type":"text"},{"key":"share[document_resource_ids]","value":"[7, 8]","description":"Document Resource IDs to add to envelope","type":"text"}]},"url":"http://my.pima.app/api/v1/companies/23/send_envelope"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"2de5c7d30be7c6dc573e306658db2489\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8996ce1c-d211-4aaf-93bf-e036db4f4800"},{"key":"X-Runtime","value":"0.940333"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 23,\n \"domain\": \"acme.truc\",\n \"name\": \"Acme\",\n \"slug\": \"acme-025be3a7-dd45-4b49-acd4-38cd3aa44ad9\",\n \"contacts\": [\n {\n \"id\": 30,\n \"contact_has_received_documents\": false,\n \"email\": \"expert@acme.truc\",\n \"first_name\": \"Security\",\n \"last_name\": \"Expert\",\n \"user_id\": 32\n }\n ],\n \"envelopes\": []\n}"}],"_postman_id":"4b251e69-7247-4aa0-a9fe-41bcfc69bbbf"}],"id":"9414e8f3-f06d-42b4-b579-841c05e4a5ef","_postman_id":"9414e8f3-f06d-42b4-b579-841c05e4a5ef","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"