Whitelist Recipients

Register an intercompany recipient for whitelisting

Registers a bank recipient as an intercompany counterparty for this customer. The entry starts in pending_review; compliance review outcomes are signalled via whitelist_recipient.* webhooks. Only registered entries satisfy purpose=intercompany payouts. Identical resubmissions return the existing entry. Resubmitting with the same bank details but different attributes (name, relationship, documents) returns 409 WHITELIST_RECIPIENT_CONFLICT.

POST

customers

{customerId}

whitelist-recipients

curl --request POST \
  --url https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "rail": "us",
  "routingNumber": "<string>",
  "accountNumber": "<string>",
  "legalName": "<string>",
  "evidenceDocumentIds": [
    "<string>"
  ],
  "label": "<string>"
}
'

import requests

url = "https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients"

payload = {
    "rail": "us",
    "routingNumber": "<string>",
    "accountNumber": "<string>",
    "legalName": "<string>",
    "evidenceDocumentIds": ["<string>"],
    "label": "<string>"
}
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({
    rail: 'us',
    routingNumber: '<string>',
    accountNumber: '<string>',
    legalName: '<string>',
    evidenceDocumentIds: ['<string>'],
    label: '<string>'
  })
};

fetch('https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients', 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}/whitelist-recipients",
  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([
    'rail' => 'us',
    'routingNumber' => '<string>',
    'accountNumber' => '<string>',
    'legalName' => '<string>',
    'evidenceDocumentIds' => [
        '<string>'
    ],
    'label' => '<string>'
  ]),
  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}/whitelist-recipients"

	payload := strings.NewReader("{\n  \"rail\": \"us\",\n  \"routingNumber\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"legalName\": \"<string>\",\n  \"evidenceDocumentIds\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\"\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}/whitelist-recipients")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rail\": \"us\",\n  \"routingNumber\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"legalName\": \"<string>\",\n  \"evidenceDocumentIds\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients")

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  \"rail\": \"us\",\n  \"routingNumber\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"legalName\": \"<string>\",\n  \"evidenceDocumentIds\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "customerId": "<string>",
  "accountNumber": "<string>",
  "routingNumber": "<string>",
  "bic": "<string>",
  "iban": "<string>",
  "legalName": "<string>",
  "evidenceDocumentIds": [
    "<string>"
  ],
  "label": "<string>",
  "rejectionReason": "<string>",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z"
}

{
  "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": "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": "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": "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}$

Path Parameters

customerId

string

required

Body

application/json

Option 1
Option 2
Option 3

rail

enum<string>

required

US domestic bank recipient, identified by ABA routing + account number.

Available options:

us

routingNumber

string

required

ABA routing number (9 digits, checksum-validated).

accountNumber

string

required

US bank account number.

Required string length: 4 - 64

relationship

enum<string>

required

Relationship between the customer and the recipient: self (the customer's own account) or group_entity (another entity in the customer's corporate group).

Available options:

self,

group_entity

legalName

string

required

Legal name of the bank account holder.

Maximum string length: 255

evidenceDocumentIds

string[]

required

Ids of previously uploaded documents (doc_*) evidencing the intercompany relationship (e.g. ownership chart, bank statement). At least one is required.

Required array length: 1 - 100 elements

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

label

string

Optional human-readable label.

Maximum string length: 140

Response

string

required

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

customerId

string

required

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

rail

enum<string>

required

Available options:

us,

swift

accountNumber

string | null

required

Bank account number, normalized (spaces and dashes stripped) — US, or SWIFT recipients registered by BIC + account number. Null for IBAN-registered recipients.

routingNumber

string | null

required

ABA routing number. Null for SWIFT recipients.

bic

string | null

required

BIC of the recipient bank (canonicalized to the 11-character form), for SWIFT recipients registered by BIC + account number. Null otherwise — for IBAN-registered recipients the IBAN alone is the matched identity, so supply the bank's BIC yourself when creating a payout.

iban

string | null

required

IBAN, normalized (spacing and case). Null for US recipients and BIC-registered SWIFT recipients.

legalName

string

required

relationship

enum<string>

required

Available options:

self,

group_entity

status

enum<string>

required

Available options:

pending_review,

registered,

suspended,

revoked,

rejected

evidenceDocumentIds

string[]

required

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

label

string | null

required

rejectionReason

string | null

required

createdAt

string<date-time>

required

ISO 8601 timestamp

Example:

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

updatedAt

string<date-time>

required

ISO 8601 timestamp

Example:

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

⌘I

curl --request POST \
  --url https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "rail": "us",
  "routingNumber": "<string>",
  "accountNumber": "<string>",
  "legalName": "<string>",
  "evidenceDocumentIds": [
    "<string>"
  ],
  "label": "<string>"
}
'

import requests

url = "https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients"

payload = {
    "rail": "us",
    "routingNumber": "<string>",
    "accountNumber": "<string>",
    "legalName": "<string>",
    "evidenceDocumentIds": ["<string>"],
    "label": "<string>"
}
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({
    rail: 'us',
    routingNumber: '<string>',
    accountNumber: '<string>',
    legalName: '<string>',
    evidenceDocumentIds: ['<string>'],
    label: '<string>'
  })
};

fetch('https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients', 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}/whitelist-recipients",
  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([
    'rail' => 'us',
    'routingNumber' => '<string>',
    'accountNumber' => '<string>',
    'legalName' => '<string>',
    'evidenceDocumentIds' => [
        '<string>'
    ],
    'label' => '<string>'
  ]),
  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}/whitelist-recipients"

	payload := strings.NewReader("{\n  \"rail\": \"us\",\n  \"routingNumber\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"legalName\": \"<string>\",\n  \"evidenceDocumentIds\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\"\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}/whitelist-recipients")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rail\": \"us\",\n  \"routingNumber\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"legalName\": \"<string>\",\n  \"evidenceDocumentIds\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.conduit.financial/v2/customers/{customerId}/whitelist-recipients")

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  \"rail\": \"us\",\n  \"routingNumber\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"legalName\": \"<string>\",\n  \"evidenceDocumentIds\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "customerId": "<string>",
  "accountNumber": "<string>",
  "routingNumber": "<string>",
  "bic": "<string>",
  "iban": "<string>",
  "legalName": "<string>",
  "evidenceDocumentIds": [
    "<string>"
  ],
  "label": "<string>",
  "rejectionReason": "<string>",
  "createdAt": "2026-01-15T09:30:00.000Z",
  "updatedAt": "2026-01-15T09:30:00.000Z"
}

{
  "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": "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": "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": "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

Register an intercompany recipient for whitelisting

Authorizations

Headers

Path Parameters

Body

Response