Security Protocols

Create a security protocol

post

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

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Body

application/json

addressnumberRequired

Id of the address the security protocol should be linked.

Example: 1

documentstring · byteRequired

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

document_titlestringOptional

Filename

Responses

201

Create successful

application/json

post

/security-protocols/

HTTPcURLJavaScriptPython

POST /api/v4/security-protocols/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "address": 1,
  "document": "Ynl0ZXM=",
  "document_title": "text"
}

201

Create successful

{
  "pk": 1,
  "address": 1,
  "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png",
  "document_title": "text",
  "updated": "2026-03-16T18:55:12.120Z",
  "has_been_seen_recently": true
}

Partially update a security protocol

patch

Authorizations

ApiKeyAuth

AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"

Path parameters

pkintegerRequired

Dashdoc's internal id

Body

application/json

addressnumberOptional

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

Example: 1

documentstring · byteOptional

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

document_titlestringOptional

Filename

Responses

200

Get successful

application/json

pknumberOptional

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

Example: 1

addressnumberOptional

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

Example: 1

documentstringOptional

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

Example: https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png

document_titlestringOptional

Filename

updatedstring · date-timeOptional

Last updated time

has_been_seen_recentlybooleanOptional

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

patch

/security-protocols/{pk}/

HTTPcURLJavaScriptPython

PATCH /api/v4/security-protocols/{pk}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "address": 1,
  "document": "Ynl0ZXM=",
  "document_title": "text"
}

200

Get successful

{
  "pk": 1,
  "address": 1,
  "document": "https://storage.googleapis.com/dashdoc-media/media/shipments/aabd42eb.png",
  "document_title": "text",
  "updated": "2026-03-16T18:55:12.120Z",
  "has_been_seen_recently": true
}