{"info":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","description":"

Databunker is a super-fast, open-source vault built with Go for secure storage of sensitive personal records.

Additional information

For more details, please check out the project website:
https://databunker.org/

API Information

When performing PUSH or PUT requests using Databunker API, the following content types supported:

application/json
\n
application/x-www-form-urlencoded
\n

NOTE: Keep the user {token} generated by Databunker private, as it serves as an additional user identifier.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11310294","collectionId":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","publishedId":"Szmcbz32","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-06-03T14:17:26.000Z"},"item":[{"name":"User API","item":[{"name":"Get user by email","id":"f29ccbcb-b36b-4fd9-9a6a-afce1062fc17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/user/email/:email","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","user","email",":email"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

account email address

\n","type":"text/plain"},"type":"string","value":"test@securitybunker.io","key":"email"}]}},"response":[{"id":"ead0756d-f26f-4b1d-9077-7c5fc0b7f9a0","name":"Get user by email","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.databunker.org/v1/user/email/:email","protocol":"https","host":["demo.databunker.org"],"path":["v1","user","email",":email"],"variable":[{"key":"email","value":"test@securitybunker.io","type":"string","description":"account email address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Jun 2021 13:22:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"197"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"9af960d2-a62d-d924-2c96-a0271c735837\",\n \"data\": {\n \"email\": \"test@securitybunker.io\",\n \"fname\": \"Test\",\n \"lname\": \"Account\",\n \"passportid\": \"123456789\",\n \"phone\": \"4444\",\n \"status\": \"prospect\"\n }\n}"}],"_postman_id":"f29ccbcb-b36b-4fd9-9a6a-afce1062fc17"},{"name":"Get user by phone","id":"d2cbc129-61a1-49f5-a6e7-a025474604e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/user/phone/:phone","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","user","phone",":phone"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Phone number

\n","type":"text/plain"},"type":"string","value":"4444","key":"phone"}]}},"response":[{"id":"bf1a905f-c851-42e6-9989-6d8e39b5f9ca","name":"Get user by phone","originalRequest":{"method":"GET","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/user/phone/:phone","protocol":"https","host":["demo.databunker.org"],"path":["v1","user","phone",":phone"],"variable":[{"key":"phone","value":"4444","type":"string","description":"Phone number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 17:03:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"195"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"84ba242e-05de-9d5c-04e7-7c07fd33b458\",\n \"data\": {\n \"email\": \"test@paranoidguy.com\",\n \"fname\": \"Alex\",\n \"lname\": \"Account\",\n \"passportid\": \"123456789\",\n \"phone\": \"4444\",\n \"status\": \"prospect\"\n }\n}"}],"_postman_id":"d2cbc129-61a1-49f5-a6e7-a025474604e4"},{"name":"Get user by login","id":"10364b7a-7282-42a4-a545-3976df72946b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/user/login/:login","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","user","login",":login"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

\n","type":"text/plain"},"type":"string","value":"john","key":"login"}]}},"response":[{"id":"99f6ae24-9312-4d33-a5eb-7a9ec0f80ead","name":"Get user by login","originalRequest":{"method":"GET","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/user/login/:login","protocol":"https","host":["demo.databunker.org"],"path":["v1","user","login",":login"],"variable":[{"key":"login","value":"john","description":"login name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 May 2020 21:12:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"178"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\",\n \"data\": {\n \"email\": \"demo123@testemail.com\",\n \"firstname\": \"John\",\n \"lastname\": \"Doe\",\n \"login\": \"john\",\n \"status\": \"new-customer\"\n }\n}"}],"_postman_id":"10364b7a-7282-42a4-a545-3976df72946b"},{"name":"Get user by token","id":"60c9bbb4-4b7b-4958-a6e0-89af468213d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/user/token/:token","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","user","token",":token"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

User token value

\n","type":"text/plain"},"type":"string","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","key":"token"}]}},"response":[{"id":"674b0ca5-be0d-49d1-af4d-d48dd6c8889e","name":"Get user by token","originalRequest":{"method":"GET","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/user/token/:token","protocol":"https","host":["demo.databunker.org"],"path":["v1","user","token",":token"],"variable":[{"key":"token","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","description":"user token value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 May 2020 21:13:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"178"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\",\n \"data\": {\n \"email\": \"demo123@testemail.com\",\n \"firstname\": \"John\",\n \"lastname\": \"Doe\",\n \"login\": \"john\",\n \"status\": \"new-customer\"\n }\n}"}],"_postman_id":"60c9bbb4-4b7b-4958-a6e0-89af468213d8"},{"name":"Create user","id":"3124d6e9-8749-459e-94e7-ae36b6e20b9e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"firstname\": \"John\",\n\t\"lastname\": \"Doe\",\n\t\"email\": \"demo123@testemail.com\",\n\t\"login\": \"john\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/user","description":"

Explanation

This API is used to create a new user record.

If successful, it returns a new user {token}.
\n
Each user record is encrypted at the database level with its own unique key.
\n

POST Body Format

You can submit data in regular form or JSON format. The following values are extracted from the POST data or JSON root level to create a secure index:

login
\n
phone
\n
email
\n
custom
\n

These values must be unique if set but can be null if not needed.

Important Notes

If {login}, {phone}, {email}, or {custom} is provided, it must be unique.
\n
If these values are not required, they can be set to null.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","user"],"host":["demo.databunker.org"],"query":[],"variable":[]}},"response":[{"id":"2ca2fd7e-a711-4d08-b2c6-8c9c99559cd7","name":"Create user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"firstname\":\"John\",\n\t\"lastname\":\"Doe\",\n\t\"email\":\"demo123@testemail.com\",\n\t\"login\":\"john\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 May 2020 21:00:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\"\n}"},{"id":"705073c4-c7bf-41aa-bc88-1f6a048d6c80","name":"Duplicate error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"firstname\":\"John\",\n\t\"lastname\":\"Doe\",\n\t\"email\":\"demo123@testemail.com\",\n\t\"login\":\"john\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/user"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 03 Jun 2020 14:26:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"53"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"duplicate index: login\"\n}"}],"_postman_id":"3124d6e9-8749-459e-94e7-ae36b6e20b9e"},{"name":"Update user","id":"93838a6c-ccec-4c74-9def-6d0f6b4c66c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\t\"status\": \"new-customer\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/user/:method/:identity","description":"

Explanation

This API is used to update the user record. The user record is identified by {token},{email}, {phone}, {login} or {custom} value.

On success, this API call returns success status or an error message on error.

POST Body Format

POST body can contain a url encoded string like key1=value1&key2=value2 or a JSON string.

By default ULR encoded string is converted to a JSON object.

JSON string can start with a {. In this can this JSON is treated as an update set to the existing user object stored in Databunker. This is also known as the JSON merge patch. A detailed explanation can be found in the following RFC:
https://datatracker.ietf.org/doc/html/rfc7396

For example, when a Databunker gets the following JSON POST {\"key1\":\"new-value\",\"key2\":null}. It will be processed as follows:

A user object will be loaded and decrypted from DB.
\n
key1 will be set in the user object.
\n
key2 will be removed from the user object.
\n
An updated user object is encrypted and saved in a DB and an audit event is generated.
\n

Databunker also supports a JSON patch request. For that, JSON POST request must start with a JSON array char [.

More details can be found in the following RFC:
https://datatracker.ietf.org/doc/html/rfc6902

For example, this method allows updating, removing, or adding specific values to JSON array objects stored inside user objects.

POST example:

[\n     { \"op\": \"test\", \"path\": \"/a/b/c\", \"value\": \"foo\" },\n     { \"op\": \"remove\", \"path\": \"/a/b/c\" },\n     { \"op\": \"add\", \"path\": \"/a/b/c\", \"value\": [ \"foo\", \"bar\" ] },\n     { \"op\": \"replace\", \"path\": \"/a/b/c\", \"value\": 42 },\n     { \"op\": \"move\", \"from\": \"/a/b/c\", \"path\": \"/a/b/d\" },\n     { \"op\": \"copy\", \"from\": \"/a/b/d\", \"path\": \"/a/b/e\" }\n]\n\n

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","user",":method",":identity"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Possible values: token,login,email,phone,custom

\n","type":"text/plain"},"type":"string","value":"login","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"john","key":"identity"}]}},"response":[{"id":"296499bf-4fff-486b-986d-e71e1b9d2ec3","name":"Update user","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"new-customer\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/user/:method/:address","protocol":"https","host":["demo","databunker","org"],"path":["v1","user",":method",":address"],"variable":[{"key":"method","value":"login","description":"Possible values: token, login, email, phone, custom"},{"key":"address","value":"john","description":"Value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 May 2020 21:12:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\"\n}"}],"_postman_id":"93838a6c-ccec-4c74-9def-6d0f6b4c66c3"},{"name":"Delete user","id":"9aaf4307-342b-4667-bcff-ed5442e1ea8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://demo.databunker.org/v1/user/:method/:identity","description":"

Explanation

This command will remove all user records from the database, leaving the only user {token} for reference.

Note: Depending on the configuration, this command can generate a request to delete the user record instead of actually deleting a user.

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"login","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"john","key":"identity"}]}},"response":[],"_postman_id":"9aaf4307-342b-4667-bcff-ed5442e1ea8a"}],"id":"dac54302-37fb-4429-801b-b93f1ab576a3","description":"

User API is used to store, change, and retrieve user personal records saved in Databunker.

\n","event":[{"listen":"prerequest","script":{"id":"5ab8a351-babb-48e5-a3fb-0ef4c5c3dd74","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"69033cc5-5943-4783-863b-e5bc816f6ff2","type":"text/javascript","exec":[""]}}],"_postman_id":"dac54302-37fb-4429-801b-b93f1ab576a3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}},{"name":"User App API","item":[{"name":"Create user app record","id":"11e45c04-476c-40b0-8e22-6d95f0cac809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"address\": \"Red square 1\",\n\t\"city\": \"Moscow\",\n\t\"country\": \"Russia\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","description":"

Explanation

This API request creates a new user app record.

If the request is successful, it returns {\"status\": \"ok\"}
\n
Calling this API multiple times for the same user app will overwrite the existing record.
\n

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"token","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","key":"identity"},{"description":{"content":"

Application name. Valid chars: [1-z][_a-z0-9]+

\n","type":"text/plain"},"type":"string","value":"shipping","key":"appname"}]}},"response":[{"id":"9cbb73b2-7508-44d6-85d2-312f91fe96b6","name":"Create user app record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"address\": \"Red square 1\",\n\t\"city\": \"Moscow\",\n\t\"country\": \"Russia\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","protocol":"https","host":["demo","databunker","org"],"path":["v1","userapp",":method",":identity",":appname"],"variable":[{"key":"method","value":"token","description":"Possible values: token, login, email, phone, custom"},{"key":"identity","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","description":"User identity value"},{"key":"appname","value":"shipping","description":"Application name. Valid chars: [1-z][\\_a-z0-9]+"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 May 2020 21:59:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\"\n}"}],"_postman_id":"11e45c04-476c-40b0-8e22-6d95f0cac809"},{"name":"Get user app record","id":"c86c3198-dbf4-43cc-96ed-283207e7461b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","description":"

Explanation

This API returns the user app record in JSON format.

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"token","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","key":"identity"},{"description":{"content":"

User app name

\n","type":"text/plain"},"type":"string","value":"shipping","key":"appname"}]}},"response":[{"id":"d20fb612-f95e-47d5-be4e-5c2d48ee7f34","name":"Get user app record","originalRequest":{"method":"GET","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","protocol":"https","host":["demo","databunker","org"],"path":["v1","userapp",":method",":identity",":appname"],"variable":[{"key":"method","value":"token","description":"Possible values: token, login, email, phone, custom"},{"key":"identity","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","description":"User identity value"},{"key":"appname","value":"shipping","description":"User app name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 May 2020 21:46:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"131"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\",\n \"data\": {\n \"address\": \"Red square 1\",\n \"city\": \"Moscow\",\n \"country\": \"Russia\"\n }\n}"}],"_postman_id":"c86c3198-dbf4-43cc-96ed-283207e7461b"},{"name":"Update user app record","id":"cd3ab2f5-8b7b-4827-94e5-36077f092b82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n\t\"pob\": 123\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","description":"

Explanation

This API updates the user app record with new values.

The updated record will replace the existing one.

POST Body Format

POST body can contain a url encoded string like key1=value1&key2=value2 or a JSON string.

By default ULR encoded string is converted to a JSON object.

JSON string can start with a {. In this can this JSON is treated as an update set to the existing object stored in Databunker. This is also known as the JSON merge patch. A detailed explanation can be found in the following RFC:
https://datatracker.ietf.org/doc/html/rfc7396

For example, when a Databunker gets the following JSON POST {\"key1\":\"new-value\",\"key2\":null}. It will be processed as follows:

An object will be loaded and decrypted from DB.
\n
key1 will be set in the object.
\n
key2 will be removed from the object.
\n
An updated object is encrypted and saved in a DB and an audit event is generated.
\n

Databunker also supports a JSON patch request. For that, JSON POST request must start with a JSON array char [.

More details can be found in the following RFC:
https://datatracker.ietf.org/doc/html/rfc6902

For example, this method allows updating, removing, or adding specific values to JSON array objects stored inside user app records.

POST example:

[\n     { \"op\": \"test\", \"path\": \"/a/b/c\", \"value\": \"foo\" },\n     { \"op\": \"remove\", \"path\": \"/a/b/c\" },\n     { \"op\": \"add\", \"path\": \"/a/b/c\", \"value\": [ \"foo\", \"bar\" ] },\n     { \"op\": \"replace\", \"path\": \"/a/b/c\", \"value\": 42 },\n     { \"op\": \"move\", \"from\": \"/a/b/c\", \"path\": \"/a/b/d\" },\n     { \"op\": \"copy\", \"from\": \"/a/b/d\", \"path\": \"/a/b/e\" }\n]\n\n

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","userapp",":method",":identity",":appname"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"token","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","key":"identity"},{"description":{"content":"

User app name

\n","type":"text/plain"},"type":"string","value":"shipping","key":"appname"}]}},"response":[{"id":"e80b6813-eedd-45f4-80bc-0a3ae98a1804","name":"Update user app record","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"pob\": 123\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","protocol":"https","host":["demo","databunker","org"],"path":["v1","userapp",":method",":identity",":appname"],"variable":[{"key":"method","value":"token","description":"Possible values: token, login, email, phone, custom"},{"key":"identity","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","description":"User identity value"},{"key":"appname","value":"shipping","description":"User app name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 06 May 2020 21:59:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\"\n}"}],"_postman_id":"cd3ab2f5-8b7b-4827-94e5-36077f092b82"},{"name":"Delete user app record","id":"1c4608e7-99ca-41ee-94b4-f8beed4cf427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","description":"

Explanation

Delete user app records.

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"token","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","key":"identity"},{"description":{"content":"

User app name

\n","type":"text/plain"},"type":"string","value":"shipping","key":"appname"}]}},"response":[{"id":"42722b55-d16d-4528-894d-5eb741f246e0","name":"Delete user app record","originalRequest":{"method":"DELETE","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/userapp/:method/:identity/:appname","protocol":"https","host":["demo.databunker.org"],"path":["v1","userapp",":method",":identity",":appname"],"variable":[{"description":"Only token is supported now","key":"method","value":"token"},{"description":"User identity value","key":"identity","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8"},{"description":"User app name","key":"appname","value":"shipping"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 08 May 2020 09:40:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"token\": \"8c8b92b0-58c6-36db-634d-f0b0c798efd8\"\n}"}],"_postman_id":"1c4608e7-99ca-41ee-94b4-f8beed4cf427"}],"id":"f542c4cc-a690-4b52-b56d-a0c78940cdf7","description":"

The User App API allows you to store additional user-related information separately from profile data. This can include shipping details, payment information, and other app-specific data while maintaining a clear distinction from core user profiles.

\n","event":[{"listen":"prerequest","script":{"id":"3821eb03-00fd-4528-9cf2-3ea95372c3ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bc4d897a-b71c-4177-9d5b-e300e58ce6ca","type":"text/javascript","exec":[""]}}],"_postman_id":"f542c4cc-a690-4b52-b56d-a0c78940cdf7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}},{"name":"User Session API","item":[{"name":"Create session","id":"8146d8d5-7042-4f58-b1c9-f007db1e546f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"clientip\": \"127.0.0.1\",\n\"expiration\": \"3h\",\n\"useragent\": \"Mozilla/5.0\",\n\"phone\": \"4444\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/session/:session","description":"

Explanation

This API creates a new user session and returns a {session} token.

Any data you include in the request will be stored in the session object.

How It Works

Databunker automatically links the session to a user based on these parameters:

login: User login identifier
\n
email: User email address
\n
phone: User phone number
\n
token: User UUID token
\n

You can also set an expiration time (TTL) for the session.

session token

\n","type":"text/plain"},"type":"any","value":"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c","key":"session"}]}},"response":[{"id":"d84c320a-9417-4b27-86ae-361ca2446176","name":"Create session","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"clientip\": \"127.0.0.1\",\n\t\"expiration\": \"3h\",\n\t\"useragent\": \"Mozilla/5.0\",\n \"phone\": \"4444\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/session/:session","protocol":"https","host":["demo.databunker.org"],"path":["v1","session",":session"],"variable":[{"key":"session","value":"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c","description":"session token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 13:00:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"64"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"session\": \"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c\"\n}"}],"_postman_id":"8146d8d5-7042-4f58-b1c9-f007db1e546f"},{"name":"Get session data","id":"0a462fab-c945-4c8e-b66f-5dc21243661c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/session/:session","description":"

Explanation

This API request returns session record.

session token

\n","type":"text/plain"},"type":"string","value":"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c","key":"session"}]}},"response":[{"id":"04b642b4-7a5b-42e0-83f8-e7d2a7f70461","name":"Get session data","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.databunker.org/v1/session/:session","protocol":"https","host":["demo.databunker.org"],"path":["v1","session",":session"],"variable":[{"key":"session","value":"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c","type":"string","description":"session token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 16:23:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"173"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"session\": \"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c\",\n \"when\": 1623601424,\n \"data\": {\n \"clientip\": \"127.0.0.1\",\n \"expiration\": \"3h\",\n \"phone\": \"4444\",\n \"useragent\": \"Mozilla/5.0\"\n }\n}"}],"_postman_id":"0a462fab-c945-4c8e-b66f-5dc21243661c"},{"name":"Get all active sessions","id":"759bc8c8-a3d9-4c3c-b4da-c020f5cc0b1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/sessions/:method/:identity","description":"

Explanation

This API returns an array of all active session for the specific user.

This command supports pagination arguments offset and limit (in URL request).

Possible values: token,login,email,phone,custom

\n","type":"text/plain"},"type":"string","value":"phone","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"4444","key":"identity"}]}},"response":[{"id":"7daa8d84-05ab-4a2e-a06e-8a16aca1e75a","name":"Get user all active sessions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.databunker.org/v1/sessions/:method/:identity","protocol":"https","host":["demo.databunker.org"],"path":["v1","sessions",":method",":identity"],"variable":[{"key":"method","value":"phone","type":"string","description":"Possible values: token,login,email,phone,custom"},{"key":"identity","value":"4444","type":"string","description":"User identity value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 13:01:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"351"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"total\": 2,\n \"rows\": [\n {\n \"when\": 1623589203,\n \"session\": \"84493d20-2ea5-11eb-86f0-2e04ce962524\",\n \"data\": {\n \"clientip\": \"1.1.1.1\",\n \"info\": \"email\",\n \"phone\": \"4444\",\n \"x-forwarded-for\": \"2.2.2.2\"\n }\n },\n {\n \"when\": 1623589246,\n \"session\": \"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c\",\n \"data\": {\n \"clientip\": \"127.0.0.1\",\n \"expiration\": \"3h\",\n \"phone\": \"4444\",\n \"useragent\": \"Mozilla/5.0\"\n }\n }\n ]\n}"}],"_postman_id":"759bc8c8-a3d9-4c3c-b4da-c020f5cc0b1c"},{"name":"Delete session","id":"96af3a52-e457-42bf-8ca2-1cb3bc77e952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://demo.databunker.org/v1/session/:session","description":"

Explanation

This API request deletes a session object.

session token

\n","type":"text/plain"},"type":"any","value":"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c","key":"session"}]}},"response":[{"id":"41f75ad8-6578-43d1-aa18-d352f08de5d1","name":"Delete session","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://demo.databunker.org/v1/session/:session","protocol":"https","host":["demo.databunker.org"],"path":["v1","session",":session"],"variable":[{"key":"session","value":"e586c6ba-4f6d-83b1-b3b1-eeae9a30fe3c","description":"session token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 12:59:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"96af3a52-e457-42bf-8ca2-1cb3bc77e952"}],"id":"c8d4230d-7706-47e1-98fb-90ff4bd1635c","description":"

The User Session API provides a secure way to store and manage user session data for web and mobile applications. Instead of storing sensitive details like user IP addresses or user email in plaintext within your session object, you can use our API to handle session data securely.

Rather than logging user details such as email, phone number, or IP address in your application logs, you can log the session token ID generated by Databunker. This ensures that personally identifiable information (PII) remains protected while still allowing session tracking.

The API allows you to store various session-related data, including user IP, device details, and user agent. Each session record has an expiration time and is automatically deleted upon expiry.

\n","event":[{"listen":"prerequest","script":{"id":"b466ccd6-abeb-46a8-b1fd-8a9e1326c798","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"68b8217c-f890-490c-9fa6-d3dfac66b939","type":"text/javascript","exec":[""]}}],"_postman_id":"c8d4230d-7706-47e1-98fb-90ff4bd1635c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}},{"name":"User Expiration API","item":[{"name":"Init user expiration","id":"50070d43-c6e2-4477-b0d6-c14a0677ef80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"expiration\": \"1m\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/exp/start/:method/:identity","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","exp","start",":method",":identity"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"any","value":"phone","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"any","value":"4444","key":"identity"}]}},"response":[{"id":"15fc798c-ad44-418c-9652-58076a902654","name":"Init user expiration","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"expiration\": \"1m\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/exp/start/:method/:identity","protocol":"https","host":["demo","databunker","org"],"path":["v1","exp","start",":method",":identity"],"variable":[{"key":"method","value":"phone","description":"Possible values: token, login, email, phone, custom"},{"key":"identity","value":"4444","description":"User identity value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 21:11:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"exptoken\": \"9c05ac88-baa3-5d56-c959-23400352dc77\"\n}"}],"_postman_id":"50070d43-c6e2-4477-b0d6-c14a0677ef80"},{"name":"Delete user data","id":"09f87f0c-0929-4e17-9820-9d9f2eb1bf37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/exp/delete/:exptoken","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","exp","delete",":exptoken"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

User expiration identity

\n","type":"text/plain"},"type":"any","value":"b2ccbdfb-e1e2-c099-580c-7cca62dffb97","key":"exptoken"}]}},"response":[{"id":"14d99810-3661-4da5-b951-3f74952b8279","name":"Delete user data","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.databunker.org/v1/exp/delete/:exptoken","protocol":"https","host":["demo.databunker.org"],"path":["v1","exp","delete",":exptoken"],"variable":[{"key":"exptoken","value":"b2ccbdfb-e1e2-c099-580c-7cca62dffb97","description":"User expiration identity"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 21:13:28 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"09f87f0c-0929-4e17-9820-9d9f2eb1bf37"},{"name":"Retain user data","id":"78c6ad62-2900-4cb6-b1ce-d3a97b9920b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/exp/retain/:exptoken","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","exp","retain",":exptoken"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

User expiration identity

\n","type":"text/plain"},"type":"any","value":"9c05ac88-baa3-5d56-c959-23400352dc77","key":"exptoken"}]}},"response":[{"id":"2e6d8ad1-c532-4c06-b408-ed2a3a22f1a8","name":"Retain user data","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.databunker.org/v1/exp/retain/:exptoken","protocol":"https","host":["demo.databunker.org"],"path":["v1","exp","retain",":exptoken"],"variable":[{"key":"exptoken","value":"9c05ac88-baa3-5d56-c959-23400352dc77","description":"User expiration identity"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 21:12:43 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"78c6ad62-2900-4cb6-b1ce-d3a97b9920b3"},{"name":"Get expiration status","id":"21ce99d4-7a42-4c67-88dd-14bda751cee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/exp/status/:method/:identity","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","exp","status",":method",":identity"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"any","value":"phone","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"any","value":"4444","key":"identity"}]}},"response":[{"id":"c130140e-f51d-4a02-b3c8-64da60fae0d4","name":"Get expiration status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.databunker.org/v1/exp/status/:method/:identity","protocol":"https","host":["demo","databunker","org"],"path":["v1","exp","status",":method",":identity"],"variable":[{"key":"method","value":"phone","description":"Possible values: token, login, email, phone, custom"},{"key":"identity","value":"4444","description":"User identity value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 21:16:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"exptime\": 1626297377,\n \"expstatus\": \"wait\",\n \"exptoken\": \"213a0375-374d-9572-2477-342d66f42990\"\n}"}],"_postman_id":"21ce99d4-7a42-4c67-88dd-14bda751cee3"},{"name":"Cancel record expiration","id":"edfd35c8-8887-4df8-9908-59db1280d54d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://demo.databunker.org/v1/exp/cancel/:method/:identity","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","exp","cancel",":method",":identity"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"any","value":"phone","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"any","value":"4444","key":"identity"}]}},"response":[{"id":"795c96e7-5f74-40be-83db-f295be2a79ea","name":"Cancel record expiration","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://demo.databunker.org/v1/exp/cancel/:method/:identity","protocol":"https","host":["demo","databunker","org"],"path":["v1","exp","cancel",":method",":identity"],"variable":[{"key":"method","value":"phone","description":"Possible values: token, login, email, phone, custom"},{"key":"identity","value":"4444","description":"User identity value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Sun, 13 Jun 2021 16:38:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"edfd35c8-8887-4df8-9908-59db1280d54d"}],"id":"df582b5e-692c-4b96-9c9e-f8ffc912b68b","_postman_id":"df582b5e-692c-4b96-9c9e-f8ffc912b68b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}},{"name":"Shareable Record API","item":[{"name":"Create shareable record","id":"10c6d46c-d174-468b-ac43-f276601dfa17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"app\": \"shipping\",\n\t\"fields\": \"address\"\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/sharedrecord/:method/:identity","description":"

Explanation

This API is used to create a shareable record that references another object in the database, such as a user, user-app, or session. Once created, the API will return a response containing a UUID_TOKEN, which points to the shareable information.

On success, the response will be:

{\"status\":\"ok\",\"record\": \"UUID_TOKEN\"}\n\n

This UUID_TOKEN can be shared, and it references the specified data.

Supported Fields in POST Request:

app: The name of the application, e.g. {\"app\":\"app_name\"}
\n
session: The session token, e.g.{\"session\":\"session-token\"}
\n
fields: Custom fields to share from the target object, e.g. {\"fields\":\"field,field2\"}
\n
expiration: The expiration time of the record in string format, e.g. {\"expiration\":\"1d\"}
\n

Special Notes:

If neither app nor session is provided, the API will return user profile fields.
\n
If fields is not specified (i.e., an empty POST), the entire user profile will be used to create the shareable record.
\n

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"token","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","key":"identity"}]}},"response":[{"id":"a5a4d3b1-36c9-4b15-ab36-f430e2e122e5","name":"Create shareable record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"app\": \"shipping\",\n\t\"fields\": \"address\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/sharedrecord/:method/:identity","protocol":"https","host":["demo","databunker","org"],"path":["v1","sharedrecord",":method",":identity"],"variable":[{"key":"method","value":"token","description":"Possible values: token, login, email, phone, custom"},{"key":"identity","value":"8c8b92b0-58c6-36db-634d-f0b0c798efd8","description":"User identity value"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 08 May 2020 10:31:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"record\": \"ec0aa229-48aa-85fa-c6c3-4e25deea4a3f\"\n}"}],"_postman_id":"10c6d46c-d174-468b-ac43-f276601dfa17"},{"name":"Get record value","id":"e9d68134-3de9-4b4e-a171-bf559855b212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/get/:record","description":"

Explanation

Get shreable record value.

No access token is required.

Shareable record token

\n","type":"text/plain"},"type":"string","value":"ec0aa229-48aa-85fa-c6c3-4e25deea4a3f","key":"record"}]}},"response":[{"id":"49160b36-ed0f-4202-b30e-3e89faa68f60","name":"Get record value","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://demo.databunker.org/v1/get/:record","protocol":"https","host":["demo.databunker.org"],"path":["v1","get",":record"],"variable":[{"key":"record","value":"ec0aa229-48aa-85fa-c6c3-4e25deea4a3f","description":"Shareable record token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 08 May 2020 10:32:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"app\": \"shipping\",\n \"data\": {\n \"address\": \"Red square 1\"\n }\n}"}],"_postman_id":"e9d68134-3de9-4b4e-a171-bf559855b212"}],"id":"2a1fd332-32c0-4208-bb9f-ffb6d296a498","description":"

The Shareable Record API allows you to securely share specific parts of application data, user profiles, or session details with external partners or store them in logs. This provides a simple way to expose limited, non-sensitive information without requiring authentication.

Key Features:

Each record has an expiration time and is automatically deleted when it expires.
\n
Shared records are publicly accessible without an access token or password.
\n

This API is useful when you need to share temporary data while maintaining control over its availability.

\n","_postman_id":"2a1fd332-32c0-4208-bb9f-ffb6d296a498","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}},{"name":"Legal Basis API","item":[{"name":"Create legal basis definition","id":"9657cddd-9278-4268-81c7-9ae4e20b5755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"requiredflag\": true,\r\n \"requiredmsg\": \"This field is required\",\r\n \"usercontro\": false,\r\n \"module\": \"signup\",\r\n \"basistype\": \"consent\",\r\n \"shortdesc\": \"short\",\r\n \"fulldesc\": \"full\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/lbasis/:brief","description":"

Explanation

This API is used to create a new definition of a legal basis in the system.

POST Body Format

POST Body can contain regular form data or JSON. Here is a table with a list of supported parameters.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter (required)	Description
fulldesc (no)	Full description
shortdesc (no)	Short description
basistype (no)	Type of the legal basis
requiredmsg (no)	The reason why this is required
usercontrol (no)	Boolean value. If true, the user can change this value on his own, otherwise, admin approval is required
requiredflag (no)	This legal basis is required to continue operation

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","lbasis",":brief"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Legal basis name

\n","type":"text/plain"},"type":"string","value":"send-sms-on-login","key":"brief"}]}},"response":[{"id":"f95635c1-a4e2-4f76-94fd-840ce91a3590","name":"Create legal basis","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"requiredflag\": true,\r\n \"requiredmsg\": \"This field is required.\",\r\n \"usercontro\": false,\r\n \"module\": \"signup\",\r\n \"basistype\": \"consent\",\r\n \"shortdesc\": \"short\",\r\n \"fulldesc\": \"full\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/lbasis/:brief","protocol":"https","host":["demo.databunker.org"],"path":["v1","lbasis",":brief"],"variable":[{"key":"brief","value":"send-sms-on-login","description":"Legal basis name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 19:17:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"9657cddd-9278-4268-81c7-9ae4e20b5755"},{"name":"Delete legal basis definition","id":"0243618d-713a-49d7-823b-6b8add9bc3ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://demo.databunker.org/v1/lbasis/:brief","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","lbasis",":brief"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Legal basis name

\n","type":"text/plain"},"type":"string","value":"send-sms-on-login","key":"brief"}]}},"response":[],"_postman_id":"0243618d-713a-49d7-823b-6b8add9bc3ec"},{"name":"List legal basis definitions","id":"8077a86c-54f7-4ebe-bccc-b3cac318b4ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/lbasis","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","lbasis"],"host":["demo.databunker.org"],"query":[],"variable":[]}},"response":[{"id":"73ef230a-e2f5-4ac1-8c4c-e3be0619db39","name":"List legal basis definitions","originalRequest":{"method":"GET","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":"https://demo.databunker.org/v1/lbasis"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 19:22:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"501"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"total\": 2,\n \"rows\": [\n {\n \"basistype\": \"\",\n \"brief\": \"send-email-on-login\",\n \"creationtime\": 1598126671,\n \"fulldesc\": \"full\",\n \"module\": \"signup\",\n \"requiredflag\": true,\n \"requiredmsg\": \"required\",\n \"shortdesc\": \"short\",\n \"status\": \"active\",\n \"tenant\": \"default\",\n \"usercontrol\": false\n },\n {\n \"basistype\": \"consent\",\n \"brief\": \"send-sms-on-login\",\n \"creationtime\": 1598126671,\n \"fulldesc\": \"full\",\n \"module\": \"signup\",\n \"requiredflag\": true,\n \"requiredmsg\": \"required\",\n \"shortdesc\": \"short\",\n \"status\": \"active\",\n \"tenant\": \"default\",\n \"usercontrol\": false\n }\n ]\n}"}],"_postman_id":"8077a86c-54f7-4ebe-bccc-b3cac318b4ff"}],"id":"cf6fb49f-63a9-457e-9bca-1d5879bbd683","description":"

The Legal Basis API is used to define and track the lawful grounds for processing personal data in your system, site, or app.

To process personal data, you must have a valid legal basis.

Supported legal bases:

user-consent
\n
contract
\n
legal-requirement
\n
legitimate-interest
\n
vital-interest
\n
public-interest
\n

This API helps ensure compliance by recording the appropriate legal basis for each data processing activity.

\n","event":[{"listen":"prerequest","script":{"id":"3ee089fb-55af-4fa0-98a1-977743e5ea1e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e8cb6a86-be37-4589-8785-572a8c2c7196","type":"text/javascript","exec":[""]}}],"_postman_id":"cf6fb49f-63a9-457e-9bca-1d5879bbd683","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}},{"name":"Agreements API","item":[{"name":"Accept user agreement","id":"1f8852f8-bfc2-426c-9b8d-aa852b23e1ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/agreement/:brief/:method/:identity","description":"

Explanation

This API is used to save user agreement, i.e. given consent.

POST Body Format

POST Body can contain regular form data or JSON. Here is a table with a list of supported parameters.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter (required)	Description
status (no)	Agreement status: yes, no, expired
agreementmethod (no)	Website, phone call, etc...
referencecode (no)	External id
lastmodifiedby (no)	String value
starttime (no)	The start time of the agreement
expiration (no)	The expiration time of the agreement

When consent is expired, the status value is changed to expired.

Legal basis name

\n","type":"text/plain"},"type":"string","value":"send-sms","key":"brief"},{"description":{"content":"

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"email","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"test@paranoidguy.com","key":"identity"}]}},"response":[],"_postman_id":"1f8852f8-bfc2-426c-9b8d-aa852b23e1ec"},{"name":"Get a list of all user agreements","id":"611178c3-d864-4450-9755-388f17c0a497","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/agreements/:method/:identity","description":"

Explanation

This API returns an array of all user agreements given. Pagination is not supported.

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"email","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"test@paranoidguy.com","key":"identity"}]}},"response":[{"id":"c9378b02-dd31-4ad1-9fa8-b6a9516d1faa","name":"Get a list of all user agreements","originalRequest":{"method":"GET","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/agreements/:method/:identity","protocol":"https","host":["demo","databunker","org"],"path":["v1","agreements",":method",":identity"],"variable":[{"key":"method","value":"email","description":"Possible values: token, login, email, phone, custom","type":"string"},{"key":"identity","value":"test@paranoidguy.com","description":"User identity value","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 19:46:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"558"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"total\": 2,\n \"rows\": [\n {\n \"agreementmethod\": \"api\",\n \"brief\": \"send-email-on-login\",\n \"creationtime\": 1599207773,\n \"endtime\": 0,\n \"lastmodifiedby\": \"\",\n \"mode\": \"email\",\n \"starttime\": 0,\n \"status\": \"yes\",\n \"tenant\": \"default\",\n \"token\": \"84ba242e-05de-9d5c-04e7-7c07fd33b458\",\n \"when\": 1599575099,\n \"who\": \"test@paranoidguy.com\"\n },\n {\n \"agreementmethod\": \"api\",\n \"brief\": \"send-sms-on-login\",\n \"creationtime\": 1598126672,\n \"endtime\": 0,\n \"lastmodifiedby\": \"\",\n \"mode\": \"phone\",\n \"starttime\": 0,\n \"status\": \"yes\",\n \"tenant\": \"default\",\n \"token\": \"84ba242e-05de-9d5c-04e7-7c07fd33b458\",\n \"when\": 1599493975,\n \"who\": \"4444\"\n }\n ]\n}"}],"_postman_id":"611178c3-d864-4450-9755-388f17c0a497"},{"name":"Withdraw user agreement","id":"c57595c5-40cf-4593-bc74-22205c66f035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://demo.databunker.org/v1/agreement/:brief/:method/:identity","description":"

Explanation

This API is used to withdraw user agreement, i.e. consent.

Legal basis name

\n","type":"text/plain"},"type":"string","value":"send-sms","key":"brief"},{"description":{"content":"

Possible values: token, login, email, phone, custom

\n","type":"text/plain"},"type":"string","value":"email","key":"method"},{"description":{"content":"

User identity value

\n","type":"text/plain"},"type":"string","value":"test@paranoidguy.com","key":"identity"}]}},"response":[],"_postman_id":"c57595c5-40cf-4593-bc74-22205c66f035"}],"id":"bcc4cfff-ce35-4668-96e2-dd4e59dba37b","description":"

The Agreements API is used to store and manage user agreements for data processing operations.

For example, a user can provide consent (legal basis type: consent) that is linked to one or more processing activities. This API ensures that user agreements are properly recorded and associated with the relevant legal basis.

\n","event":[{"listen":"prerequest","script":{"id":"299228c5-ae10-4c46-bab9-0a718e2f1147","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0cea12b2-ad13-48be-9b56-79babce660fc","type":"text/javascript","exec":[""]}}],"_postman_id":"bcc4cfff-ce35-4668-96e2-dd4e59dba37b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}},{"name":"Processing Operations API","item":[{"name":"Create processing operation","id":"803b973f-a4ce-40ad-bd5d-1b0c5525c7b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"applicableto\": \"customers\",\r\n \"fulldesc\": \"Share user profile with company partners\",\r\n \"title\": \"Share profile with partner\",\r\n \"script\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/pactivity/:pactivity","description":"

Explanation

This API is used to create a processing operation.

POST Body Format

POST Body can contain regular form data or JSON. Here is a table with a list of supported parameters.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter (required)	Description
title (no)	Activity short title
fulldesc (no)	Full activity description
legalbasis (no)	List of legal basis names separated by a comma
applicableto (no)	The group name of relevant users
script (no)	JavaScript to inject in page

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","pactivity",":pactivity"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Processing operation name

\n","type":"text/plain"},"type":"string","value":"share-profile-partner-with-partners","key":"pactivity"}]}},"response":[{"id":"e85ac730-5d79-41eb-9481-3b7ded8b399e","name":"Create processing operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"applicableto\": \"customers\",\r\n \"fulldesc\": \"Share user profile with company partners\",\r\n \"title\": \"Share profile with partner\",\r\n \"script\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/pactivity/:pactivity","protocol":"https","host":["demo.databunker.org"],"path":["v1","pactivity",":pactivity"],"variable":[{"key":"pactivity","value":"share-profile-partner-with-partners","description":"Processing activity name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 17:41:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"803b973f-a4ce-40ad-bd5d-1b0c5525c7b3"},{"name":"Update processing operation","id":"06229b2c-9bf5-4f02-984f-237eb2349bc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"activity\": \"share-profile-partner-with-partners2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://demo.databunker.org/v1/pactivity/:pactivity","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","pactivity",":pactivity"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Processing operation name

\n","type":"text/plain"},"type":"string","value":"share-profile-partner-with-partners","key":"pactivity"}]}},"response":[{"id":"e3befc14-1793-4890-9045-bab721fff1af","name":"Update processing operation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"activity\": \"share-profile-partner-with-partners2\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://demo.databunker.org/v1/pactivity/:pactivity","protocol":"https","host":["demo.databunker.org"],"path":["v1","pactivity",":pactivity"],"variable":[{"key":"pactivity","value":"share-profile-partner-with-partners","description":"Processing activity name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 17:44:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"06229b2c-9bf5-4f02-984f-237eb2349bc5"},{"name":"Delete processing operation","id":"41d8756a-27bc-4f05-85cb-9eb4ae99e1e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://demo.databunker.org/v1/pactivity/:pactivity","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","pactivity",":pactivity"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Processing operation name

\n","type":"text/plain"},"type":"string","value":"share-profile-partner-with-partners2","key":"pactivity"}]}},"response":[{"id":"21d679bf-f8fc-4ca0-830d-997b87f673c5","name":"Delete processing operation","originalRequest":{"method":"DELETE","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/pactivity/:pactivity","protocol":"https","host":["demo.databunker.org"],"path":["v1","pactivity",":pactivity"],"variable":[{"key":"pactivity","value":"share-profile-partner-with-partners2","description":"Processing operation name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 17:48:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"41d8756a-27bc-4f05-85cb-9eb4ae99e1e6"},{"name":"List processing operations","id":"4419ec47-5456-4139-bc32-669fffffa9f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://demo.databunker.org/v1/pactivity","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","pactivity"],"host":["demo.databunker.org"],"query":[],"variable":[]}},"response":[{"id":"a0984383-9fa3-4e15-849b-ab65ce5a12d2","name":"List processing operations","originalRequest":{"method":"GET","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":"https://demo.databunker.org/v1/pactivity"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 18:15:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"961"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"total\": 2,\n \"rows\": [\n {\n \"activity\": \"share-data-with-sms-provider\",\n \"applicableto\": \"empty\",\n \"briefs\": [\n {\n \"basistype\": \"\",\n \"brief\": \"send-sms-on-login\",\n \"creationtime\": 1598126671,\n \"fulldesc\": \"full\",\n \"module\": \"signup\",\n \"requiredflag\": true,\n \"requiredmsg\": \"required\",\n \"shortdesc\": \"short\",\n \"status\": \"active\",\n \"tenant\": \"default\",\n \"usercontrol\": false\n },\n {\n \"basistype\": \"\",\n \"brief\": \"send-email-on-login\",\n \"creationtime\": 1598126671,\n \"fulldesc\": \"full\",\n \"module\": \"signup\",\n \"requiredflag\": true,\n \"requiredmsg\": \"required\",\n \"shortdesc\": \"short\",\n \"status\": \"active\",\n \"tenant\": \"default\",\n \"usercontrol\": false\n }\n ],\n \"creationtime\": 1598126671,\n \"fulldesc\": \"full desc\",\n \"legalbasis\": \"send-sms-on-login,send-email-on-login\",\n \"script\": \"\",\n \"tenant\": \"default\",\n \"title\": \"send sms\"\n },\n {\n \"activity\": \"share-profile-partner2\",\n \"applicableto\": \"customers\",\n \"briefs\": null,\n \"creationtime\": 1599212763,\n \"fulldesc\": \"TEst\",\n \"script\": \"\",\n \"tenant\": \"default\",\n \"title\": \"Share profile with partner\"\n }\n ]\n}"}],"_postman_id":"4419ec47-5456-4139-bc32-669fffffa9f1"},{"name":"Link legal basis to the processing operation","id":"8aca4999-898f-4a82-96de-a0a5b0bbb7c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://demo.databunker.org/v1/pactivity/:activity/:brief","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","pactivity",":activity",":brief"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Processing operation name

\n","type":"text/plain"},"type":"string","value":"share-profile-partner2","key":"activity"},{"description":{"content":"

Legal basis name

\n","type":"text/plain"},"type":"string","value":"send-email-on-login","key":"brief"}]}},"response":[{"id":"00652bcc-a4b3-484c-a4c7-8d78f9602989","name":"Connect legal basis to processing operation","originalRequest":{"method":"POST","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/pactivity/:activity/:brief","protocol":"https","host":["demo.databunker.org"],"path":["v1","pactivity",":activity",":brief"],"variable":[{"key":"activity","value":"share-profile-partner2","description":"Processing operation name"},{"key":"brief","value":"send-email-on-login","description":"Legal basis name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 19:27:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"8aca4999-898f-4a82-96de-a0a5b0bbb7c4"},{"name":"Unlink legal basis from the processing operation","id":"319fa157-1ffd-4120-8c76-2efc807b17f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://demo.databunker.org/v1/pactivity/:activity/:brief","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","pactivity",":activity",":brief"],"host":["demo.databunker.org"],"query":[],"variable":[{"description":{"content":"

Processing operation name

\n","type":"text/plain"},"type":"string","value":"share-profile-partner2","key":"activity"},{"description":{"content":"

Legal basis name

\n","type":"text/plain"},"type":"string","value":"send-email-on-login","key":"brief"}]}},"response":[{"id":"a3a9bcb4-f1bc-4da2-8b24-0f0f6060afa0","name":"Unlink legal basis from processing operation","originalRequest":{"method":"DELETE","header":[{"key":"X-Bunker-Token","value":"DEMO","type":"text"}],"url":{"raw":"https://demo.databunker.org/v1/pactivity/:activity/:brief","protocol":"https","host":["demo.databunker.org"],"path":["v1","pactivity",":activity",":brief"],"variable":[{"key":"activity","value":"share-profile-partner2","description":"Processing operation name"},{"key":"brief","value":"send-email-on-login","description":"Legal basis name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 12 Sep 2020 19:29:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"319fa157-1ffd-4120-8c76-2efc807b17f7"}],"id":"e3cb2513-ee70-4a1f-ac7d-f10f885df407","description":"

The Processing Operations API is used to define and track all operations involving a customer's personal data, ensuring compliance with GDPR.

What is a Processing Operation?

According to GDPR, processing refers to any action performed on personal data, whether automated or manual. This includes:

Collecting, recording, organizing, structuring, and storing data
\n
Modifying, retrieving, consulting, and using data
\n
Transmitting, sharing, or disseminating data
\n
Restricting, erasing, or destroying data
\n

How the API Works

This API defines all processing operations associated with a customer’s personal data.
\n
Each operation must have a valid legal basis (e.g., consent, contract, legal requirement).
\n
A single processing operation can be linked to multiple legal bases.
\n

Example Use Case

A customer agrees to receive marketing newsletters.

Legal Basis: Consent
\n
Processing Operation: Sending customer details to a newsletter service
\n
Outcome: The newsletter service sends emails to the customer
\n

This API ensures transparency and compliance by maintaining a list of personal data processing activities.

\n","event":[{"listen":"prerequest","script":{"id":"6c2b4c04-e9ef-47d9-83c7-457ebca7ab9a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6627309-6312-46b2-bf6f-f7c76831c77e","type":"text/javascript","exec":[""]}}],"_postman_id":"e3cb2513-ee70-4a1f-ac7d-f10f885df407","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","id":"6dc14338-ece1-4059-8182-c7c1bf1b32a8","name":"Databunker API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Bunker-Token"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"2153cf73-edb3-4b2a-9c2a-e4ddfd3b459d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ebcc65b5-e69c-43da-9b94-66f8e4f6af1f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"HOST","value":"demo.databunker.org"}]}