Security Protocol

Read a security protocol of an address

GEThttps://api.dashdoc.eu/api/v4/addresses/{pk}/security-protocol/

Path parameters

pk*number

Dashdoc's internal id

remote_idstring

If you choose to identify an object with its remote_id instead of its pk then

• replace the pk value with the remote_id value in the URL

• specify lookup_field=remote_id in the query parameters

Query parameters

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/addresses/{pk}/security-protocol/', {
    method: 'GET',
    headers: {},
});
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-27T18:02:06.097Z",
  "has_been_seen_recently": false
}