...
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).
Action name | get document |
---|---|
HTTP path | /api/ipndoc/documentsget/{:documentIdtoken}
|
HTTP method | GETPOST |
Attributes of the HTTP request
hash |
---|
Authorization
X-Broker-Token
string | required |
A security token provided from Authentication endpoint.
Required to provide as a Bearer Token (in format: “Bearer {{token}}“).
An unique identifier of the document. | |||
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/ipndoc/documentsget/{:docuementIdtoken}.
HTTP Request without profession filter | ||||
| ||||
HTTP Request with profession filter | ||||
| ||||
Successful HTTP Response | ||||
| ||||
Failed HTTP Response | ||||
|