Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To access the specific document, consumers must initiate an HTTP POST request to the /api/docipn/getdocuments/{:tokendocumentId} endpoint. The token documentId parameter represents the security token acquired during the Authentication process on the APIan unique identifier of the document in question. 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).

Action name

get document

HTTP path

/api/docipn/getdocuments/{:tokendocumentId}

  • token - a security token retrieved from AuthenticationdocumentId - an unique identifier of the requested document.

HTTP method

POST

Attributes of the HTTP request

HTTP Request Header

hash

Authorization

string

required

An unique identifier of the document.

A security token provided from Authentication endpoint.
Required to provide as a Bearer Token (in format: “Bearer {{token}}“).

JSON Body

bToken

string

required

An unique identifier of the broker.

Attributes of the HTTP response

...

This section shows examples of different HTTP requests and responses associated with the endpoint /api/docipn/getdocuments/{:tokendocuementId}.

HTTP Request

Code Block
languagejson
# HTTP POST
# https://ipn.dev.thinksurance.de/api/docipn/get/{:token}documents/<some ID>
#
# HTTP headers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
# 'Authorization': 'Bearer {<some long  "hash": "some encrypted string",string value>'
# 
{doc
  "bToken": "some encrypted string"
}

Successful HTTP Response

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

Failed HTTP Response

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

...