Security Protocols

Create a security protocol

Creates a security protocol linked to an address of your address book.

POSThttps://api.dashdoc.eu/api/v4/security-protocols/

Body

application/json

address*number

Id of the address the security protocol should be linked.

document*string (byte)

File content. Use content-type with multipart/form-data value to the header of the request to send a document.

document_titlestring

Filename

Response

201

Create successful

Body

application/json

pknumber

Dashdoc's internal id. It will be automatically generated by Dashdoc.

addressnumber

Id of the address that the security protocol should be linked to.

documentstring

URL of the stored document. You can download the document from this URL.

document_titlestring

Filename

updatedstring (date-time)

Last updated time

has_been_seen_recentlyboolean

Check if you've seen the security protocol recently. Returns null if it hasn't been seen at all.

Request

JavaScriptCurl

const response = await fetch('https://api.dashdoc.eu/api/v4/security-protocols/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": 1,
      "document": "Ynl0ZXM="
    }),
});
const data = await response.json();

Response

{
  "pk": 1,
  "address": 1,
  "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png",
  "document_title": "text",
  "updated": "2024-04-27T15:24:49.089Z",
  "has_been_seen_recently": false
}

Partially update a security protocol

PATCHhttps://api.dashdoc.eu/api/v4/security-protocols/{pk}/

Path parameters

pk*integer

Dashdoc's internal id

Body

application/json

addressnumber

Id of the address that the security protocol should be linked to.

documentstring (byte)

File content. Use content-type with multipart/form-data value to the header of the request to send a document.

document_titlestring

Filename

Response

200

Get successful

Body

application/json

pknumber

Dashdoc's internal id. It will be automatically generated by Dashdoc.

addressnumber

Id of the address that the security protocol should be linked to.

documentstring

URL of the stored document. You can download the document from this URL.

document_titlestring

Filename

updatedstring (date-time)

Last updated time

has_been_seen_recentlyboolean

Check if you've seen the security protocol recently. Returns null if it hasn't been seen at all.

Request

JavaScriptCurl

const response = await fetch('https://api.dashdoc.eu/api/v4/security-protocols/{pk}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "pk": 1,
  "address": 1,
  "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png",
  "document_title": "text",
  "updated": "2024-04-27T15:24:49.089Z",
  "has_been_seen_recently": false
}