Skip to main content
POST
/
customers
/
{id}
/
documents
Upload transaction supporting document
curl --request POST \
  --url https://api.conduit.financial/customers/{id}/documents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "documentId": "doc_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "purpose": "transaction_justification",
  "type": "contract",
  "name": "Contract"
}
'
{
  "id": "doc_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "createdAt": "2024-12-31T23:59:59Z"
}

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 Customer ID

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

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

Body

application/json

Request to upload a customer document

​
documentId
string
required

A valid Document ID

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

"doc_2ofTAESrTs4uQ8N3yGBMhGj59jV"

​
type
enum<string>
required

Type of document

Available options:
contract,
invoice
Example:

"contract"

​
name
string
required
​
purpose
enum<string>
default:transaction_justification

Purpose of the document

Available options:
transaction_justification
Example:

"transaction_justification"

Response

Document created successfully

Customer document creation response

​
id
string
required
Minimum string length: 1
​
createdAt
string<date-time>
required