Customer Onboarding

Submit a customer onboarding application

Call GET /v2/onboarding/requirements first. Each entry in fields[] carries a JSON Pointer at fields[].pointer (e.g. /businessInfo/taxId) describing where the value belongs in the submission body; strip the leading / and treat each segment as a nested key (businessInfo: { taxId }). Upload each required document via POST /v2/documents (file only; no type declaration needed), then pass the returned doc_... ids in top-level documentIds[] (customer-level) and ownership.persons[i].documentIds[] (per-person, flat). The AI classifier resolves doc canonical types at review time.

POST

onboarding

curl --request POST \
  --url https://api.sandbox.conduit.financial/v2/onboarding \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "businessInfo": {},
  "registeredAddress": {},
  "operatingAddress": {},
  "companyClassification": {},
  "businessActivity": {},
  "compliance": {},
  "regulatoryHistory": {},
  "ownership": {},
  "relatedCompany": {},
  "certification": {},
  "documentIds": [
    "doc_2xKjF9mQb7vN4hL1pR3w8t"
  ],
  "clientReferenceId": "ext_customer_8421"
}
'

import requests

url = "https://api.sandbox.conduit.financial/v2/onboarding"

payload = {
    "businessInfo": {},
    "registeredAddress": {},
    "operatingAddress": {},
    "companyClassification": {},
    "businessActivity": {},
    "compliance": {},
    "regulatoryHistory": {},
    "ownership": {},
    "relatedCompany": {},
    "certification": {},
    "documentIds": ["doc_2xKjF9mQb7vN4hL1pR3w8t"],
    "clientReferenceId": "ext_customer_8421"
}
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({
    businessInfo: {},
    registeredAddress: {},
    operatingAddress: {},
    companyClassification: {},
    businessActivity: {},
    compliance: {},
    regulatoryHistory: {},
    ownership: {},
    relatedCompany: {},
    certification: {},
    documentIds: ['doc_2xKjF9mQb7vN4hL1pR3w8t'],
    clientReferenceId: 'ext_customer_8421'
  })
};

fetch('https://api.sandbox.conduit.financial/v2/onboarding', 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/onboarding",
  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([
    'businessInfo' => [
        
    ],
    'registeredAddress' => [
        
    ],
    'operatingAddress' => [
        
    ],
    'companyClassification' => [
        
    ],
    'businessActivity' => [
        
    ],
    'compliance' => [
        
    ],
    'regulatoryHistory' => [
        
    ],
    'ownership' => [
        
    ],
    'relatedCompany' => [
        
    ],
    'certification' => [
        
    ],
    'documentIds' => [
        'doc_2xKjF9mQb7vN4hL1pR3w8t'
    ],
    'clientReferenceId' => 'ext_customer_8421'
  ]),
  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/onboarding"

	payload := strings.NewReader("{\n  \"businessInfo\": {},\n  \"registeredAddress\": {},\n  \"operatingAddress\": {},\n  \"companyClassification\": {},\n  \"businessActivity\": {},\n  \"compliance\": {},\n  \"regulatoryHistory\": {},\n  \"ownership\": {},\n  \"relatedCompany\": {},\n  \"certification\": {},\n  \"documentIds\": [\n    \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n  ],\n  \"clientReferenceId\": \"ext_customer_8421\"\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/onboarding")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessInfo\": {},\n  \"registeredAddress\": {},\n  \"operatingAddress\": {},\n  \"companyClassification\": {},\n  \"businessActivity\": {},\n  \"compliance\": {},\n  \"regulatoryHistory\": {},\n  \"ownership\": {},\n  \"relatedCompany\": {},\n  \"certification\": {},\n  \"documentIds\": [\n    \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n  ],\n  \"clientReferenceId\": \"ext_customer_8421\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/onboarding")

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  \"businessInfo\": {},\n  \"registeredAddress\": {},\n  \"operatingAddress\": {},\n  \"companyClassification\": {},\n  \"businessActivity\": {},\n  \"compliance\": {},\n  \"regulatoryHistory\": {},\n  \"ownership\": {},\n  \"relatedCompany\": {},\n  \"certification\": {},\n  \"documentIds\": [\n    \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n  ],\n  \"clientReferenceId\": \"ext_customer_8421\"\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",
  "failureMessage": "<string>",
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "NOT_FOUND",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource does not exist or you do not have access to it.",
  "resolution": "Check that the resource ID in the URL is correct. The resource may have been deleted or may belong to a different account.",
  "docs": "https://conduit-v2.mintlify.app/errors#not-found",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ONBOARDING_NOT_READY",
  "title": "Onboarding Not Ready",
  "status": 422,
  "detail": "The onboarding submission cannot be completed because one or more required fields or documents are still missing, or a submitted value is not one of the accepted options for a closed-set field (e.g. a country-specific field like `companyClassification.legalStructure`). Each blocker is reported per field in `errors[]` with a `category` and, for closed-set fields, the accepted `allowedValues`.",
  "resolution": "Use the onboarding requirements endpoint to check which fields and documents are required and which values each field accepts, then submit valid values before retrying.",
  "docs": "https://conduit-v2.mintlify.app/errors#onboarding-not-ready",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "errors": [
    {
      "pointer": "/businessInfo/taxId",
      "detail": "Tax ID is required",
      "category": "field"
    },
    {
      "pointer": "/documentIds",
      "detail": "At least one document is required",
      "category": "document"
    }
  ]
}

{
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

Authorizations

x-api-key

string

header

required

Headers

Idempotency-Key

string

required

Caller-generated unique key that lets the server safely replay this request. The cached response is returned for 5 minutes on any retry with the same key from the same API principal. Required on every state-changing money-moving or resource-creating POST.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_.:-]{1,128}$

Body

application/json

businessInfo

object

Business-level data (e.g. taxId, legalName, tradeName). Inner shape resolved from GET /v2/onboarding/requirements.

Show child attributes

registeredAddress

object

Registered business address. Inner shape (e.g. addressLine1, city, state, postalCode, country) resolved from requirements; country accepts ISO 3166-1 alpha-2 or alpha-3.

Show child attributes

operatingAddress

object

Operating address when different from registeredAddress. Same inner shape and country rules.

Show child attributes

companyClassification

object

Legal-structure and industry classification (e.g. legalStructure, coreIndustry). Inner shape resolved from requirements.

Show child attributes

businessActivity

object

Operating-activity descriptors (e.g. countries of activity, expected volumes). Inner shape resolved from requirements.

Show child attributes

compliance

object

Compliance-attestation fields. Inner shape resolved from requirements.

Show child attributes

regulatoryHistory

object

Regulatory and adverse-action history. Inner shape resolved from requirements.

Show child attributes

ownership

object

Beneficial-owner and controlling-person disclosure under ownership.persons[]. Inner shape resolved from individualRequirements[]; each person carries roles[], scalar identity fields, and documentIds[].

Show child attributes

Related-company disclosure for affiliated entities. Inner shape resolved from requirements.

Show child attributes

certification

object

Legal certifications the customer must affirm (e.g. termsAndConditions: true). Inner shape resolved from requirements; mustEqual: true markers in discovery indicate exact-value gates.

Show child attributes

documentIds

string[]

Customer-level document IDs from POST /v2/documents to attach to this onboarding. Per-person documents go on ownership.persons[i].documentIds[].

Maximum array length: 100

Minimum string length: 1

Example:

["doc_2xKjF9mQb7vN4hL1pR3w8t"]

clientReferenceId

string

Optional integrator-supplied identifier echoed back on the application record for cross-system correlation. 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_customer_8421"

Response

The submitted onboarding application

Option 1
Option 2
Option 3
Option 4

string

required

Unique application identifier

Pattern: ^app_[0-9A-Za-z]{22}$

status

enum<string>

required

Current lifecycle status of the application

Available options:

pending,

processing,

approved,

rejected,

cancelled

Example:

"pending"

createdAt

string<date-time>

required

Timestamp when the application was created

Example:

"2026-01-15T09:30:00.000Z"

updatedAt

string<date-time>

required

Timestamp when the application was last modified

Example:

"2026-01-15T09:30:00.000Z"

type

enum<string>

required

Available options:

customer_onboarding

clientReferenceId

string

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"

submittedAt

string<date-time>

Timestamp when the application was submitted for review. Omitted while still in progress.

Example:

"2026-01-15T09:30:00.000Z"

failureCode

enum<string>

Machine-readable failure code on rejected applications. Omitted on non-rejected applications.

Available options:

rejected_by_ops,

compliance_denied

failureMessage

string

Customer-facing failure message accompanying failureCode. Omitted on non-rejected applications.

customerId

string

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}$

persons

object[]

People declared on the submission (beneficial owners and controlling persons), in submit order. Omitted before the application carries a submission.

Show child attributes

⌘I

Submit a customer onboarding application

curl --request POST \
  --url https://api.sandbox.conduit.financial/v2/onboarding \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "businessInfo": {},
  "registeredAddress": {},
  "operatingAddress": {},
  "companyClassification": {},
  "businessActivity": {},
  "compliance": {},
  "regulatoryHistory": {},
  "ownership": {},
  "relatedCompany": {},
  "certification": {},
  "documentIds": [
    "doc_2xKjF9mQb7vN4hL1pR3w8t"
  ],
  "clientReferenceId": "ext_customer_8421"
}
'

import requests

url = "https://api.sandbox.conduit.financial/v2/onboarding"

payload = {
    "businessInfo": {},
    "registeredAddress": {},
    "operatingAddress": {},
    "companyClassification": {},
    "businessActivity": {},
    "compliance": {},
    "regulatoryHistory": {},
    "ownership": {},
    "relatedCompany": {},
    "certification": {},
    "documentIds": ["doc_2xKjF9mQb7vN4hL1pR3w8t"],
    "clientReferenceId": "ext_customer_8421"
}
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({
    businessInfo: {},
    registeredAddress: {},
    operatingAddress: {},
    companyClassification: {},
    businessActivity: {},
    compliance: {},
    regulatoryHistory: {},
    ownership: {},
    relatedCompany: {},
    certification: {},
    documentIds: ['doc_2xKjF9mQb7vN4hL1pR3w8t'],
    clientReferenceId: 'ext_customer_8421'
  })
};

fetch('https://api.sandbox.conduit.financial/v2/onboarding', 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/onboarding",
  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([
    'businessInfo' => [
        
    ],
    'registeredAddress' => [
        
    ],
    'operatingAddress' => [
        
    ],
    'companyClassification' => [
        
    ],
    'businessActivity' => [
        
    ],
    'compliance' => [
        
    ],
    'regulatoryHistory' => [
        
    ],
    'ownership' => [
        
    ],
    'relatedCompany' => [
        
    ],
    'certification' => [
        
    ],
    'documentIds' => [
        'doc_2xKjF9mQb7vN4hL1pR3w8t'
    ],
    'clientReferenceId' => 'ext_customer_8421'
  ]),
  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/onboarding"

	payload := strings.NewReader("{\n  \"businessInfo\": {},\n  \"registeredAddress\": {},\n  \"operatingAddress\": {},\n  \"companyClassification\": {},\n  \"businessActivity\": {},\n  \"compliance\": {},\n  \"regulatoryHistory\": {},\n  \"ownership\": {},\n  \"relatedCompany\": {},\n  \"certification\": {},\n  \"documentIds\": [\n    \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n  ],\n  \"clientReferenceId\": \"ext_customer_8421\"\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/onboarding")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"businessInfo\": {},\n  \"registeredAddress\": {},\n  \"operatingAddress\": {},\n  \"companyClassification\": {},\n  \"businessActivity\": {},\n  \"compliance\": {},\n  \"regulatoryHistory\": {},\n  \"ownership\": {},\n  \"relatedCompany\": {},\n  \"certification\": {},\n  \"documentIds\": [\n    \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n  ],\n  \"clientReferenceId\": \"ext_customer_8421\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/onboarding")

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  \"businessInfo\": {},\n  \"registeredAddress\": {},\n  \"operatingAddress\": {},\n  \"companyClassification\": {},\n  \"businessActivity\": {},\n  \"compliance\": {},\n  \"regulatoryHistory\": {},\n  \"ownership\": {},\n  \"relatedCompany\": {},\n  \"certification\": {},\n  \"documentIds\": [\n    \"doc_2xKjF9mQb7vN4hL1pR3w8t\"\n  ],\n  \"clientReferenceId\": \"ext_customer_8421\"\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",
  "failureMessage": "<string>",
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "NOT_FOUND",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource does not exist or you do not have access to it.",
  "resolution": "Check that the resource ID in the URL is correct. The resource may have been deleted or may belong to a different account.",
  "docs": "https://conduit-v2.mintlify.app/errors#not-found",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

{
  "type": "ONBOARDING_NOT_READY",
  "title": "Onboarding Not Ready",
  "status": 422,
  "detail": "The onboarding submission cannot be completed because one or more required fields or documents are still missing, or a submitted value is not one of the accepted options for a closed-set field (e.g. a country-specific field like `companyClassification.legalStructure`). Each blocker is reported per field in `errors[]` with a `category` and, for closed-set fields, the accepted `allowedValues`.",
  "resolution": "Use the onboarding requirements endpoint to check which fields and documents are required and which values each field accepts, then submit valid values before retrying.",
  "docs": "https://conduit-v2.mintlify.app/errors#onboarding-not-ready",
  "instance": "/v2/...",
  "correlationId": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z",
  "errors": [
    {
      "pointer": "/businessInfo/taxId",
      "detail": "Tax ID is required",
      "category": "field"
    },
    {
      "pointer": "/documentIds",
      "detail": "At least one document is required",
      "category": "document"
    }
  ]
}

{
  "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": "req_a1b2c3d4",
  "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": "req_a1b2c3d4",
  "timestamp": "2026-01-15T09:30:00.000Z"
}

Overview

Errors

Customers

Registered Addresses

Wallets

Wallet Signers

Signing Quorum

Virtual Accounts

Applications

Documents

Verifications

Signing Requests

Transactions

Payouts

Whitelist Recipients

Orders

RFIs

Webhook Endpoints

Webhook Deliveries

Webhook Event Types

Features

Customer Onboarding

Sandbox

Submit a customer onboarding application

Authorizations

Headers

Body

Response