Skip to main content
POST
/
customers
/
onboarding
/
{id}
/
documents
Create onboarding document
curl --request POST \
  --url https://api.conduit.financial/customers/onboarding/{id}/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --form type=invoice \
  --form purpose=transaction_justification \
  --form 'name=<string>' \
  --form file='@example-file' \
  --form scope=transaction \
  --form 'metadata={}' \
  --form controlPersonId=ctl_2ofTA13AD0xBtbEvBl20aEb1hEu \
  --form front='@example-file' \
  --form back='@example-file'
{
  "id": "doc_2ofTA13AD0xBtbEvBl20aEb1hEu"
}

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

Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

Body

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

A valid Control Person ID

Example:

"ctl_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
front
file
​
back
file

Response

Document created successfully

Document object containing the document ID

​
id
string
required

A valid Document ID

Example:

"doc_2ofTAESrTs4uQ8N3yGBMhGj59jV"