Skip to main content
GET
/
counterparties
/
{id}
/
documents
/
{documentId}
Download counterparty document
curl --request GET \
  --url https://api.conduit.financial/counterparties/{id}/documents/{documentId} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>'
{
  "contentType": "<string>",
  "filename": "<string>",
  "buffer": null
}

Authorizations

​
X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

​
X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Path Parameters

​
id
string
required

A valid Counterparty ID

Pattern: ^cp_[a-zA-Z0-9]{27}$
Example:

"cp_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
documentId
string
required

A valid Document ID

Pattern: ^doc_[a-zA-Z0-9]{27}$
Example:

"doc_2ofTAESrTs4uQ8N3yGBMhGj59jV"

Response

Document downloaded successfully

​
contentType
string
required
​
filename
string
required
​
buffer
unknown