Skip to main content
POST
/
customers
/
{customerId}
/
whitelist-recipients
Register an intercompany recipient for whitelisting
curl --request POST \
  --url https://api.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>",
  "relationship": "<string>",
  "legalName": "<string>",
  "evidenceDocumentIds": [
    "<string>"
  ],
  "label": "<string>"
}
'
{
  "id": "<string>",
  "customerId": "<string>",
  "accountNumber": "<string>",
  "routingNumber": "<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"
}

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
​
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
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).

​
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.

Minimum array length: 1
Pattern: ^doc_[0-9A-Za-z]{22}$
​
label
string

Optional human-readable label.

Maximum string length: 140

Response

​
id
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

US bank account number, returned exactly as submitted (this is the customer's own intercompany bank detail). Null for SWIFT recipients.

​
routingNumber
string | null
required

ABA routing number. Null for SWIFT recipients.

​
iban
string | null
required

IBAN, returned exactly as submitted. Null for US 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"