Documents
Counterparties
Customers
- GETList customers
- POSTCreate a customer
- GETGet customer
- DELDelete customer
- POSTCreate KYB link
- GETList payment methods
- POSTCreate payment method
- GETGet payment method
- DELDelete payment method
- PATCHUpdate payment method
- POSTCreate customer document
- DELDelete customer document
- GETDownload customer document
- POSTCreate control persons
- POSTCreate onboarding document
- POSTSubmit for onboarding
- GETGet liveness check
Quotes
Create control persons
Copy
Ask AI
curl --request POST \
--url https://api.conduit.financial/customers/{id}/control-persons \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-API-Secret: <api-key>' \
--data '
{
"controlPersons": [
{
"firstName": "John",
"lastName": "Doe",
"middleName": "Michael",
"email": "[email protected]",
"address": {
"streetLine1": "123 Main St",
"streetLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA"
},
"nationality": "USA",
"sharesAllocated": 500,
"ownershipPercentage": 35.5,
"birthDate": "2000-01-01T00:00:00.000Z",
"gender": "male",
"phone": "+1234567890",
"title": "CEO",
"isEntity": false,
"ssn": "123-45-6789",
"immigrationStatus": "citizen",
"numberType": "ssn",
"taxResidencyCountry": "USA",
"regulatoryAffiliations": [
{
"regulatoryAffiliation": "FINRA"
}
],
"roles": [
{
"name": "beneficial_owner",
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2025-01-01T00:00:00.000Z",
"current": true
}
],
"identityInfo": {
"documentCountry": "USA",
"documentType": "passport",
"documentNumber": "1234567890",
"documentIssueDate": "2021-01-01T00:00:00.000Z",
"documentExpiryDate": "2025-01-01T00:00:00.000Z"
}
},
{
"firstName": "Marie",
"lastName": "Dubois",
"middleName": "Claire",
"email": "[email protected]",
"address": {
"streetLine1": "15 Rue de la Paix",
"streetLine2": "Apt 4B",
"city": "Paris",
"state": "Île-de-France",
"postalCode": "75001",
"country": "FRA"
},
"nationality": "FRA",
"sharesAllocated": 750,
"ownershipPercentage": 64.25,
"birthDate": "1988-03-15T00:00:00.000Z",
"gender": "female",
"phone": "+33123456789",
"title": "CTO",
"isEntity": false,
"taxResidencyCountry": "FRA",
"regulatoryAffiliations": [
{
"regulatoryAffiliation": "ACPR"
}
],
"roles": [
{
"name": "beneficial_owner",
"startDate": "2020-01-01T00:00:00.000Z",
"endDate": "2030-01-01T00:00:00.000Z",
"current": true
}
],
"identityInfo": {
"documentCountry": "FRA",
"documentType": "passport",
"documentNumber": "FR123456789",
"documentIssueDate": "2020-01-01T00:00:00.000Z",
"documentExpiryDate": "2030-01-01T00:00:00.000Z"
}
}
]
}
'Copy
Ask AI
{
"success": true,
"customerId": "cus_2ofTA13AD0xBtbEvBl20aEb1hEu",
"controlPersons": [
{
"id": "ctl_2ofTA13AD0xBtbEvBl20aEb1hEu",
"firstName": "John",
"lastName": "Doe",
"middleName": "Michael",
"email": "[email protected]",
"birthDate": "2000-01-01T00:00:00.000Z",
"address": {
"streetLine1": "123 Main St",
"streetLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA"
},
"nationality": "USA",
"gender": "male",
"phone": "+1234567890",
"title": "CEO",
"isEntity": false,
"immigrationStatus": "citizen",
"numberType": "ssn",
"taxResidencyCountry": "USA",
"regulatoryAffiliations": [
{
"regulatoryAffiliation": "FINRA"
}
],
"sharesAllocated": 1500,
"ownershipPercentage": 100,
"referenceId": "ref_123",
"roles": [
{
"name": "beneficial_owner",
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2025-01-01T00:00:00.000Z",
"current": true
}
],
"identityInfo": {
"documentCountry": "USA",
"documentType": "passport",
"documentNumber": "1234567890",
"documentIssueDate": "2021-01-01T00:00:00.000Z",
"documentExpiryDate": "2025-01-01T00:00:00.000Z"
}
}
]
}Customers
Create control persons
Create one or more control persons for a customer
POST
/
customers
/
{id}
/
control-persons
Create control persons
Copy
Ask AI
curl --request POST \
--url https://api.conduit.financial/customers/{id}/control-persons \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-API-Secret: <api-key>' \
--data '
{
"controlPersons": [
{
"firstName": "John",
"lastName": "Doe",
"middleName": "Michael",
"email": "[email protected]",
"address": {
"streetLine1": "123 Main St",
"streetLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA"
},
"nationality": "USA",
"sharesAllocated": 500,
"ownershipPercentage": 35.5,
"birthDate": "2000-01-01T00:00:00.000Z",
"gender": "male",
"phone": "+1234567890",
"title": "CEO",
"isEntity": false,
"ssn": "123-45-6789",
"immigrationStatus": "citizen",
"numberType": "ssn",
"taxResidencyCountry": "USA",
"regulatoryAffiliations": [
{
"regulatoryAffiliation": "FINRA"
}
],
"roles": [
{
"name": "beneficial_owner",
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2025-01-01T00:00:00.000Z",
"current": true
}
],
"identityInfo": {
"documentCountry": "USA",
"documentType": "passport",
"documentNumber": "1234567890",
"documentIssueDate": "2021-01-01T00:00:00.000Z",
"documentExpiryDate": "2025-01-01T00:00:00.000Z"
}
},
{
"firstName": "Marie",
"lastName": "Dubois",
"middleName": "Claire",
"email": "[email protected]",
"address": {
"streetLine1": "15 Rue de la Paix",
"streetLine2": "Apt 4B",
"city": "Paris",
"state": "Île-de-France",
"postalCode": "75001",
"country": "FRA"
},
"nationality": "FRA",
"sharesAllocated": 750,
"ownershipPercentage": 64.25,
"birthDate": "1988-03-15T00:00:00.000Z",
"gender": "female",
"phone": "+33123456789",
"title": "CTO",
"isEntity": false,
"taxResidencyCountry": "FRA",
"regulatoryAffiliations": [
{
"regulatoryAffiliation": "ACPR"
}
],
"roles": [
{
"name": "beneficial_owner",
"startDate": "2020-01-01T00:00:00.000Z",
"endDate": "2030-01-01T00:00:00.000Z",
"current": true
}
],
"identityInfo": {
"documentCountry": "FRA",
"documentType": "passport",
"documentNumber": "FR123456789",
"documentIssueDate": "2020-01-01T00:00:00.000Z",
"documentExpiryDate": "2030-01-01T00:00:00.000Z"
}
}
]
}
'Copy
Ask AI
{
"success": true,
"customerId": "cus_2ofTA13AD0xBtbEvBl20aEb1hEu",
"controlPersons": [
{
"id": "ctl_2ofTA13AD0xBtbEvBl20aEb1hEu",
"firstName": "John",
"lastName": "Doe",
"middleName": "Michael",
"email": "[email protected]",
"birthDate": "2000-01-01T00:00:00.000Z",
"address": {
"streetLine1": "123 Main St",
"streetLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA"
},
"nationality": "USA",
"gender": "male",
"phone": "+1234567890",
"title": "CEO",
"isEntity": false,
"immigrationStatus": "citizen",
"numberType": "ssn",
"taxResidencyCountry": "USA",
"regulatoryAffiliations": [
{
"regulatoryAffiliation": "FINRA"
}
],
"sharesAllocated": 1500,
"ownershipPercentage": 100,
"referenceId": "ref_123",
"roles": [
{
"name": "beneficial_owner",
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2025-01-01T00:00:00.000Z",
"current": true
}
],
"identityInfo": {
"documentCountry": "USA",
"documentType": "passport",
"documentNumber": "1234567890",
"documentIssueDate": "2021-01-01T00:00:00.000Z",
"documentExpiryDate": "2025-01-01T00:00:00.000Z"
}
}
]
}Authorizations
Includes an API key in the HTTP headers to authenticate the client.
Includes an API secret in the HTTP headers to authenticate the client.
Path Parameters
A valid Customer ID
Example:
"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"
Body
application/json
Request to create a control person
Minimum array length:
1Show child attributes
Show child attributes
Required range:
x > 0Address information
Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1The ISO 3166-1 alpha-3 country code (e.g., USA, GBR, FRA)
Required string length:
3Example:
{
"streetLine1": "123 Main St",
"streetLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA"
}Required string length:
3Show child attributes
Show child attributes
Required string length:
3Available options:
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, bank_statement, power_of_attorney, terms_of_service, other A valid Control Person ID
Example:
"ctl_2ofTA13AD0xBtbEvBl20aEb1hEu"
The ISO 3166-1 alpha-3 country code (e.g., USA, GBR, FRA)
Required string length:
3Available options:
male, female, other Response
Control persons created
Control person creation response
Show child attributes
Show child attributes
Required range:
x > 0Address information
Show child attributes
Show child attributes
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1The ISO 3166-1 alpha-3 country code (e.g., USA, GBR, FRA)
Required string length:
3Example:
{
"streetLine1": "123 Main St",
"streetLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA"
}Required string length:
3Show child attributes
Show child attributes
Required string length:
3Available options:
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, bank_statement, power_of_attorney, terms_of_service, other A valid Control Person ID
Example:
"ctl_2ofTA13AD0xBtbEvBl20aEb1hEu"
The ISO 3166-1 alpha-3 country code (e.g., USA, GBR, FRA)
Required string length:
3Available options:
male, female, other A valid Customer ID
Example:
"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"
⌘I