Introduction

To obtain the payload of a specific document, the Thinksurance Public API V1, denoted as "the API," offers a specialised endpoint. This endpoint allows consumers to retrieve a document by its identifier (hash) and acquire its complete payload as a base64-encoded data.

Endpoint

To access the specific document, consumers must initiate an HTTP GET POST request to the /api/ipndoc/documentsget/{:documentIdtoken} endpoint. The documentId token parameter represents an unique identifier of the document in questionthe security token acquired during the Authentication process on the API. As essential components of the JSON payload within the body of the request, consumers are required to include the hash (serving as the document identifier) and bToken (functioning as the broker identifier).

Attributes of the HTTP request

Attributes of the HTTP response

Examples

This section shows examples of different HTTP requests and responses associated with the endpoint /api/ipndoc/documentsget/{:docuementIdtoken}.

# HTTP GETPOST
# https://ipnapp.dev.thinksurance.de/api/ipndoc/documents/<some ID>get/{:token}
# # HTTP headers
'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
 # 'Authorization' "hash": 'Bearer <some long"some encrypted string",
value>' # 'X-Broker-Token': '<some hash>'
#  "bToken": "some encrypted string"
}

# HTTP 200 status code
# 'Content-Type': 'text/pdf'
#
Base64 encoded payload

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "error": "API User is not existing or deactivated."
}

...