...
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}
|
HTTP method | POST |
Attributes of the HTTP request
HTTP Request Header |
---|
Authorization | string | required |
---|
A security token provided from Authentication endpoint. | |||
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 | |||||
| |||||
Successful HTTP Response | |||||
| |||||
Failed HTTP Response | |||||
|
...