Skip to main content
POST
/
customers
/
onboarding
/
{id}
/
documents
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 'name=front and back document' \
  --form purpose=kyc \
  --form type=driver_license \
  --form front='@example-file' \
  --form back='@example-file' \
  --form controlPersonId=ctl_123 \
  --form file='@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

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

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

Body

multipart/form-data
​
name
string
required
​
purpose
enum<string>
required
Available options:
kyc,
kyb,
transaction_document,
other
​
type
enum<string>
required
Available options:
business_license,
tax_id,
invoice,
contract,
utility_bill,
source_of_funds,
shareholder_registry,
tax_certificate,
flow_of_funds,
power_of_attorney,
directors_registry,
company_structure_chart,
bank_statement,
operating_agreement,
ein_letter,
certificate_of_good_standing,
proof_of_funds,
partnership_agreement,
corporate_resolution,
certificate_of_incorporation,
certificate_of_registration,
w9_document,
wallets,
audited_accounts,
organizational_structure_chart,
articles_of_association,
insolvency_document,
aml_audit,
aml_audit_report,
financial_regulatory_license,
anti_bribery_policy,
cdd_policy,
reporting_entity_registration_document,
aml_policy,
balance_sheet,
sanctions_screening_policy,
other,
proof_of_registered_address,
proof_of_operating_address,
board_minutes,
independent_aml_audit_report,
compliance_audit_report,
investment_agreement,
registration_certificate,
institutional_investors_shareholder_registry,
cap_table,
regulatory_license,
approval_letter,
partnership_or_trust_agreement,
board_resolution,
passport,
driver_license,
national_id,
proof_of_address,
selfie,
selfie_image,
selfie_video,
pan_card,
voter_id_card,
resident_card,
ghana_card,
ghana_ssnit_card,
kenya_alien_card,
terms_of_service,
visa
​
metadata
object
​
controlPersonId
string

The ID of the control person who is associated with only for KYC documents

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

"ctl_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
file
file

The file to be uploaded

​
front
file

The front side of the document to be uploaded , only allowed for driver_license and national_id documents

​
back
file

The back side of the document to be uploaded , only allowed for driver_license and national_id documents

Response

Document created successfully

Document object containing the document ID

​
id
string
required

A valid Document ID

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

"doc_2ofTAESrTs4uQ8N3yGBMhGj59jV"