Features
Submit a feature request
Call GET /customers/:customerId/features/requirements first. Send dynamic data under fields (nested objects, NOT dotted keys). Upload each required document via POST /v2/documents (file only) and pass returned ids in documentIds[]. asset is required for VIRTUAL_ACCOUNT.
POST
/
customers
/
{customerId}
/
features
Submit a feature request
curl --request POST \
--url https://api.sandbox.conduit.financial/v2/customers/{customerId}/features \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"fields": {
"certification": {
"termsAndConditions": true
}
},
"documentIds": [
"doc_2xKjF9mQb7vN4hL1pR3w8t"
],
"asset": {
"code": "USD"
}
}
'import requests
url = "https://api.sandbox.conduit.financial/v2/customers/{customerId}/features"
payload = {
"fields": { "certification": { "termsAndConditions": True } },
"documentIds": ["doc_2xKjF9mQb7vN4hL1pR3w8t"],
"asset": { "code": "USD" }
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fields: {certification: {termsAndConditions: true}},
documentIds: ['doc_2xKjF9mQb7vN4hL1pR3w8t'],
asset: {code: 'USD'}
})
};
fetch('https://api.sandbox.conduit.financial/v2/customers/{customerId}/features', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.conduit.financial/v2/customers/{customerId}/features",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
'certification' => [
'termsAndConditions' => true
]
],
'documentIds' => [
'doc_2xKjF9mQb7vN4hL1pR3w8t'
],
'asset' => [
'code' => 'USD'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.conduit.financial/v2/customers/{customerId}/features"
payload := strings.NewReader("{\n \"fields\": {\n \"certification\": {\n \"termsAndConditions\": true\n }\n },\n \"documentIds\": [\n \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n ],\n \"asset\": {\n \"code\": \"USD\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.conduit.financial/v2/customers/{customerId}/features")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"certification\": {\n \"termsAndConditions\": true\n }\n },\n \"documentIds\": [\n \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n ],\n \"asset\": {\n \"code\": \"USD\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.conduit.financial/v2/customers/{customerId}/features")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": {\n \"certification\": {\n \"termsAndConditions\": true\n }\n },\n \"documentIds\": [\n \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n ],\n \"asset\": {\n \"code\": \"USD\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "pending",
"createdAt": "2026-01-15T09:30:00.000Z",
"updatedAt": "2026-01-15T09:30:00.000Z",
"type": "customer_onboarding",
"clientReferenceId": "ext-12345",
"submittedAt": "2026-01-15T09:30:00.000Z",
"failureCode": "rejected_by_ops",
"failureMessage": "<string>",
"resubmittable": true,
"customerId": "<string>",
"persons": [
{
"referenceId": "<string>",
"name": "<string>"
}
]
}{
"type": "INVALID_OID_FORMAT",
"title": "Invalid Object ID Format",
"status": 400,
"detail": "A path or query parameter expected a valid object identifier but received a value that does not match the expected format.",
"resolution": "Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.",
"docs": "https://conduit-v2.mintlify.app/errors#invalid-oid-format",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "API_KEY_MISSING",
"title": "API Key Missing",
"status": 401,
"detail": "The request did not include an API key. All API requests must be authenticated.",
"resolution": "Include your API key in the 'x-api-key' header with every request.",
"docs": "https://conduit-v2.mintlify.app/errors#api-key-missing",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "API_KEY_READ_ONLY",
"title": "API Key Is Read-Only",
"status": 403,
"detail": "This API key has read-only access and cannot perform write operations. Read-only keys may make read requests (GET, HEAD, OPTIONS) only.",
"resolution": "Use a read-write API key for this request, or have an organization admin mint one from the dashboard.",
"docs": "https://conduit-v2.mintlify.app/errors#api-key-read-only",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "CUSTOMER_NOT_FOUND",
"title": "Customer Not Found",
"status": 404,
"detail": "No customer exists with the specified ID, or the customer belongs to a different organization.",
"resolution": "Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization.",
"docs": "https://conduit-v2.mintlify.app/errors#customer-not-found",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "IDEMPOTENCY_KEY_CONFLICT",
"title": "Idempotency Key Conflict",
"status": 409,
"detail": "The idempotency key was previously used with a different request body. Idempotency keys are bound to the exact request shape — replays must match the original.",
"resolution": "Use a fresh idempotency key for the new request, or replay the original request unchanged.",
"docs": "https://conduit-v2.mintlify.app/errors#idempotency-key-conflict",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "UNSUPPORTED_MEDIA_TYPE",
"title": "Unsupported Media Type",
"status": 415,
"detail": "The request carries a body with a Content-Type this endpoint cannot parse. JSON endpoints accept 'application/json'; a body with no Content-Type header at all is assumed to be JSON. File-upload endpoints accept only 'multipart/form-data' — JSON or undeclared bodies are rejected there.",
"resolution": "Send the request body with the 'Content-Type: application/json' header. For file uploads, use 'Content-Type: multipart/form-data' — upload endpoints accept no other body type.",
"docs": "https://conduit-v2.mintlify.app/errors#unsupported-media-type",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "CUSTOMER_NOT_ONBOARDED",
"title": "Customer Not Onboarded",
"status": 422,
"detail": "This operation requires the customer to have completed onboarding, but the customer has not been fully onboarded yet.",
"resolution": "Complete the customer onboarding process before attempting this operation. See the onboarding guide for the required steps.",
"docs": "https://conduit-v2.mintlify.app/errors/customer-not-onboarded",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "RATE_LIMITED",
"title": "Rate Limited",
"status": 429,
"detail": "Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses.",
"resolution": "Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.",
"docs": "https://conduit-v2.mintlify.app/errors#rate-limited",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z",
"retryAfterSeconds": 3
}{
"type": "INTERNAL_ERROR",
"title": "Internal Error",
"status": 500,
"detail": "An unexpected error occurred while processing your request.",
"resolution": "Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.",
"docs": "https://conduit-v2.mintlify.app/errors#internal-error",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}Authorizations
Headers
Caller-generated unique key that lets the server safely replay this request. The original response is returned for 30 days on any retry with the same key from the same organization. Required on every state-changing money-moving or resource-creating POST.
Required string length:
1 - 128Pattern:
^[A-Za-z0-9_.:-]{1,128}$Example:
"01J7B3K2X9M8N5P6Q7R8S9T0V1"
Path Parameters
Example:
"cus_1A2b3C4d5E6f7G8h9I0jKl"
Body
application/json
The feature being requested
Available options:
virtual_account, crypto_wallet Key-value data required by the feature's requirements
Show child attributes
Show child attributes
Example:
{
"certification": { "termsAndConditions": true }
}
Flat list of uploaded document IDs to associate with this feature request
Maximum array length:
100Minimum string length:
1Example:
["doc_2xKjF9mQb7vN4hL1pR3w8t"]
Target asset for the feature, required for some feature types
Show child attributes
Show child attributes
Example:
{ "code": "USD" }
Response
The submitted feature-request application
- Option 1
- Option 2
- Option 3
- Option 4
Unique application identifier
Pattern:
^app_[0-9A-Za-z]{22}$Current lifecycle status of the application
Available options:
pending, processing, approved, rejected, cancelled Example:
"pending"
Timestamp when the application was created
Example:
"2026-01-15T09:30:00.000Z"
Timestamp when the application was last modified
Example:
"2026-01-15T09:30:00.000Z"
Available options:
customer_onboarding Client-provided identifier for cross-referencing. Omitted when the client did not supply one. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.
Pattern:
^[A-Za-z0-9_\-:.]{1,255}$Example:
"ext-12345"
Timestamp when the application was submitted for review. Omitted while still in progress.
Example:
"2026-01-15T09:30:00.000Z"
Machine-readable failure code on rejected applications. Omitted on non-rejected applications.
Available options:
rejected_by_ops, compliance_denied Customer-facing failure message accompanying failureCode. Omitted on non-rejected applications.
Whether a corrected application will be considered. true: correct the data and submit a fresh application. false: the decision is final, do not resubmit. Omitted on non-rejected applications.
Customer this onboarding application produced. Omitted while the application is still being reviewed; present after approval persists the customer row.
Pattern:
^cus_[0-9A-Za-z]{22}$People declared on the submission (beneficial owners and controlling persons), in submit order. Omitted before the application carries a submission.
Show child attributes
Show child attributes
⌘I
Submit a feature request
curl --request POST \
--url https://api.sandbox.conduit.financial/v2/customers/{customerId}/features \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"fields": {
"certification": {
"termsAndConditions": true
}
},
"documentIds": [
"doc_2xKjF9mQb7vN4hL1pR3w8t"
],
"asset": {
"code": "USD"
}
}
'import requests
url = "https://api.sandbox.conduit.financial/v2/customers/{customerId}/features"
payload = {
"fields": { "certification": { "termsAndConditions": True } },
"documentIds": ["doc_2xKjF9mQb7vN4hL1pR3w8t"],
"asset": { "code": "USD" }
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
fields: {certification: {termsAndConditions: true}},
documentIds: ['doc_2xKjF9mQb7vN4hL1pR3w8t'],
asset: {code: 'USD'}
})
};
fetch('https://api.sandbox.conduit.financial/v2/customers/{customerId}/features', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.conduit.financial/v2/customers/{customerId}/features",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'fields' => [
'certification' => [
'termsAndConditions' => true
]
],
'documentIds' => [
'doc_2xKjF9mQb7vN4hL1pR3w8t'
],
'asset' => [
'code' => 'USD'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.conduit.financial/v2/customers/{customerId}/features"
payload := strings.NewReader("{\n \"fields\": {\n \"certification\": {\n \"termsAndConditions\": true\n }\n },\n \"documentIds\": [\n \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n ],\n \"asset\": {\n \"code\": \"USD\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.conduit.financial/v2/customers/{customerId}/features")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"certification\": {\n \"termsAndConditions\": true\n }\n },\n \"documentIds\": [\n \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n ],\n \"asset\": {\n \"code\": \"USD\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.conduit.financial/v2/customers/{customerId}/features")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fields\": {\n \"certification\": {\n \"termsAndConditions\": true\n }\n },\n \"documentIds\": [\n \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n ],\n \"asset\": {\n \"code\": \"USD\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "pending",
"createdAt": "2026-01-15T09:30:00.000Z",
"updatedAt": "2026-01-15T09:30:00.000Z",
"type": "customer_onboarding",
"clientReferenceId": "ext-12345",
"submittedAt": "2026-01-15T09:30:00.000Z",
"failureCode": "rejected_by_ops",
"failureMessage": "<string>",
"resubmittable": true,
"customerId": "<string>",
"persons": [
{
"referenceId": "<string>",
"name": "<string>"
}
]
}{
"type": "INVALID_OID_FORMAT",
"title": "Invalid Object ID Format",
"status": 400,
"detail": "A path or query parameter expected a valid object identifier but received a value that does not match the expected format.",
"resolution": "Verify that all IDs in the request URL and query parameters are correctly formatted. IDs are typically prefixed strings like 'cus_...', 'app_...', or 'doc_...'.",
"docs": "https://conduit-v2.mintlify.app/errors#invalid-oid-format",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "API_KEY_MISSING",
"title": "API Key Missing",
"status": 401,
"detail": "The request did not include an API key. All API requests must be authenticated.",
"resolution": "Include your API key in the 'x-api-key' header with every request.",
"docs": "https://conduit-v2.mintlify.app/errors#api-key-missing",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "API_KEY_READ_ONLY",
"title": "API Key Is Read-Only",
"status": 403,
"detail": "This API key has read-only access and cannot perform write operations. Read-only keys may make read requests (GET, HEAD, OPTIONS) only.",
"resolution": "Use a read-write API key for this request, or have an organization admin mint one from the dashboard.",
"docs": "https://conduit-v2.mintlify.app/errors#api-key-read-only",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "CUSTOMER_NOT_FOUND",
"title": "Customer Not Found",
"status": 404,
"detail": "No customer exists with the specified ID, or the customer belongs to a different organization.",
"resolution": "Verify the customer ID is correct. Use the list customers endpoint to find valid customer IDs for your organization.",
"docs": "https://conduit-v2.mintlify.app/errors#customer-not-found",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "IDEMPOTENCY_KEY_CONFLICT",
"title": "Idempotency Key Conflict",
"status": 409,
"detail": "The idempotency key was previously used with a different request body. Idempotency keys are bound to the exact request shape — replays must match the original.",
"resolution": "Use a fresh idempotency key for the new request, or replay the original request unchanged.",
"docs": "https://conduit-v2.mintlify.app/errors#idempotency-key-conflict",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "UNSUPPORTED_MEDIA_TYPE",
"title": "Unsupported Media Type",
"status": 415,
"detail": "The request carries a body with a Content-Type this endpoint cannot parse. JSON endpoints accept 'application/json'; a body with no Content-Type header at all is assumed to be JSON. File-upload endpoints accept only 'multipart/form-data' — JSON or undeclared bodies are rejected there.",
"resolution": "Send the request body with the 'Content-Type: application/json' header. For file uploads, use 'Content-Type: multipart/form-data' — upload endpoints accept no other body type.",
"docs": "https://conduit-v2.mintlify.app/errors#unsupported-media-type",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "CUSTOMER_NOT_ONBOARDED",
"title": "Customer Not Onboarded",
"status": 422,
"detail": "This operation requires the customer to have completed onboarding, but the customer has not been fully onboarded yet.",
"resolution": "Complete the customer onboarding process before attempting this operation. See the onboarding guide for the required steps.",
"docs": "https://conduit-v2.mintlify.app/errors/customer-not-onboarded",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}{
"type": "RATE_LIMITED",
"title": "Rate Limited",
"status": 429,
"detail": "Too many requests. This error is returned by three independent checks: the per-organization bucket applied to every authenticated API request; the per-IP bucket applied to unauthenticated traffic before an API key is validated; and the per-IP bucket applied when repeated invalid API keys are submitted from the same address. Honor the Retry-After header (also exposed as retryAfterSeconds in the body) before retrying. Current limits and remaining budget are visible in X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on rate-limited route responses.",
"resolution": "Sleep until Retry-After seconds have elapsed, then retry. For sustained workloads exceeding the per-organization defaults, request a rate-limit increase through your support contact.",
"docs": "https://conduit-v2.mintlify.app/errors#rate-limited",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z",
"retryAfterSeconds": 3
}{
"type": "INTERNAL_ERROR",
"title": "Internal Error",
"status": 500,
"detail": "An unexpected error occurred while processing your request.",
"resolution": "Retry the request after a brief delay. If the error persists, contact support and include the correlationId from the error response for investigation.",
"docs": "https://conduit-v2.mintlify.app/errors#internal-error",
"instance": "/v2/...",
"correlationId": "00469ea4-52c1-4ffa-bd05-9f28b236a5fe",
"timestamp": "2026-01-15T09:30:00.000Z"
}