Skip to main content
POST
/
documents
Upload document
curl --request POST \
  --url https://api.conduit.financial/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --form file='@example-file' \
  --form scope=transaction \
  --form type=invoice \
  --form purpose=transaction_justification
{
  "id": "doc_2ofTAESrTs4uQ8N3yGBMhGj59jV"
}

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.

Body

multipart/form-data
​
file
file
​
scope
enum<string>
default:transaction
Available options:
transaction,
counterparty,
customer
​
type
enum<string>
default:invoice
Available options:
invoice,
contract
​
purpose
enum<string>
default:transaction_justification
Available options:
transaction_justification

Response

The created document

​
id
string
required

A valid Document ID

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

"doc_2ofTAESrTs4uQ8N3yGBMhGj59jV"