# Table of Contents - [API Documentation | Hancock](#api-documentation-hancock) --- # API Documentation | Hancock API overview API reference account.hancock.ink/v1 api.hancock.ink/v1 API overview ------------ #### Overview The Hancock Documents API is used to store, add, update, manage, convert, share documents and send documents out to be signed by others. It strives to be [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer)  and is organized around the main resources you’re familiar with from the Hancock web interface such as **Documents, users, signature Requests** etc. Before you do anything, you should [create a Hancock account](https://idp.hancock.ink/v0/oidc/auth?client_id=e47d1509264606462ebb9c2e&response_type=id_token+code&redirect_uri=https%3A%2F%2Fapp.hancock.ink%2Fauthorize&nonce=NONCE&scope=openid&resource=https%3A%2F%2Faccount.hancock.ink)  that you can test the API and make API calls, using your authentication token. #### Example requests Sample API calls are provided next to each method using [cURL](https://curl.haxx.se/)  a standard command line tool. All you need to do is drop in your specific parameters, and test the calls from the command line. #### Input/Output format Both request body data and response data are formatted as [JSON.](https://www.json.org/)  Each ids except users ids must be the hexadecimal string representation of the [ObjectId.](https://docs.mongodb.com/manual/reference/method/ObjectId/) #### CORS [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) , or cross-origin resource sharing, is a mechanism that allows a web page to make XMLHttpRequests to another domain (i.e. a domain different from the one it was loaded from). CORS is supported in a specific set of modern browsers. The Hancock Documents API supports CORS.  #### HTTP status codes The Hancock API communicates errors through [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)  with details supplied in JSON objects. Generally the following pattern applies: 2xx Hancock received, understood, and accepted a request. 3xx The user agent must take further action in order to complete the request. 4xx An error occurred in handling the request. The most common cause of this error is an invalid parameter. 5xx The API failed to fulfill an apparently valid request 200 success 201 created 202 accepted 400 bad\_request 401 unauthorized 403 forbidden 404 not\_found 409 conflicts 500 internal\_server\_error #### Rate limits The maximum number of requests that are allowed is based on a time interval, some specified period or window of time. Hancock request limit interval is one minute. Most of endpoints have a rate limit of 60 requests/1-minute, then up to 60 requests over any 1-minute interval is allowed. The **Retry-After** HTTP Header is an HTTP response header that indicates how long to wait before making another request. Hancock uses the Retry-After HTTP Header with value. \* 60 requests over any 1-minute interval /sign\_up 3 requests over any 1-minute interval /organizations\_create 3 requests over any 1-minute interval /feedback\_create 3 requests over any 1-minute interval #### Error code response status \* (int) The HTTP status of the response. code \* (string) A machine-readable string describing the error. massage \* (string) A human-readable message describing the error. source \* (object) Points to the error source. meta \* (object) Object containing specific information. { "status": "404", "code": "object\_not\_found", "message": "Document not found." } #### Detailed error codes The following table lists the most common error responses you are likely to see when using Hancock API. This list is not exhaustive; additional errors can occur. If your application handles all of these responses, though, then it's likely to be a robust application that gracefully handles the majority of user interactions and internet issues. 400 (read\_only\_property) Property name is read only. 400 (required\_property) Property name is required. 400 (request\_validation\_error) Should NOT have additional properties. 401 (unauthorized) Authorization failed. 401 (invalid\_tiket) Ticket validation failed. 401 (invalid\_session) Session is invalid. 401 (invalid\_token) Token validation failed. 403 (forbidden) Action is not permitted for non-draft recourse. 403 (permission\_denied) You have no type access to specified name. 403 (limit\_exceeded) Limit of name usage is exceeded. 404 (not\_found) Resource with id not found. 404 (not\_found) Resource not found. 404 (route\_not\_found) Route not found. 404 (version\_not\_found) Recourse with id and version not found 404 (recourse\_removed) Recourse removed. 409 (conflict) Conflict performing action on recourse with parameter. 500 (internal\_error) User does not have some data #### Supported file types The Hancock API currently supports the following file types: Document .pdf, .doc, .docx, .rtf, .txt Drawing .psd Image .bmp, .gif, .jpg, .jpeg, .png, .tif, .tiff Presentation .ppt, .pptx Spreadsheet .xls, .xlsx, .xlt #### Logging in Hancock uses OAuth to authenticate connections that use the Hancock APIs. Most of Hancock APIs routes requires authentication so that Hancock can ensure that only authorized users can interact with Hancock content.The Hancock API uses bearer tokens presented in Authorization header to verify every request.Our authentication service issues an **access\_token** with the Hancock API identifier **aud** claim. This token also contains a user identifier in the **sub** claim.Authorization header example: Header Authorization: Bearer YOUR\_ACCESS\_TOKEN' \\ **access\_token** payload example: { "iss": "https://account.hancock.ink/", "sub": "google-oauth2|106616741942552178639", "aud": "M1c9RYyzzm1dfBxZtUhGH56S6ajQeFRK", "exp": "1485827159", "iat": "1482227159" } Hancock API verifies an **access\_token** each request, and particular requester is identified by the **sub** claim.The requester session state remains unknown to the Hancock API, so the client should manually manage an access\_token lifetime and reissuing utilizing our authentication services to provide a necessary level of security. #### Request description Aactivates integration if avaliable. { "name": "identity\_front", "keys": { "foo": "bar" } } { "id": "654e1a281ece4da494ee1a1a", "name": "identity\_front" } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Integration with name dropbox not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Deactivates integration if available. { "name": "identity\_front" } { "id": "654e1a281ece4da494ee1a1a", "name": "identity\_front" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Integration with name dropbox not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns profile identified by current token. { "id": "654e1a281ece4da494ee1a1a", "updatedAt": "2012-09-07T00:00:00.000Z", "createdAt": "2012-09-07T00:00:00.000Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "654e1a281ece4da494ee1a1a", "birthDate": "2012-09-07T00:00:00.000Z", "country": "United States", "city": "New York", "company": "IBM", "locale": "en", "featureFlags": { "transactionsQuota": 5, "templatesQuote": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false }, "notificationPriority": "email", "notificationSettings": 4194303, "theme": "auto", "attributes": { "billingUsed": true, "cookiesConsentDate": "2012-09-07T00:00:00.000Z" } } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Profile with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates profile identified by current token { "firstName": "John", "lastName": "Doe" } { "id": "654e1a281ece4da494ee1a1a", "updatedAt": "2012-09-07T00:00:00.000Z", "createdAt": "2012-09-07T00:00:00.000Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "654e1a281ece4da494ee1a1a", "birthDate": "2012-09-07T00:00:00.000Z", "country": "United States", "city": "New York", "company": "IBM", "locale": "en", "featureFlags": { "transactionsQuota": 5, "templatesQuote": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false }, "notificationPriority": "email", "notificationSettings": 4194303, "theme": "auto", "attributes": { "billingUsed": true, "cookiesConsentDate": "2012-09-07T00:00:00.000Z" } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Profile with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request 400 (unable\_to\_set\_avatar) Use /profile/get\_avatar\_upload\_url to upload avatar. #### Request description Updates cookie consent date into profile attributes. { "id": "654e1a281ece4da494ee1a1a", "updatedAt": "2012-09-07T00:00:00.000Z", "createdAt": "2012-09-07T00:00:00.000Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "654e1a281ece4da494ee1a1a", "birthDate": "2012-09-07T00:00:00.000Z", "country": "United States", "city": "New York", "company": "IBM", "locale": "en", "featureFlags": { "transactionsQuota": 5, "templatesQuote": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false }, "notificationPriority": "email", "notificationSettings": 4194303, "theme": "auto", "attributes": { "billingUsed": true, "cookiesConsentDate": "2012-09-07T00:00:00.000Z" } } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Profile with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates passkey promotion date into profile attributes. { "id": "654e1a281ece4da494ee1a1a", "updatedAt": "2012-09-07T00:00:00.000Z", "createdAt": "2012-09-07T00:00:00.000Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "654e1a281ece4da494ee1a1a", "birthDate": "2012-09-07T00:00:00.000Z", "country": "United States", "city": "New York", "company": "IBM", "locale": "en", "featureFlags": { "transactionsQuota": 5, "templatesQuote": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false }, "notificationPriority": "email", "notificationSettings": 4194303, "theme": "auto", "attributes": { "billingUsed": true, "cookiesConsentDate": "2012-09-07T00:00:00.000Z" } } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Profile with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Creates a new contact, email or phone are required { "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "avatar": "https://example.com/avatar.jpg" } { "firstName": "Tim", "lastName": "Tyler", "phone": "+1234567890", "avatar": "https://example.com/avatar.jpg" } { "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+1234567890", "avatar": "https://example.com/avatar.jpg" } { "id": "554e1a281ece4da494ee1eee", "createdAt": "2019-07-23T14:38:48.281Z", "updatedAt": "2019-07-23T14:38:48.281Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "https://example.com/avatar.jpg" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns your contacts list. Supported sorting fields: firstName, lastName, email, phone. { "id": "554e1a281ece4da494ee1eee", "createdAt": "2019-07-23T14:38:48.281Z", "updatedAt": "2019-07-23T14:38:48.281Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "https://example.com/avatar.jpg" } #### Errors 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates the contact #### Params id \* (path) Object identifier (BSON ObjectId string) { "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "https://example.com/avatar.jpg" } { "id": "554e1a281ece4da494ee1eee", "createdAt": "2019-07-23T14:38:48.281Z", "updatedAt": "2019-07-23T14:38:48.281Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "https://example.com/avatar.jpg" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Object with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Removes the contact from your list #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "554e1a281ece4da494ee1eee", "createdAt": "2019-07-23T14:38:48.281Z", "updatedAt": "2019-07-23T14:38:48.281Z", "firstName": "Tim", "lastName": "Tyler", "email": "tim.tyler@example.com", "phone": "+123456789012", "avatar": "https://example.com/avatar.jpg" } #### Errors 401 (unauthorized) Authorization failed. 404 (object\_not\_found) Object with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Creates a new media metadata only if file is uploaded to the file storage, by creating a new item you can't optionaly use it by default. Use /media/{id} route for change it to default. #### Params ticket (query) The ticket to perform some kind of action { "type": "avatar", "fillType": "capture", "imageRef": "554e1a281ece4da494ee1eee" } { "id": "45cbc4a0e4123f6920000001", "updatedAt": "2019-07-23T14:38:48.281Z", "createdAt": "2019-07-23T14:38:48.281Z", "ownerId": "554e1a281ece4da494ee1eee", "imageRef": "554e1a281ece4da494ee1eee", "default": true, "type": "avatar", "fillType": "capture" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns a list of profile media files \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "updatedAt": "2019-07-23T14:38:48.281Z",\ "createdAt": "2019-07-23T14:38:48.281Z",\ "ownerId": "554e1a281ece4da494ee1eee",\ "imageRef": "554e1a281ece4da494ee1eee",\ "imageUrl": "https://bucket/path/avatar1.png",\ "default": true,\ "type": "avatar",\ "fillType": "capture"\ },\ {\ "id": "45cbc4a0e4123f6920000001",\ "updatedAt": "2019-07-23T14:38:48.281Z",\ "createdAt": "2019-07-23T14:38:48.281Z",\ "ownerId": "554e1a281ece4da494ee1eee",\ "imageRef": "554e1a281ece4da494ee1eee",\ "imageUrl": "https://bucket/path/avatar1.png",\ "default": false,\ "type": "photo",\ "fillType": "upload"\ }\ \] #### Errors 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Is only thing avaliable to update is use by default flag. Profile media consist of different types of media files and user able select single media per type to make it used by default. Use this route to change default media for certain type #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "45cbc4a0e4123f6920000001", "updatedAt": "2019-07-23T14:38:48.281Z", "createdAt": "2019-07-23T14:38:48.281Z", "ownerId": "554e1a281ece4da494ee1eee", "imageRef": "554e1a281ece4da494ee1eee", "default": true, "type": "avatar", "fillType": "capture" } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Media with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Removes the media metadata and file #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "45cbc4a0e4123f6920000001", "updatedAt": "2019-07-23T14:38:48.281Z", "createdAt": "2019-07-23T14:38:48.281Z", "ownerId": "554e1a281ece4da494ee1eee", "imageRef": "554e1a281ece4da494ee1eee", "default": true, "type": "avatar", "fillType": "capture" } #### Errors 401 (unauthorized) Authorization failed. 404 (object\_not\_found) Media with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns media body download URL #### Params id \* (path) Object identifier (BSON ObjectId string) { "url": "https://someurl.com/some\_signed\_path?signature=45cbc4a0e4123f6920000001" } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) Media with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns a media upload temporary url and file identifier. #### Params ticket (query) The ticket to perform some kind of action { "mimeType": "image/png" } { "url": "https://someurl.com/some\_signed\_path?signature=45cbc4a0e4123f6920000001", "imageRef": "45cbc4a0e4123f6920000001" } #### Errors 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns a media upload temporary url and file identifier. #### Params ticket (query) The ticket to perform some kind of action { "mimeType": "image/png", "imageRef": "554e1a281ece4da494ee1eee" } { "url": "https://someurl.com/some\_signed\_path?signature=45cbc4a0e4123f6920000001", "imageRef": "45cbc4a0e4123f6920000001" } #### Errors 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Trigger send SMS to user with ticket for authenticate user for a short session { "type": "signature" } #### Errors 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns an information about current subscription of certain user. #### Params orgId (query) The org context in which resource will be created { "plan": "h\_b\_m", "startedAt": "2019-11-21T12:19:29.000Z", "endAt": "2019-12-21T12:19:29.000Z" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Start subscription #### Params orgId (query) The org context in which resource will be created { "plan": "h\_b\_a" } { "plan": "h\_b\_m", "startedAt": "2019-11-21T12:19:29.000Z", "endAt": "2019-12-21T12:19:29.000Z" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Cancel current subscription #### Params orgId (query) The org context in which resource will be created { "plan": "h\_b\_m", "startedAt": "2019-11-21T12:19:29.000Z", "endAt": "2019-12-21T12:19:29.000Z" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns an information about current payment method #### Params orgId (query) The org context in which resource will be created { "name": "Friedrich Gauss", "cardLast4": 4242, "brand": "Visa", "expMonth": 10, "expYear": 2020, "city": "Brunswick", "country": "Germany", "address": "Street 5, House 2", "zipCode": "31520" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Applies payment method to the customer using stripe token. #### Params orgId (query) The org context in which resource will be created { "token": "token\_provided\_by\_stripe" } { "name": "Friedrich Gauss", "cardLast4": 4242, "brand": "Visa", "expMonth": 10, "expYear": 2020, "city": "Brunswick", "country": "Germany", "address": "Street 5, House 2", "zipCode": "31520" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 402 (card\_error) Unable to add a card. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Delete payment method. #### Params orgId (query) The org context in which resource will be created { "name": "Friedrich Gauss", "cardLast4": 4242, "brand": "Visa", "expMonth": 10, "expYear": 2020, "city": "Brunswick", "country": "Germany", "address": "Street 5, House 2", "zipCode": "31520" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 404 (object\_not\_found) Object with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns the list of the payments. #### Params orgId (query) The org context in which resource will be created \[\ {\ "amount": 1500,\ "plan": "h\_b\_a",\ "date": "2019-12-21T12:19:29.000Z",\ "state": "succeeded",\ "card": "4242"\ },\ {\ "amount": 1500,\ "plan": "h\_b\_a",\ "date": "2019-12-21T12:19:29.000Z",\ "state": "succeeded",\ "card": "4242"\ }\ \] #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Preview of pricing details after the promo code will be applied { "plan": "h\_b\_a", "promoCode": "SALE" } { "oldPrice": 200, "newPrice": 150, "currency": "usd", "discountAmount": 50, "discountRate": 25 } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Preview of customer's balance { "current": 100, "ending": 150 } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns the client secret for the payment intent for the current subscription for the authorized user account. The client secret can used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns the client secret for the setup intent for the current subscription for the authorized user account. The client secret used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Verify email with ticket #### Params ticket \* (query) #### Errors 400 (invalid\_session) Session is invalid. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Verify email #### Errors 429 (unable\_to\_send\_email) Verification email is only available once per 2 min. 500 (internal\_error) There was an error processing your request #### Request description Verify phone #### Params ticket \* (query) #### Errors 400 (invalid\_session) Session is invalid. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Send verification sms #### Errors 429 (unable\_to\_send\_sms) Verification sms is only available once per 2 min. 500 (internal\_error) There was an error processing your request #### Request description Delete user #### Errors 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get avatar upload url into the public bucket. { "fileId": "e3f56a280b2b38b3cfeef7cb", "uploadUrl": "https://hancock-dev-public.s3.amazonaws.com/avatar\_images/e3f56a280b2b38b3cfeef7cb?AWSAccessKeyId=AKIAUOEOZ3Q4KN5RR763&Content-Type=image%2Fpng&Expires=1574953172&Signature=0YDFAr%2BQLOEYmvy0A0psNMCCgGg%3D&x-amz-meta-owner-id=f5c1d61b482908d4245f91a1" } #### Errors 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns a ticket for connecting to server event stream. { "ticket": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlF6bEdSRGRETURVeU1Ea3lRekpFUVVFd01EZEN" } #### Errors #### Request description Internal route to generate a magic code for guest user Requires internal ticket with scope user:magic\_code { "userId": "6450c7dbffbec183dce320e5", "contact": { "email": "john@doe.com" } } { "code": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IlF6bEdSRGRETURVeU1Ea3lRekpFUVVFd01EZEN" } #### Errors 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Create new app { "name": "My App", "scopes": \[\ "file:read",\ "transaction:read",\ "template:read"\ \] } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My App", "ownerId": "654e1a281ece4da494ee1a1a", "scopes": \[\ "file:read",\ "transaction:read",\ "template:read"\ \], "clientId": "gg2kyyV4LG2Eg222rXPeqkMsKMRjeK3G", "clientSecret": "Rm235C8NZothByYK6LUCkM5NlyimgFBYuzsI2ice5GHd45k5eJ06WqrQpJ8jR5VV" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of apps (max 30 items in single response) #### Params exclusiveFrom (query) The key of last item returned from previous request, to start from next one { "apps": \[\ {\ "id": "e1cbfb4ea1fab8f29303bce6",\ "createdAt": "2020-10-09T11:52:06.939Z,",\ "updatedAt": "2020-10-09T11:52:06.939Z,",\ "name": "My App",\ "ownerId": "654e1a281ece4da494ee1a1a",\ "scopes": \[\ "file:read",\ "transaction:read",\ "template:read"\ \],\ "clientId": "gg2kyyV4LG2Eg222rXPeqkMsKMRjeK3G",\ "clientSecret": "Rm235C8NZothByYK6LUCkM5NlyimgFBYuzsI2ice5GHd45k5eJ06WqrQpJ8jR5VV"\ }\ \], "lastKey": null } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets app object #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My App", "ownerId": "654e1a281ece4da494ee1a1a", "scopes": \[\ "file:read",\ "transaction:read",\ "template:read"\ \], "clientId": "gg2kyyV4LG2Eg222rXPeqkMsKMRjeK3G", "clientSecret": "Rm235C8NZothByYK6LUCkM5NlyimgFBYuzsI2ice5GHd45k5eJ06WqrQpJ8jR5VV" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) App with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates the app #### Params id \* (path) Object identifier (BSON ObjectId string) { "name": "My App", "scopes": \[\ "contact:delete",\ "integrations:update"\ \] } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My App", "ownerId": "654e1a281ece4da494ee1a1a", "scopes": \[\ "file:read",\ "transaction:read",\ "template:read"\ \], "clientId": "gg2kyyV4LG2Eg222rXPeqkMsKMRjeK3G", "clientSecret": "Rm235C8NZothByYK6LUCkM5NlyimgFBYuzsI2ice5GHd45k5eJ06WqrQpJ8jR5VV" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) App with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Deletes the app #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My App", "ownerId": "654e1a281ece4da494ee1a1a", "scopes": \[\ "file:read",\ "transaction:read",\ "template:read"\ \], "clientId": "gg2kyyV4LG2Eg222rXPeqkMsKMRjeK3G", "clientSecret": "Rm235C8NZothByYK6LUCkM5NlyimgFBYuzsI2ice5GHd45k5eJ06WqrQpJ8jR5VV" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) App with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Obtains a token by client credentials { "clientId": "gg2kyyV4LG2Eg222rXPeqkMsKMRjeK3G", "clientSecret": "Rm235C8NZothByYK6LUCkM5NlyimgFBYuzsI2ice5GHd45k5eJ06WqrQpJ8jR5VV" } { "access\_token": "TOKEN", "token\_type": "Bearer", "expires\_in": 36000 } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Reset application secret key #### Params id \* (path) Object identifier (BSON ObjectId string) #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) App with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Create new organization { "name": "My Organization", "logo": "some.url" } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of organizations (max 30 items in single response) #### Params exclusiveFrom (query) The key of last item returned from previous request, to start from next one { "organizations": \[\ {\ "id": "e1cbfb4ea1fab8f29303bce6",\ "createdAt": "2020-10-09T11:52:06.939Z,",\ "updatedAt": "2020-10-09T11:52:06.939Z,",\ "name": "My Organization",\ "ownerId": "654e1a281ece4da494ee1a1a",\ "logo": "some.url",\ "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \],\ "globalSettings": {\ "createFiles": true,\ "createTransactions": true,\ "createTemplates": true,\ "createBulks": true\ },\ "subscription": "h\_e",\ "attributes": {\ "billingUsed": true,\ "promoCodesUsed": \[\]\ },\ "resources": {\ "transaction": 0,\ "template": 0,\ "paidTemplate": 0,\ "file": 0,\ "member": 0\ },\ "featureFlags": {\ "transactionsQuota": 5,\ "templatesQuota": 5,\ "membersQuota": 5,\ "allowAPIAccess": true,\ "allowAuditTrail": true,\ "allowAdvancedFields": true,\ "allowInPersonSigning": true,\ "allowFieldsValidations": true,\ "allowSignerReassignment": true,\ "allowReminderNotifications": true,\ "allowSmartCardTransactions": false,\ "allowQualifiedCertTransactions": false,\ "allowRemoteIdentityVerification": false,\ "allowTrustedCertificates": false\ }\ }\ \], "lastKey": null } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of invites into organizations { "createdAt": "2021-06-22T09:26:00.347Z", "id": "94421869ec82f108c6a6fdd6", "orgId": "5c4c2cb9d054e1f4f788ee6c", "orgLogo": "", "orgName": "TEST", "updatedAt": "2021-06-22T09:26:00.347Z" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Gets organization invite object #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Organization with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Accept organization invite #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Organization with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Reject organization invite #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Organization with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets organization object #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Organization with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates the organization #### Params id \* (path) Object identifier (BSON ObjectId string) { "name": "My Organization", "logo": "some.url" } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Organization with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Deletes the organization #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Organization with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Adds new members to organizations #### Params id \* (path) Object identifier (BSON ObjectId string) { "members": \[\ {\ "email": "john@doe.com"\ }\ \] } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Makes a member the admin of the organization #### Params id \* (path) Object identifier (BSON ObjectId string) { "makeAdmin": "654e1a281ece4da494ee1a1a" } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Makes a member the non-admin of the organization #### Params id \* (path) Object identifier (BSON ObjectId string) { "cancelAdmin": "654e1a281ece4da494ee1a1a" } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Deletes members from organization #### Params id \* (path) Object identifier (BSON ObjectId string) { "members": \[\ "654e1a281ece4da494ee1a1a"\ \] } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Leave from the organization #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Updates the organization member permissions #### Params id \* (path) Object identifier (BSON ObjectId string) memberId \* (path) Object identifier (BSON ObjectId string) { "permissions": { "createFiles": true, "createTransactions": true, "createTemplates": false, "createBulks": false } } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "name": "My Organization", "ownerId": "654e1a281ece4da494ee1a1a", "logo": "some.url", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "admin",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "role": "participant",\ "status": "active"\ }\ \], "globalSettings": { "createFiles": true, "createTransactions": true, "createTemplates": true, "createBulks": true }, "subscription": "h\_e", "attributes": { "billingUsed": true, "promoCodesUsed": \[\] }, "resources": { "transaction": 0, "template": 0, "paidTemplate": 0, "file": 0, "member": 0 }, "featureFlags": { "transactionsQuota": 5, "templatesQuota": 5, "membersQuota": 5, "allowAPIAccess": true, "allowAuditTrail": true, "allowAdvancedFields": true, "allowInPersonSigning": true, "allowFieldsValidations": true, "allowSignerReassignment": true, "allowReminderNotifications": true, "allowSmartCardTransactions": false, "allowQualifiedCertTransactions": false, "allowRemoteIdentityVerification": false, "allowTrustedCertificates": false } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Organization with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of teams in current organization (max 30 items in single response) #### Params exclusiveFrom (query) The key of last item returned from previous request, to start from next one orgId \* (path) Object identifier (BSON ObjectId string) { "organizations": \[\ {\ "id": "e1cbfb4ea1fab8f29303bce6",\ "createdAt": "2020-10-09T11:52:06.939Z,",\ "updatedAt": "2020-10-09T11:52:06.939Z,",\ "orgId": "e1cbfb4ea1fab8f29303bce6",\ "adminId": "654e1a281ece4da494ee1a1a",\ "description": "Peculiar Ventures Engineering Team",\ "name": "Engineering",\ "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ }\ \]\ }\ \], "lastKey": null } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Create new team in organization #### Params orgId \* (path) Object identifier (BSON ObjectId string) { "name": "PV Team", "description": "Ingeneering team" } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "orgId": "e1cbfb4ea1fab8f29303bce6", "adminId": "654e1a281ece4da494ee1a1a", "description": "Peculiar Ventures Engineering Team", "name": "Engineering", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Gets team object #### Params id \* (path) Object identifier (BSON ObjectId string) orgId \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "orgId": "e1cbfb4ea1fab8f29303bce6", "adminId": "654e1a281ece4da494ee1a1a", "description": "Peculiar Ventures Engineering Team", "name": "Engineering", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Team with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Deletes the team #### Params id \* (path) Object identifier (BSON ObjectId string) orgId \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "orgId": "e1cbfb4ea1fab8f29303bce6", "adminId": "654e1a281ece4da494ee1a1a", "description": "Peculiar Ventures Engineering Team", "name": "Engineering", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Team with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates the team #### Params id \* (path) Object identifier (BSON ObjectId string) orgId \* (path) Object identifier (BSON ObjectId string) { "name": "My Team", "description": "Ingeneering" } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "orgId": "e1cbfb4ea1fab8f29303bce6", "adminId": "654e1a281ece4da494ee1a1a", "description": "Peculiar Ventures Engineering Team", "name": "Engineering", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Team with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Deletes members from team #### Params id \* (path) Object identifier (BSON ObjectId string) orgId \* (path) Object identifier (BSON ObjectId string) { "members": \[\ "654e1a281ece4da494ee1a1a"\ \] } { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "orgId": "e1cbfb4ea1fab8f29303bce6", "adminId": "654e1a281ece4da494ee1a1a", "description": "Peculiar Ventures Engineering Team", "name": "Engineering", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Leave member from the team #### Params id \* (path) Object identifier (BSON ObjectId string) orgId \* (path) Object identifier (BSON ObjectId string) { "id": "e1cbfb4ea1fab8f29303bce6", "createdAt": "2020-10-09T11:52:06.939Z,", "updatedAt": "2020-10-09T11:52:06.939Z,", "orgId": "e1cbfb4ea1fab8f29303bce6", "adminId": "654e1a281ece4da494ee1a1a", "description": "Peculiar Ventures Engineering Team", "name": "Engineering", "members": \[\ {\ "id": "fe5e1a281ece4da494ee2b2b",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "a@b.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ },\ {\ "id": "473e1a281ece4da49ece4da4",\ "avatar": "https://lh6.googleusercontent.com/photo.jpg",\ "email": "b@c.com",\ "firstName": "Test",\ "lastName": "User",\ "phone": "empty",\ "status": "active"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 500 (internal\_error) There was an error processing your request #### Request description Creates file metadata #### Params orgId (query) The org context in which resource will be created { "attributes": { "title": "Application Form" }, "bodyRef": "554e1a281ece4da494ee1eee", "public": true } { "id": "586f8b370ece4cb684821aae", "ownerId": "654e1a281ece4da494ee1a1a", "bodyRef": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "354e1a281ece4da494ee1a1b",\ "586f8b370ece4cb684821aae"\ \], "version": 1, "attributes": { "title": "My title", "fields": \[\ {\ "type": "text",\ "recipient": {\ "id": "554e1a281ece4da494ee1eee",\ "firstName": "Tim",\ "lastName": "Tyler",\ "email": "tim.tyler@example.com",\ "phone": "+123456789012",\ "avatar": "https://example.com/avatar.jpg"\ },\ "page": 0,\ "rect": \[\ 50,\ 50,\ 200,\ 20\ \],\ "fieldName": "First name",\ "value": "",\ "readonly": false,\ "required": false,\ "label": false,\ "comb": false,\ "multiline": false,\ "permittedTypes": \[\ "smartphone",\ "draw",\ "typeIn",\ "upload"\ \],\ "textColor": "#40484F",\ "ratio": 1,\ "maxLength": 256,\ "textAlign": "left",\ "textFormat": "letters",\ "dateFormat": null\ }\ \], "signatures": \[\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "signature",\ "states": \[\ {\ "type": "info",\ "text": "Location: Mars"\ },\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com"\ },\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "timestamp",\ "states": \[\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com",\ "serialNumber": "9223372036854775807"\ }\ \], "type": "document" }, "createdAt": "2012-09-07T00:00:00.000Z", "updatedAt": "2012-09-07T00:00:00.000Z", "public": false } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) File Body with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns file meta data. #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "586f8b370ece4cb684821aae", "ownerId": "654e1a281ece4da494ee1a1a", "bodyRef": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "354e1a281ece4da494ee1a1b",\ "586f8b370ece4cb684821aae"\ \], "version": 1, "attributes": { "title": "My title", "fields": \[\ {\ "type": "text",\ "recipient": {\ "id": "554e1a281ece4da494ee1eee",\ "firstName": "Tim",\ "lastName": "Tyler",\ "email": "tim.tyler@example.com",\ "phone": "+123456789012",\ "avatar": "https://example.com/avatar.jpg"\ },\ "page": 0,\ "rect": \[\ 50,\ 50,\ 200,\ 20\ \],\ "fieldName": "First name",\ "value": "",\ "readonly": false,\ "required": false,\ "label": false,\ "comb": false,\ "multiline": false,\ "permittedTypes": \[\ "smartphone",\ "draw",\ "typeIn",\ "upload"\ \],\ "textColor": "#40484F",\ "ratio": 1,\ "maxLength": 256,\ "textAlign": "left",\ "textFormat": "letters",\ "dateFormat": null\ }\ \], "signatures": \[\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "signature",\ "states": \[\ {\ "type": "info",\ "text": "Location: Mars"\ },\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com"\ },\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "timestamp",\ "states": \[\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com",\ "serialNumber": "9223372036854775807"\ }\ \], "type": "document" }, "createdAt": "2012-09-07T00:00:00.000Z", "updatedAt": "2012-09-07T00:00:00.000Z", "public": false } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates a file meta data. A profile may have specific fields updates permissions. #### Params id \* (path) Object identifier (BSON ObjectId string) { "attributes": { "title": "Application Form" }, "public": true } { "id": "586f8b370ece4cb684821aae", "ownerId": "654e1a281ece4da494ee1a1a", "bodyRef": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "354e1a281ece4da494ee1a1b",\ "586f8b370ece4cb684821aae"\ \], "version": 1, "attributes": { "title": "My title", "fields": \[\ {\ "type": "text",\ "recipient": {\ "id": "554e1a281ece4da494ee1eee",\ "firstName": "Tim",\ "lastName": "Tyler",\ "email": "tim.tyler@example.com",\ "phone": "+123456789012",\ "avatar": "https://example.com/avatar.jpg"\ },\ "page": 0,\ "rect": \[\ 50,\ 50,\ 200,\ 20\ \],\ "fieldName": "First name",\ "value": "",\ "readonly": false,\ "required": false,\ "label": false,\ "comb": false,\ "multiline": false,\ "permittedTypes": \[\ "smartphone",\ "draw",\ "typeIn",\ "upload"\ \],\ "textColor": "#40484F",\ "ratio": 1,\ "maxLength": 256,\ "textAlign": "left",\ "textFormat": "letters",\ "dateFormat": null\ }\ \], "signatures": \[\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "signature",\ "states": \[\ {\ "type": "info",\ "text": "Location: Mars"\ },\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com"\ },\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "timestamp",\ "states": \[\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com",\ "serialNumber": "9223372036854775807"\ }\ \], "type": "document" }, "createdAt": "2012-09-07T00:00:00.000Z", "updatedAt": "2012-09-07T00:00:00.000Z", "public": false } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns file body download URL #### Params id \* (path) Object identifier (BSON ObjectId string) { "url": "https://someurl.com/some\_signed\_path?signature=45cbc4a0e4123f6920000001" } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns a file upload temporary url and file identifier. { "mimeType": "application/pdf" } { "url": "https://someurl.com/some\_signed\_path?signature=45cbc4a0e4123f6920000001", "bodyRef": "45cbc4a0e4123f6920000001" } #### Errors 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Returns a file update temporary url and next file version. #### Params id \* (path) Object identifier (BSON ObjectId string) { "mimeType": "application/pdf" } { "url": "https://someurl.com/some\_signed\_path?signature=45cbc4a0e4123f6920000001", "version": "3" } #### Errors 401 (unauthorized) Authorization failed. 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Removes the file #### Params id \* (path) Object identifier (BSON ObjectId string) { "id": "586f8b370ece4cb684821aae", "ownerId": "654e1a281ece4da494ee1a1a", "bodyRef": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "354e1a281ece4da494ee1a1b",\ "586f8b370ece4cb684821aae"\ \], "version": 1, "attributes": { "title": "My title", "fields": \[\ {\ "type": "text",\ "recipient": {\ "id": "554e1a281ece4da494ee1eee",\ "firstName": "Tim",\ "lastName": "Tyler",\ "email": "tim.tyler@example.com",\ "phone": "+123456789012",\ "avatar": "https://example.com/avatar.jpg"\ },\ "page": 0,\ "rect": \[\ 50,\ 50,\ 200,\ 20\ \],\ "fieldName": "First name",\ "value": "",\ "readonly": false,\ "required": false,\ "label": false,\ "comb": false,\ "multiline": false,\ "permittedTypes": \[\ "smartphone",\ "draw",\ "typeIn",\ "upload"\ \],\ "textColor": "#40484F",\ "ratio": 1,\ "maxLength": 256,\ "textAlign": "left",\ "textFormat": "letters",\ "dateFormat": null\ }\ \], "signatures": \[\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "signature",\ "states": \[\ {\ "type": "info",\ "text": "Location: Mars"\ },\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com"\ },\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "timestamp",\ "states": \[\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com",\ "serialNumber": "9223372036854775807"\ }\ \], "type": "document" }, "createdAt": "2012-09-07T00:00:00.000Z", "updatedAt": "2012-09-07T00:00:00.000Z", "public": false } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 500 (internal\_error) There was an error processing your request #### Request description Run a file conversion Job. #### Params id \* (path) Object identifier (BSON ObjectId string) { "jobId": "554e1a281ece4da494ee1eee" } #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get all participants list #### Params id \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "participant",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "participant",\ "isOwner": true\ }\ \], "changeOwnerAllowed": true } #### Errors 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Add new user to access list #### Params id \* (path) Object identifier (BSON ObjectId string) { "email": "user\_2@mail.com", "firstName": "John", "lastName": "Doe" } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "participant",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "participant",\ "isOwner": true\ }\ \], "changeOwnerAllowed": true } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Changes owner of the file #### Params id \* (path) Object identifier (BSON ObjectId string) { "userId": "685a48a3e31a7d299f7a56e7" } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "participant",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "participant",\ "isOwner": true\ }\ \], "changeOwnerAllowed": true } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Delete user(s) from access list #### Params id \* (path) Object identifier (BSON ObjectId string) { "ids": \[\ "45cbc4a0e4123f6920000001",\ "team\_45cbc4a0e4123f6920000001"\ \] } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "participant",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "participant",\ "isOwner": true\ }\ \], "changeOwnerAllowed": true } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get file insights #### Params id \* (path) Object identifier (BSON ObjectId string) \[\ {\ "action": "file\_create",\ "resourceId": "654e1a281ece4da494ee1a1a",\ "updatedAt": "2020-10-06T10:03:04.421Z",\ "createdAt": "2020-10-06T10:03:04.421Z",\ "attributes": {\ "title": "avatar",\ "hash": "\\"9995294ace8af8e776822fb33399ed26\\""\ },\ "id": "654e1a281ece4da494ee1a1a",\ "actor": {\ "firstName": "John",\ "lastName": "Doe",\ "phone": "empty",\ "ip": "0.0.0.0",\ "userAgent": "UserAgent",\ "id": "685a48a3e31a7d299f7a56e8",\ "avatar": null,\ "latlng": \[\ 41.5898,\ 44.5509\ \],\ "email": "user\_2@mail.com"\ }\ }\ \] #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Request an access for the file #### Params id \* (path) Object identifier (BSON ObjectId string) { "userId": "45cbc4a0e4123f6920000022", "resourceId": "45cbc4a0e4123f6920000001", "id": "2e9bb502c90530cf55e9adc2", "createdAt": "2020-10-06T12:09:01.290Z", "updatedAt": "2020-10-06T12:09:01.290Z" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get list of a access requests #### Params id \* (path) Object identifier (BSON ObjectId string) \[\ {\ "createdAt": "2020-10-06T12:09:01.290Z",\ "id": "45cbc4a0e4123f6920000022",\ "resourceId": "45cbc4a0e4123f6920000001",\ "updatedAt": "2020-10-06T12:09:01.290Z",\ "userId": "685a48a3e31a7d299f7a56e7",\ "userProfile": {\ "avatar": null,\ "email": "user\_1@mail.com",\ "id": "685a48a3e31a7d299f7a56e7",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ }\ \] #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Accept an access request for the file #### Params id \* (path) Object identifier (BSON ObjectId string) accessRequestId \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "participant",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "participant",\ "isOwner": true\ }\ \], "changeOwnerAllowed": true } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Reject an access request for the file #### Params id \* (path) Object identifier (BSON ObjectId string) accessRequestId \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "participant",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "participant",\ "isOwner": true\ }\ \], "changeOwnerAllowed": true } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Report a client event happened with a file #### Params id \* (path) Object identifier (BSON ObjectId string) { "event": "file\_download" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (object\_not\_found) File with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of files (max 30 items in single response) #### Params exclusiveFrom (query) The key of last item returned from previous request, to start from next one orgId (query) The org context in which resource will be created { "files": \[\ {\ "id": "586f8b370ece4cb684821aae",\ "ownerId": "654e1a281ece4da494ee1a1a",\ "bodyRef": "354e1a281ece4da494ee1a1b",\ "sharedWith": \[\ "354e1a281ece4da494ee1a1b",\ "586f8b370ece4cb684821aae"\ \],\ "version": 1,\ "attributes": {\ "title": "My title",\ "fields": \[\ {\ "type": "text",\ "recipient": {\ "id": "554e1a281ece4da494ee1eee",\ "firstName": "Tim",\ "lastName": "Tyler",\ "email": "tim.tyler@example.com",\ "phone": "+123456789012",\ "avatar": "https://example.com/avatar.jpg"\ },\ "page": 0,\ "rect": \[\ 50,\ 50,\ 200,\ 20\ \],\ "fieldName": "First name",\ "value": "",\ "readonly": false,\ "required": false,\ "label": false,\ "comb": false,\ "multiline": false,\ "permittedTypes": \[\ "smartphone",\ "draw",\ "typeIn",\ "upload"\ \],\ "textColor": "#40484F",\ "ratio": 1,\ "maxLength": 256,\ "textAlign": "left",\ "textFormat": "letters",\ "dateFormat": null\ }\ \],\ "signatures": \[\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "signature",\ "states": \[\ {\ "type": "info",\ "text": "Location: Mars"\ },\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com"\ },\ {\ "date": "2016-12-07T09:18:13.000Z",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "timestamp",\ "states": \[\ {\ "type": "valid",\ "info": "The signers identity has been verified"\ }\ \],\ "email": "tim.tyler@example.com",\ "serialNumber": "9223372036854775807"\ }\ \],\ "type": "document"\ },\ "createdAt": "2012-09-07T00:00:00.000Z",\ "updatedAt": "2012-09-07T00:00:00.000Z",\ "public": false\ }\ \], "lastKey": null } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Creates the transaction #### Params orgId (query) The org context in which resource will be created { "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of transactions (max 30 items in single response) #### Params exclusiveFrom (query) The key of last item returned from previous request, to start from next one orgId (query) The org context in which resource will be created bulkId (query) The bulk context in which the transactions were created { "templates": \[\ {\ "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \],\ "status": "draft",\ "createdAt": "2020-10-07T08:24:38.639Z",\ "attributes": {},\ "ownerId": "654e1a281ece4da494ee1a1a",\ "updatedAt": "2020-10-07T08:24:38.639Z",\ "owner": {\ "avatar": "https://example.com/avatar.jpg",\ "email": "owner@mail.com",\ "id": "654e1a281ece4da494ee1a1a",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ },\ "id": "654e1a281ece4da494ee1a1a",\ "name": "avatar",\ "message": {\ "title": null,\ "body": null,\ "attachSignedFiles": false\ },\ "public": false,\ "orgId": "e1cbfb4ea1fab8f29303bce6",\ "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \],\ "options": {\ "requireQualifiedCertificate": false,\ "includeFileAudit": true,\ "requirePasswordProtection": false,\ "requireRecipientLocation": false,\ "requireLocalCertificate": false,\ "requireCertificateContactMatch": false,\ "requireSmartCard": false,\ "allowSignerReassignment": false,\ "allowBulkUsage": false\ },\ "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \],\ "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \]\ }\ \], "lastKey": null } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets transaction object #### Params id \* (path) Object identifier (BSON ObjectId string) { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates the transaction, most updates available only in "draft" transaction status When transaction has another status ony "public" field update is allowed #### Params id \* (path) Object identifier (BSON ObjectId string) { "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Deletes the transaction. Also deletes all corresponding files. #### Params id \* (path) Object identifier (BSON ObjectId string) { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Start the transaction sign flow #### Params id \* (path) Object identifier (BSON ObjectId string) orgId (query) The org context in which resource will be created { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get's upload url for locally signed File #### Params id \* (path) Object identifier (BSON ObjectId string) { "fileId": "354e1a281ece4da494ee1a1b", "byUser": "654e1a281ece4da494ee1a1a" } { "url": "https://someurl.com/some\_signed\_path?signature=45cbc4a0e4123f6920000001" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Sign the transaction's document(s) #### Params id \* (path) Object identifier (BSON ObjectId string) { "fileId": "45cbc4a0e4123f6920000001", "appendedSignatures": \[\ {\ "id": "17R",\ "date": "2019-11-12T10:42:27.048Z",\ "email": "signer\_user@mail.com",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "signature",\ "states": \[\]\ }\ \], "signedFields": \[\ {\ "id": "45cbc4a0e4123f6920000002",\ "value": "My Name"\ },\ {\ "id": "45cbc4a0e4123f6920000003",\ "value": true,\ "pdfFieldId": "17R",\ "hasAppearance": true,\ "rect": \[\ 24.403,\ 84.379,\ 27.664,\ 4.455\ \]\ }\ \] } { "fileId": "45cbc4a0e4123f6920000001", "appendedSignatures": \[\ {\ "id": "17R",\ "date": "2019-11-12T10:42:27.048Z",\ "email": "signer\_user@mail.com",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "signature",\ "states": \[\]\ },\ {\ "id": "19R",\ "date": "2019-11-12T10:42:27.048Z",\ "email": "signer\_user@mail.com",\ "firstName": "John",\ "secondName": "Doe",\ "signatureType": "timestamp",\ "serialNumber": "9223372036854775807",\ "states": \[\]\ }\ \] } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Decline signing the transaction #### Params id \* (path) Object identifier (BSON ObjectId string) { "reason": "Some reason to decline signing" } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Cancel the transaction by owner #### Params id \* (path) Object identifier (BSON ObjectId string) { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get all participants list #### Params id \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Add new user to access list #### Params id \* (path) Object identifier (BSON ObjectId string) { "email": "user\_2@mail.com", "firstName": "John", "lastName": "Doe" } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Changes owner of the transaction #### Params id \* (path) Object identifier (BSON ObjectId string) { "userId": "45cbc4a0e4123f6920000001" } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Delete user(s) from access list #### Params id \* (path) Object identifier (BSON ObjectId string) { "ids": \[\ "45cbc4a0e4123f6920000001",\ "team\_45cbc4a0e4123f6920000001"\ \] } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get transaction insights #### Params id \* (path) Object identifier (BSON ObjectId string) \[\ {\ "action": "transaction\_start",\ "resourceId": "654e1a281ece4da494ee1a1a",\ "updatedAt": "2020-10-06T10:03:04.421Z",\ "createdAt": "2020-10-06T10:03:04.421Z",\ "attributes": {\ "title": "avatar",\ "hash": "\\"9995294ace8af8e776822fb33399ed26\\""\ },\ "id": "654e1a281ece4da494ee1a1a",\ "actor": {\ "firstName": "John",\ "lastName": "Doe",\ "phone": "empty",\ "ip": "0.0.0.0",\ "userAgent": "UserAgent",\ "id": "685a48a3e31a7d299f7a56e8",\ "avatar": null,\ "latlng": \[\ 41.5898,\ 44.5509\ \],\ "email": "user\_2@mail.com"\ }\ }\ \] #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Request an access for the transaction #### Params id \* (path) Object identifier (BSON ObjectId string) { "createdAt": "2020-10-07T08:24:38.639Z", "updatedAt": "2020-10-07T08:24:38.639Z", "id": "354e1a281ece4da494ee1a1b", "resourceId": "354e1a281ece4da494ee1a1b", "userId": "654e1a281ece4da494ee1a1a" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get list of a access requests #### Params id \* (path) Object identifier (BSON ObjectId string) { "userProfile": { "id": "685a48a3e31a7d299f7a56e8", "firstName": "John", "lastName": "Doe", "phone": null, "email": "user\_2@mail.com", "avatar": null }, "createdAt": "2020-10-07T08:24:38.639Z", "updatedAt": "2020-10-07T08:24:38.639Z", "id": "354e1a281ece4da494ee1a1b", "resourceId": "354e1a281ece4da494ee1a1b", "userId": "654e1a281ece4da494ee1a1a" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Accept an access request for the transaction #### Params id \* (path) Object identifier (BSON ObjectId string) accessRequestId \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Reject an access request for the transaction #### Params id \* (path) Object identifier (BSON ObjectId string) accessRequestId \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Remind about transaction for the current signer #### Params id \* (path) Object identifier (BSON ObjectId string) { "userId": "685a48a3e31a7d299f7a56e8", "title": "Some remind title", "message": "Some remind message" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Reassign transaction to another user #### Params id \* (path) Object identifier (BSON ObjectId string) { "fromUserId": "654e1a281ece4da494ee1a1a", "reason": "Some reason to reassign", "toUser": { "firstName": "John", "lastName": "Doe", "email": "user\_1@mail.com" } } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Request audit appending into transaction #### Params id \* (path) Object identifier (BSON ObjectId string) { "jobId": "554e1a281ece4da494ee1eee" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Creates the template #### Params orgId (query) The org context in which resource will be created { "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of templates (max 30 items in single response) #### Params exclusiveFrom (query) The key of last item returned from previous request, to start from next one orgId (query) The org context in which resource will be created { "templates": \[\ {\ "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \],\ "createdAt": "2020-10-07T08:24:38.639Z",\ "attributes": {},\ "ownerId": "654e1a281ece4da494ee1a1a",\ "updatedAt": "2020-10-07T08:24:38.639Z",\ "owner": {\ "avatar": "https://example.com/avatar.jpg",\ "email": "owner@mail.com",\ "id": "654e1a281ece4da494ee1a1a",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ },\ "id": "654e1a281ece4da494ee1a1a",\ "name": "avatar",\ "message": {\ "title": null,\ "body": null,\ "attachSignedFiles": false\ },\ "public": false,\ "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \],\ "options": {\ "requireQualifiedCertificate": false,\ "includeFileAudit": true,\ "requirePasswordProtection": false,\ "requireRecipientLocation": false,\ "requireLocalCertificate": false,\ "requireCertificateContactMatch": false,\ "requireSmartCard": false,\ "allowBulkUsage": false\ },\ "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \],\ "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \]\ }\ \], "lastKey": null } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets template object #### Params id \* (path) Object identifier (BSON ObjectId string) { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Updates the template #### Params id \* (path) Object identifier (BSON ObjectId string) { "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Deletes the template. Also deletes corresponding files. #### Params id \* (path) Object identifier (BSON ObjectId string) orgId (query) The org context in which resource will be created { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get all participants list #### Params id \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Add new user to access list #### Params id \* (path) Object identifier (BSON ObjectId string) { "email": "user\_2@mail.com", "firstName": "John", "lastName": "Doe" } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Changes owner of the template #### Params id \* (path) Object identifier (BSON ObjectId string) { "userId": "45cbc4a0e4123f6920000001" } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Delete user(s) from access list #### Params id \* (path) Object identifier (BSON ObjectId string) { "ids": \[\ "45cbc4a0e4123f6920000001",\ "team\_45cbc4a0e4123f6920000001"\ \] } { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get template insights #### Params id \* (path) Object identifier (BSON ObjectId string) \[\ {\ "action": "template\_view",\ "resourceId": "654e1a281ece4da494ee1a1a",\ "updatedAt": "2020-10-06T10:03:04.421Z",\ "createdAt": "2020-10-06T10:03:04.421Z",\ "attributes": {\ "title": "avatar",\ "hash": "\\"9995294ace8af8e776822fb33399ed26\\""\ },\ "id": "654e1a281ece4da494ee1a1a",\ "actor": {\ "firstName": "John",\ "lastName": "Doe",\ "phone": "empty",\ "ip": "0.0.0.0",\ "userAgent": "UserAgent",\ "id": "685a48a3e31a7d299f7a56e8",\ "avatar": null,\ "latlng": \[\ 41.5898,\ 44.5509\ \],\ "email": "user\_2@mail.com"\ }\ }\ \] #### Errors 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Request an access for the template #### Params id \* (path) Object identifier (BSON ObjectId string) { "createdAt": "2020-10-07T08:24:38.639Z", "updatedAt": "2020-10-07T08:24:38.639Z", "id": "354e1a281ece4da494ee1a1b", "resourceId": "354e1a281ece4da494ee1a1b", "userId": "654e1a281ece4da494ee1a1a" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Get list of a access requests #### Params id \* (path) Object identifier (BSON ObjectId string) { "userProfile": { "id": "685a48a3e31a7d299f7a56e8", "firstName": "John", "lastName": "Doe", "phone": null, "email": "user\_2@mail.com", "avatar": null }, "createdAt": "2020-10-07T08:24:38.639Z", "updatedAt": "2020-10-07T08:24:38.639Z", "id": "354e1a281ece4da494ee1a1b", "resourceId": "354e1a281ece4da494ee1a1b", "userId": "654e1a281ece4da494ee1a1a" } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Accept an access request for the template #### Params id \* (path) Object identifier (BSON ObjectId string) accessRequestId \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Reject an access request for the template #### Params id \* (path) Object identifier (BSON ObjectId string) accessRequestId \* (path) Object identifier (BSON ObjectId string) { "public": true, "participants": \[\ {\ "id": "45cbc4a0e4123f6920000001",\ "email": "user\_1@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": null,\ "avatar": null,\ "role": "cc",\ "isOwner": false\ },\ {\ "id": "45cbc4a0e4123f6920000022",\ "email": "user\_2@mail.com",\ "phone": "+555555555555",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "role": "recipient",\ "isOwner": true\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Creates a transaction from template data #### Params id \* (path) Object identifier (BSON ObjectId string) orgId (query) The org context in which resource will be created { "transactionDetails": { "name": "The sample form" }, "templateRolesData": { "manager": { "id": "45cbc4a0e4123f6920000001", "email": "user\_1@mail.com", "firstName": "John" }, "client": { "phone": "+555555555555", "firstName": "John" } } } { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Creates a transaction from library template. Templates must meet certain requirements to be able to create transaction from them using this endpoint: template must be public, all recipients must have roles and at least one recipient must have the \`Signer\` (case insensitive) role if there is more then one recipient #### Params id \* (path) Object identifier (BSON ObjectId string) { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Template with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Creates a template from transaction data #### Params id \* (path) Object identifier (BSON ObjectId string) orgId (query) The org context in which resource will be created { "sharedWith": \[\ "654e1a281ece4da494ee1a1a",\ "e405add50afc68cfc06f79de"\ \], "status": "draft", "createdAt": "2020-10-07T08:24:38.639Z", "attributes": {}, "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" }, "id": "654e1a281ece4da494ee1a1a", "name": "avatar", "message": { "title": null, "body": null, "attachSignedFiles": false }, "public": false, "orgId": "e1cbfb4ea1fab8f29303bce6", "fileIds": \[\ "354e1a281ece4da494ee1a1b"\ \], "options": { "requireQualifiedCertificate": false, "includeFileAudit": true, "requirePasswordProtection": false, "requireRecipientLocation": false, "requireLocalCertificate": false, "requireCertificateContactMatch": false, "requireSmartCard": false, "allowSignerReassignment": false, "allowBulkUsage": false }, "cc": \[\ {\ "email": "user\_2@mail.com",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png"\ }\ \], "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe",\ "avatar": "https://domain.com/my\_avatar.png",\ "identityRequireManualApproval": false,\ "inPerson": false,\ "requireMobileDriverLicenseVerification": false,\ "identityRequirements": \[\],\ "type": "signer"\ }\ \] } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Transaction with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Send the bulk #### Params orgId (query) The org context in which resource will be created { "name": "avatar", "templateId": "354e1a281ece4da494ee1a1b", "recipients": \[\ {\ "email": "user\_1@mail.com",\ "firstName": "John",\ "lastName": "Doe"\ }\ \] } { "name": "avatar", "templateId": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "654e1a281ece4da494ee1a1a"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets the list of bulks (max 30 items in single response) #### Params exclusiveFrom (query) The key of last item returned from previous request, to start from next one orgId (query) The org context in which resource will be created { "bulks": \[\ {\ "name": "avatar",\ "templateId": "354e1a281ece4da494ee1a1b",\ "sharedWith": \[\ "654e1a281ece4da494ee1a1a"\ \],\ "createdAt": "2020-10-07T08:24:38.639Z",\ "ownerId": "654e1a281ece4da494ee1a1a",\ "updatedAt": "2020-10-07T08:24:38.639Z",\ "owner": {\ "avatar": "https://example.com/avatar.jpg",\ "email": "owner@mail.com",\ "id": "654e1a281ece4da494ee1a1a",\ "phone": "empty",\ "firstName": "John",\ "lastName": "Doe"\ }\ }\ \], "lastKey": null } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 404 (not\_found) Bulk with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Gets bulk object #### Params id \* (path) Object identifier (BSON ObjectId string) orgId (query) The org context in which resource will be created { "name": "avatar", "templateId": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "654e1a281ece4da494ee1a1a"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Bulk with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Delete bulk object #### Params id \* (path) Object identifier (BSON ObjectId string) { "name": "avatar", "templateId": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "654e1a281ece4da494ee1a1a"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Bulk with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Update bulk object #### Params id \* (path) Object identifier (BSON ObjectId string) { "name": "avatar" } { "name": "avatar", "templateId": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "654e1a281ece4da494ee1a1a"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Bulk with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request #### Request description Cancel bulk #### Params id \* (path) Object identifier (BSON ObjectId string) { "name": "avatar", "templateId": "354e1a281ece4da494ee1a1b", "sharedWith": \[\ "654e1a281ece4da494ee1a1a"\ \], "createdAt": "2020-10-07T08:24:38.639Z", "ownerId": "654e1a281ece4da494ee1a1a", "updatedAt": "2020-10-07T08:24:38.639Z", "owner": { "avatar": "https://example.com/avatar.jpg", "email": "owner@mail.com", "id": "654e1a281ece4da494ee1a1a", "phone": "empty", "firstName": "John", "lastName": "Doe" } } #### Errors 400 (request\_validation\_error) Invalid input data: \\n\\t .body: should NOT have fewer than 1 properties \\n 401 (unauthorized) Authorization failed. 403 (permission\_denied) You have no read access to specified resource 404 (not\_found) Bulk with id 554e1a281ece4da494ee1eee not found. 429 (rate\_limit\_exceeded) You have reached a rate limit. You may retry in a few minutes. 500 (internal\_error) There was an error processing your request ---