External bank account to which Bridge will send the funds. The currency associated with the External Account must match the destination currency.
Required string length: 1 - 42
Pattern: [a-z0-9]*
prefunded_account_id
string
The developer's prefunded account id that Bridge will send the funds to.
Required string length: 1 - 42
Pattern: [a-z0-9]*
bridge_wallet_id
string
The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the payment rail.
Required string length: 1 - 42
Pattern: [a-z0-9]*
destination_wire_message
string
A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 characters according to the Fedwire standard.
Required string length: 1 - 256
destination_sepa_reference
string
A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are a-z, A-Z, 0-9, spaces, ampersand (&), hyphen (-), full stop (.), and solidus (/). If not populated, the default value is "Payment via Bridge {unique_token}".
Required string length: 6 - 140
destination_ach_reference
string
A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.
Required string length: 1 - 10
destination_spei_reference
string
A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric a-z, A-Z, 0-9, and space
Required string length: 1 - 40
destination_swift_reference
string
A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by "\n"), each line with a max length of 35 chars. The allowed characters are a-z, A-Z, 0-9, special characters (/-?:().,'+), and space
Required string length: 1 - 140
destination_charge_bearer
enum<string>
Which party bears the charges for each SWIFT payout. Defaults to sha when not specified. Only accepted when destination_payment_rail is swift.
Available options:
our,
sha,
ben
destination_swift_details
object
Additional instructions to apply to each SWIFT payout. Only accepted when destination_payment_rail is swift.
Show child attributes
destination_reference
string
A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).
destination_payment_rail
enum<string>
The payment rail that Bridge will use to send funds to the customer. Will default to ACH if not specified.
Available options:
ach,
wire,
ach_push,
ach_same_day,
arbitrum,
avalanche_c_chain,
base,
bre_b,
co_bank_transfer,
celo,
ethereum,
faster_payments,
fiat_deposit_return,
linea,
optimism,
pix,
polygon,
sepa,
solana,
spei,
stellar,
swift,
tempo,
tron,
xdc
destination_currency
enum<string>
The currency that Bridge will use to send funds to the customer. Will default to USD if not specified.
Available options:
brl,
cop,
eur,
eurc,
gbp,
mxn,
ousd,
path_usd,
pyusd,
usd,
usdb,
usdc,
usdt,
usdl_linea
destination_address
string
The crypto wallet address that Bridge will use to send funds to the customer.
destination_blockchain_memo
string
The memo to include in the transaction, for blockchains that support memos only
return_address
string | null
deprecated
Deprecated: use return_instructions instead.
The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction.
Must be on the same chain as the liquidation address.
Cannot be used on Stellar — use return_instructions with a memo instead.
return_instructions
object
The return instructions Bridge will use to route funds back to the customer when a transaction fails.
Replaces the deprecated return_address field. Set one or the other, not both.
For memo-required chains (e.g. Stellar), both address and memo are required — without a memo, Bridge cannot
route the return to the correct end-customer at an omnibus wallet.
Show child attributes
custom_developer_fee_percent
string<number> | null
The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.
Example:
"0.1"
travel_rule_data
object
Travel Rule data for this liquidation address. Use this only when the same originator or beneficiary should apply to every future movement through this liquidation address. If counterparties can vary by deposit or drain, submit the payload later with POST /travel_rule_data/{id} for the relevant movement.
The payment rail that Bridge will use to send funds to the customer.
Available options:
ach,
wire,
ach_push,
ach_same_day,
arbitrum,
avalanche_c_chain,
base,
bre_b,
co_bank_transfer,
celo,
ethereum,
faster_payments,
fiat_deposit_return,
linea,
optimism,
pix,
polygon,
sepa,
solana,
spei,
stellar,
swift,
tempo,
tron,
xdc
destination_currency
enum<string>
required
The currency that Bridge will use to send funds to the customer.
Available options:
brl,
cop,
eur,
eurc,
gbp,
mxn,
ousd,
path_usd,
pyusd,
usd,
usdb,
usdc,
usdt,
usdl_linea
external_account_id
string
External bank account to which Bridge will send the funds.
Required string length: 1 - 42
Pattern: [a-z0-9]*
prefunded_account_id
string
The developer's prefunded account to which Bridge will send the funds.
Required string length: 1 - 42
Pattern: [a-z0-9]*
bridge_wallet_id
string
The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the payment rail.
Required string length: 1 - 42
Pattern: [a-z0-9]*
destination_wire_message
string
A message to be sent with a wire transfer.
Required string length: 1 - 256
destination_sepa_reference
string
A reference message to be sent with a SEPA transaction.
Required string length: 6 - 140
destination_ach_reference
string
A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.
Required string length: 1 - 10
destination_spei_reference
string
A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric a-z, A-Z, 0-9, and space
Required string length: 1 - 40
destination_swift_reference
string
A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by "\n"), each line with a max length of 35 chars. The allowed characters are a-z, A-Z, 0-9, special characters (/-?:().,'+), and space
Required string length: 1 - 140
destination_charge_bearer
enum<string>
Which party bears the charges for each SWIFT payout. Defaults to sha when not specified. Only accepted when destination_payment_rail is swift.
Available options:
our,
sha,
ben
destination_swift_details
object
Additional instructions to apply to each SWIFT payout. Only accepted when destination_payment_rail is swift.
Show child attributes
destination_reference
string
A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).
destination_address
string
The crypto wallet address that Bridge will use to send funds to the customer.
destination_blockchain_memo
string
The memo to include in the transaction, for blockchains that support memos only
return_address
string | null
deprecated
Deprecated: use return_instructions instead.
The crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction.
Must be on the same chain as the liquidation address.
Cannot be used on Stellar — use return_instructions with a memo instead.
return_instructions
object
The return instructions Bridge will use to route funds back to the customer when a transaction fails.
Replaces the deprecated return_address field. Set one or the other, not both.
For memo-required chains (e.g. Stellar), both address and memo are required — without a memo, Bridge cannot
route the return to the correct end-customer at an omnibus wallet.
Show child attributes
custom_developer_fee_percent
string<number> | null
The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.
Example:
"0.1"
travel_rule_data
object
Travel Rule data for this liquidation address. Use this only when the same originator or beneficiary should apply to every future movement through this liquidation address. If counterparties can vary by deposit or drain, submit the payload later with POST /travel_rule_data/{id} for the relevant movement.
The blockchain address the customer will send funds to.
memoless_address
string
An alternative crypto wallet address that encodes the memo, allowing the customer to send funds without needing to include a separate memo. Currently only available for Stellar deposits.
state
string
The state of the liquidation address. It could be "active" or "deactivated"
return_memo
string | null
The memo included with return transactions. Present when return_instructions was set with a memo (e.g. required for Stellar to route funds to the correct end-customer).
supported_currencies
object
read-only
The currencies this Liquidation Address accepts on each chain. Keys are LiquidationAddressSourceChain values (e.g. ethereum, polygon, base). For a single-chain, single-currency address this is just that one chain and currency; for a multi-chain (chain is evm) or multi-currency (currency is all_supported) address it lists every currency actually accepted on each chain.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bridge","colors":{"primary":"#047857","light":"#047857","dark":"#047857"},"logo":{"light":"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/bridge-logo-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=c91d77ec31a41686da7d32d0c999b34a","dark":"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/bridge-logo-wordmark-light.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=5a0980c2f0de4ea7c2f263c589a1cff6"},"favicon":"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/favicon-docs.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=7804dcb568bd9fc9cd8a04d82d37e03f","api":{"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json"},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://bridge.coastdemo.com/share/693741a8dc19176c45ad2004?mode=link","label":"Demo"},{"href":"https://support.bridge.xyz/","label":"Support"}],"primary":{"type":"button","label":"Bridge Dashboard","href":"https://dashboard.bridge.xyz/"}},"footer":{"socials":{"x":"https://x.com/stablecoin","linkedin":"https://linkedin.com/company/bridge-apis"}},"fonts":{"heading":{"family":"Abc Diatype Regular","source":"https://cdn.prod.website-files.com/66c78bffc753432b33c4f61a/66c78bffc753432b33c4f654_ABC%20Diatype%20Regular.ttf","format":"woff2"},"body":{"family":"Abc Diatype Regular","source":"https://cdn.prod.website-files.com/66c78bffc753432b33c4f61a/66c78bffc753432b33c4f654_ABC%20Diatype%20Regular.ttf","format":"woff2"}},"integrations":{"gtm":{"tagId":"GTM-W79785BK"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bridge-727305d3","hasAudioNarration":false,"actualSubdomain":"bridge-727305d3","customDomains":["apidocs.bridge.xyz"],"gitSource":{"type":"github","owner":"withbridge","repo":"bridge-api-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb57815be3cc8d577f9984","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API reference","count":136},{"language":"default","tag":"Endpoints","count":131},{"language":"default","tag":"Developer Platform","count":95},{"language":"default","tag":"Cards","count":43},{"language":"default","tag":"Customers","count":43},{"language":"default","tag":"Get Started","count":34},{"language":"default","tag":"Guides","count":25},{"language":"default","tag":"Orchestration","count":22},{"language":"default","tag":"Transfers","count":14},{"language":"default","tag":"Issuance","count":13}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6a95e7c5dbba852a7e9d61cd","deploymentId":"68794f73dbdb837ef9af8c37","questionText":"Which endpoint can I use to create a Virtual Account?","status":"active","generatedBy":"manual","createdAt":"2026-08-31T20:44:53.966Z","updatedAt":"2026-08-31T20:44:53.966Z","__v":0},{"_id":"6a95e78ddbba852a7e9d5f5b","deploymentId":"68794f73dbdb837ef9af8c37","questionText":"Which payment rails are supported?","status":"active","generatedBy":"manual","createdAt":"2026-08-31T20:43:57.235Z","updatedAt":"2026-08-31T20:43:57.235Z","__v":0},{"_id":"6a95e766dbba852a7e9d5c38","deploymentId":"68794f73dbdb837ef9af8c37","questionText":"What's required to KYC a customer?","status":"active","generatedBy":"manual","createdAt":"2026-08-31T20:43:18.066Z","updatedAt":"2026-08-31T20:43:54.236Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"body{color:#1e293b;font-family:'Inter', sans-serif}#sidebar{border-right:1px solid rgba(203, 213, 225, 0.6)}#navbar{background-color:#ffffff}.nav-logo{width:63px!important;height:24px!important;top:2px}.eyebrow{color:#6b7280!important}.dark .eyebrow{color:#9ca3af!important}a,.button-primary{color:#047857;font-weight:500;transition:color 0.2s ease}a:hover,.button-primary:hover{color:#065f46}#navbar a[href=\"/\"]:hover,#navbar a[href^=\"/get-started/\"]:hover,#navbar a[href^=\"/platform/\"]:hover,#navbar a[href^=\"/api-reference/\"]:hover,#navbar a[href^=\"/changelog/\"]:hover{color:#065f46!important;border-color:#047857!important;text-decoration-color:#047857!important}#navbar a[href=\"/\"]:hover>div:last-child,#navbar a[href^=\"/get-started/\"]:hover>div:last-child,#navbar a[href^=\"/platform/\"]:hover>div:last-child,#navbar a[href^=\"/api-reference/\"]:hover>div:last-child,#navbar a[href^=\"/changelog/\"]:hover>div:last-child{background-color:#047857!important}#topbar-cta-button>a:hover{color:#ffffff!important}#topbar-cta-button>a:hover>span:first-child{background-color:#065f46!important;opacity:1!important}.button-secondary{background-color:#047857;color:#ffffff;border-radius:0.375rem;padding:0.5rem 1rem;font-weight:500;transition:background-color 0.2s ease}.button-secondary:hover{background-color:#10b981}.card,.api-doc-box,.sidebar-section{box-shadow:0 1px 3px rgba(0, 0, 0, 0.05);border-radius:0.5rem}.hero h1{font-size:52px;font-weight:400}.hero subline{font-size:24px;font-weight:400;font-kerning:auto}.hero icon{text-decoration-color:white}.bg-dots-gradient{background-image:radial-gradient(#23cd94 0.5px, transparent 0.5px),\n linear-gradient(to bottom, #d4f2ef, #f7fafc, white);background-size:10px 10px, auto;background-repeat:repeat, no-repeat}"}],"page":{"pagePath":"api-reference/liquidation-addresses/create-a-liquidation-address","slug":"/api-reference/liquidation-addresses/create-a-liquidation-address","pageMetadata":{"title":"Create a Liquidation Address","description":null,"deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/liquidation_addresses","href":"/api-reference/liquidation-addresses/create-a-liquidation-address","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a Liquidation Address","description":null,"deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/liquidation_addresses","href":"/api-reference/liquidation-addresses/create-a-liquidation-address","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a Liquidation Address","tags":["Liquidation Addresses"],"parameters":["4bfb04d4-1e22-4cff-8f2b-bc4f57112bd5","d4c08bd6-412a-4e11-afcb-4386313487af"],"requestBody":"a4cacc0c-e7f6-408e-8f9f-2c5a514300bd","responses":{"201":"a30aa220-ff4c-44de-9b88-c5c3dc43e12c","400":"98f214fa-eb0a-4524-8a1b-0644052bb76f","401":"b0b6dbfd-fb92-449f-a823-3f358fd3c545","500":"2e3048c8-79e8-44f8-9a73-cd62af8765ae"},"method":"post","type":"path","servers":["8cfd91ab-6780-4f17-8205-744d686f1bbb"],"security":["ab600454-21be-4dfb-bb8b-e5b838e20b79"],"path":"/customers/{customerID}/liquidation_addresses","baseUrlOptions":["https://api.bridge.xyz/v0"],"title":"Create a Liquidation Address","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4bfb04d4-1e22-4cff-8f2b-bc4f57112bd5":{"name":"customerID","in":"path","required":true,"schema":{"description":"A UUID that uniquely identifies a resource","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"isRequired":true,"uniqueKey":"","typeLabel":"string"}},"d4c08bd6-412a-4e11-afcb-4386313487af":{"in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"Liquidation Address object to be created","required":true,"content":{"application/json":{"schema":{"required":["currency","chain"],"properties":{"currency":{"type":"string","enum":["usdb","usdc","usdt","usdl_linea","pyusd","eurc","all_supported"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"chain":{"type":"string","enum":["arbitrum","avalanche_c_chain","base","celo","ethereum","linea","optimism","polygon","solana","stellar","tempo","tron","xdc","evm"],"isRequired":true,"uniqueKey":"chain","typeLabel":"enum\u003cstring>"},"external_account_id":{"description":"External bank account to which Bridge will send the funds. The currency associated with the External Account must match the destination currency.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"external_account_id","typeLabel":"string"},"prefunded_account_id":{"description":"The developer's prefunded account id that Bridge will send the funds to.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"prefunded_account_id","typeLabel":"string"},"bridge_wallet_id":{"description":"The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the payment rail.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"bridge_wallet_id","typeLabel":"string"},"destination_wire_message":{"description":"A message to be sent with a wire transfer. It can have up to 140 characters. This message will be validated against 4 lines, each with a max length of 35 characters according to the Fedwire standard.","type":"string","minLength":1,"maxLength":256,"uniqueKey":"destination_wire_message","typeLabel":"string"},"destination_sepa_reference":{"description":"A reference message to be sent with a SEPA transaction. We recommend you set a unique value to help you and your customers track payments end to end. It must be from 6 to 140 characters. The allowed characters are `a-z`, `A-Z`, `0-9`, spaces, ampersand (`\u0026`), hyphen (`-`), full stop (`.`), and solidus (`/`). If not populated, the default value is \"Payment via Bridge {unique_token}\".","type":"string","minLength":6,"maxLength":140,"uniqueKey":"destination_sepa_reference","typeLabel":"string"},"destination_ach_reference":{"description":"A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.","type":"string","minLength":1,"maxLength":10,"uniqueKey":"destination_ach_reference","typeLabel":"string"},"destination_spei_reference":{"description":"A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space","type":"string","minLength":1,"maxLength":40,"uniqueKey":"destination_spei_reference","typeLabel":"string"},"destination_swift_reference":{"description":"A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by \"\\n\"), each line with a max length of 35 chars. The allowed characters are `a-z`, `A-Z`, `0-9`, special characters (`/` `-` `?` `:` `(` `)` `.` `,` `'` `+`), and space","type":"string","minLength":1,"maxLength":140,"uniqueKey":"destination_swift_reference","typeLabel":"string"},"destination_charge_bearer":{"description":"Which party bears the charges for each SWIFT payout. Defaults to `sha` when not specified. Only accepted when `destination_payment_rail` is `swift`.","type":"string","enum":["our","sha","ben"],"uniqueKey":"destination_charge_bearer","typeLabel":"enum\u003cstring>"},"destination_swift_details":{"description":"Additional instructions to apply to each SWIFT payout. Only accepted when `destination_payment_rail` is `swift`.","properties":{"instructed_currency":{"description":"The currency in which the beneficiary is to be credited, as a lowercase three-letter ISO 4217 code. When omitted, no conversion is requested and the payout is sent in the destination currency of the transfer or liquidation address. The exchange rate is determined when the payout is processed. Unsupported currencies are rejected.","type":"string","minLength":3,"maxLength":3,"example":"sgd","uniqueKey":"destination_swift_details.instructed_currency","typeLabel":"string"},"purpose":{"description":"The purpose of the payment, in the form the destination country requires: a local purpose code or a short free-text description. Required when `instructed_currency` is a currency other than `aud`, `cad`, `fjd`, or `usd`. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"destination_swift_details.purpose","typeLabel":"string"},"category_purpose_code":{"description":"The category purpose code that indicates how banks should process the payment, for destination countries that use one. Accepts an ISO 20022 category purpose code (e.g. `SALA`, case-insensitive) or a code from the destination country's own list. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"destination_swift_details.category_purpose_code","typeLabel":"string"}},"type":"object","uniqueKey":"destination_swift_details","typeLabel":"object"},"destination_reference":{"description":"A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).","type":"string","uniqueKey":"destination_reference","typeLabel":"string"},"destination_payment_rail":{"type":"string","enum":["ach","wire","ach_push","ach_same_day","arbitrum","avalanche_c_chain","base","bre_b","co_bank_transfer","celo","ethereum","faster_payments","fiat_deposit_return","linea","optimism","pix","polygon","sepa","solana","spei","stellar","swift","tempo","tron","xdc"],"description":"The payment rail that Bridge will use to send funds to the customer. Will default to ACH if not specified.","uniqueKey":"destination_payment_rail","typeLabel":"enum\u003cstring>"},"destination_currency":{"type":"string","enum":["brl","cop","eur","eurc","gbp","mxn","ousd","path_usd","pyusd","usd","usdb","usdc","usdt","usdl_linea"],"description":"The currency that Bridge will use to send funds to the customer. Will default to USD if not specified.","uniqueKey":"destination_currency","typeLabel":"enum\u003cstring>"},"destination_address":{"type":"string","description":"The crypto wallet address that Bridge will use to send funds to the customer.","uniqueKey":"destination_address","typeLabel":"string"},"destination_blockchain_memo":{"description":"The memo to include in the transaction, for blockchains that support memos only","type":"string","uniqueKey":"destination_blockchain_memo","typeLabel":"string"},"return_address":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated: use `return_instructions` instead.\n\nThe crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction.\nMust be on the same chain as the liquidation address.\nCannot be used on Stellar — use `return_instructions` with a `memo` instead.\n","uniqueKey":"return_address.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated: use `return_instructions` instead.\n\nThe crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction.\nMust be on the same chain as the liquidation address.\nCannot be used on Stellar — use `return_instructions` with a `memo` instead.\n","uniqueKey":"return_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_address","typeLabel":"string | null"},"return_instructions":{"type":"object","description":"The return instructions Bridge will use to route funds back to the customer when a transaction fails.\nReplaces the deprecated `return_address` field. Set one or the other, not both.\n\nFor memo-required chains (e.g. Stellar), both `address` and `memo` are required — without a memo, Bridge cannot\nroute the return to the correct end-customer at an omnibus wallet.\n","required":["address"],"properties":{"address":{"description":"The crypto wallet address to send returned funds to. Must be valid for the source payment rail's chain.","type":"string","isRequired":true,"uniqueKey":"return_instructions.address","typeLabel":"string"},"memo":{"description":"Memo to include with the return transaction. Required when the source payment rail is Stellar; optional for other memo-capable chains.","type":"string","uniqueKey":"return_instructions.memo","typeLabel":"string"}},"uniqueKey":"return_instructions","typeLabel":"object"},"custom_developer_fee_percent":{"oneOf":[{"description":"The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.","type":"string","format":"number","minimum":0,"maximum":100,"exclusiveMaximum":true,"example":"0.1","uniqueKey":"custom_developer_fee_percent.oneOf.0","typeLabel":"string\u003cnumber>"},{"description":"The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.","type":"null","format":"number","minimum":0,"maximum":100,"exclusiveMaximum":true,"example":"0.1","uniqueKey":"custom_developer_fee_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_developer_fee_percent","typeLabel":"string\u003cnumber> | null"},"travel_rule_data":{"type":"object","description":"Travel Rule data for this liquidation address. Use this only when the same originator or beneficiary should apply to every future movement through this liquidation address. If counterparties can vary by deposit or drain, submit the payload later with `POST /travel_rule_data/{id}` for the relevant movement.","example":{"originator":{"name":"Jane Smith","address":{"street_line_1":"123 Market St","street_line_2":null,"city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"},"identifying_information":{"type":"national_id","number":"1234567890","issuing_country":"USA"},"birth_date":"2000-01-31","place_of_birth":{"city":"San Francisco","country":"USA"},"wallet_type":"self_custodied","wallet_attested_ownership_at":"2026-04-01T12:00:00Z"},"beneficiary":{"is_self":true,"wallet_type":"external"}},"properties":{"originator":{"type":"object","description":"The party sending the crypto.","properties":{"is_self":{"type":"boolean","description":"Set to `true` when this party is the same person or business as the Bridge customer on the resource. When `true`, Bridge uses the customer's name and address on file instead of relying on `name` and `address` in this payload.","uniqueKey":"travel_rule_data.originator.is_self","typeLabel":"boolean"},"name":{"type":"string","description":"Legal name of the originator or beneficiary. Usually omitted when `is_self` is `true`.","uniqueKey":"travel_rule_data.originator.name","typeLabel":"string"},"address":{"type":"object","description":"Mailing or legal address of the originator. Usually omitted when `is_self` is `true`.","properties":{"street_line_1":{"type":"string","uniqueKey":"travel_rule_data.originator.address.street_line_1","typeLabel":"string"},"street_line_2":{"type":"string","uniqueKey":"travel_rule_data.originator.address.street_line_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"travel_rule_data.originator.address.city","typeLabel":"string"},"state":{"type":"string","description":"ISO 3166-2 subdivision code.","uniqueKey":"travel_rule_data.originator.address.state","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"travel_rule_data.originator.address.postal_code","typeLabel":"string"},"country":{"description":"Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.","type":"string","minLength":3,"maxLength":3,"uniqueKey":"travel_rule_data.originator.address.country","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.address","typeLabel":"object"},"wallet_type":{"type":"string","description":"Indicates the custody model for the wallet. Use `self_custodied` for customer-owned wallets (customer controls private keys), `hosted` for wallets managed by a developer or regulated entity on behalf of the customer, or `external` for wallets belonging to external exchanges or smart contracts.","enum":["hosted","external","self_custodied"],"uniqueKey":"travel_rule_data.originator.wallet_type","typeLabel":"enum\u003cstring>"},"wallet_attested_ownership_at":{"type":"string","format":"date-time","description":"Required when `wallet_type` is `self-custodied` or `hosted`. Must be a timestamp in the past indicating when wallet ownership was attested.","uniqueKey":"travel_rule_data.originator.wallet_attested_ownership_at","typeLabel":"string\u003cdate-time>"},"identifying_information":{"type":"array","items":{"type":"object","required":["issuing_country","type"],"properties":{"type":{"type":"string","description":"Tax identification number type or government-issued ID document type (see enum). Country-specific tax and national ID lists: [Individuals](https://apidocs.bridge.xyz/docs/individual-tax-identification-numbers-by-country), [Businesses](https://apidocs.bridge.xyz/docs/business-tax-identification-numbers-by-country).\n\n**EEA / BBSA (policy in `eea_requirements.rb`):** In-scope individuals and UBOs need **both** a valid national-ID-type entry and a valid TIN per [EEA updated requirements](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements). In-scope businesses need business registration **and** business tax ID types per country tables there. **TIN issuing country** must match residence (individuals) or incorporation (businesses). **Foreign tax** outside the incorporation country: set `has_foreign_tax_registration` on the business customer and add TIN objects per jurisdiction ([foreign tax / tax residency](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements#tax-residency-status-foreign-tax-registry)).\n","enum":["drivers_license","matriculate_id","military_id","national_id","passport","permanent_residency_id","state_or_provincial_id","visa","abn","acn","ahv","ak","aom","arbn","avs","bc","bce","bin","bir","bp","brn","bsn","bvn","cc","cdi","cedula_juridica","cf","cif","cin","cipc","cn","cnp","cnpj","cpf","cpr","crc","crib","crn","cro","cui","cuil","curp","cuit","cvr","edrpou","ein","embg","emirates_id","en","fin","fn","gstin","gui","hetu","hkid","hn","ic","ico","id","id_broj","idno","idnp","idnr","if","iin","ik","inn","ird","itin","itr","iva","jmbg","kbo","kvk","matricule","mf","mn","ms","mst","nic","nicn","nie","nif","nin","nino","nip","nipc","nipt","nit","npwp","nric","nrn","nrt","ntn","nuit","nzbn","oib","orgnr","other","pan","partita_iva","pesel","pib","pin","pk","ppsn","qid","rc","regon","rfc","ricn","rif","rn","rnc","rnokpp","rp","rrn","rtn","ruc","rut","si","sin","siren","siret","spi","ssm","ssn","steuer_id","strn","tckn","tfn","tin","tpin","trn","ucn","uen","uic","uid","usc","ust_idnr","utr","vat","vkn","voen","y_tunnus"],"isRequired":true,"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"issuing_country":{"type":"string","description":"The ISO 3166-1 (three-character) country code that issued the provided document.","isRequired":true,"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].issuing_country","typeLabel":"string"},"number":{"type":"string","description":"The unique identifier of the document. Required if this document is being used as a tax identification number (e.g., you are providing a passport or national_id with no other identification).","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].number","typeLabel":"string"},"description":{"type":"string","description":"A description describing the provided document. This field is required when `other` is selected.","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].description","typeLabel":"string"},"expiration":{"type":"string","description":"The expiration date of the given document in yyyy-mm-dd format.","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].expiration","typeLabel":"string"},"image_front":{"type":"string","description":"This field is optionally accepted for tax_id types, but required for government_id types. Base64 encoded image* of the front side of the provided document, following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents], with a minimum size of 200px x 200px\n\n*Maximum File Size: 15MB\n\n*Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif\n\n_Note: When combined with an `image_back`, the combined size of both images must not exceed 24MB._\n","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].image_front","typeLabel":"string"},"image_back":{"type":"string","description":"Base64 encoded image* of the back side of the provided document, following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents], with a minimum size of 200px x 200px\n\n*Maximum File Size: 15MB\n\n*Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif\n\n_Note: When combined with an `image_front`, the combined size of both images must not exceed 24MB._\n","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].image_back","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX]","typeLabel":"object"},"title":"Identification Information","description":"List of identification objects for the originator. Do **not** include `image_front` or `image_back` fields in this context; those are not accepted in Travel Rule submissions.\n","uniqueKey":"travel_rule_data.originator.identifying_information","typeLabel":"Identification Information · object[]"},"birth_date":{"type":"string","description":"Date of birth in format yyyy-mm-dd.","minLength":10,"maxLength":10,"uniqueKey":"travel_rule_data.originator.birth_date","typeLabel":"string"},"place_of_birth":{"type":"object","description":"Country (and optionally city) of birth. **EEA / BBSA in-scope customers:** supply when onboarding individuals or associated persons under the [EEA updated requirements](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements#country-of-birth-and-city-of-birth). This is a sparse address — no street address. At least `country` should be present when the object is sent; `city` is recommended and will be required by EU law in 2027.\n","properties":{"country":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 3166-1 alpha-3 country code for the place of birth.","uniqueKey":"travel_rule_data.originator.place_of_birth.country","typeLabel":"string"},"city":{"type":"string","minLength":1,"description":"City of birth (recommended for EEA).","uniqueKey":"travel_rule_data.originator.place_of_birth.city","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.place_of_birth","typeLabel":"object"},"legal_entity_identifier":{"type":"string","description":"The Legal Entity Identifier (LEI) or equivalent (e.g. VAT number) of the originator. Provide this when the originator is a legal entity rather than an individual.","uniqueKey":"travel_rule_data.originator.legal_entity_identifier","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator","typeLabel":"object"},"beneficiary":{"type":"object","description":"The party receiving the crypto.","properties":{"is_self":{"type":"boolean","description":"Set to `true` when this party is the same person or business as the Bridge customer on the resource. When `true`, Bridge uses the customer's name and address on file instead of relying on `name` and `address` in this payload.","uniqueKey":"travel_rule_data.beneficiary.is_self","typeLabel":"boolean"},"name":{"type":"string","description":"Legal name of the originator or beneficiary. Usually omitted when `is_self` is `true`.","uniqueKey":"travel_rule_data.beneficiary.name","typeLabel":"string"},"address":{"type":"object","description":"Mailing or legal address of the beneficiary. Usually omitted when `is_self` is `true`.","properties":{"street_line_1":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.street_line_1","typeLabel":"string"},"street_line_2":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.street_line_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.city","typeLabel":"string"},"state":{"type":"string","description":"ISO 3166-2 subdivision code.","uniqueKey":"travel_rule_data.beneficiary.address.state","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.postal_code","typeLabel":"string"},"country":{"description":"Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.","type":"string","minLength":3,"maxLength":3,"uniqueKey":"travel_rule_data.beneficiary.address.country","typeLabel":"string"}},"uniqueKey":"travel_rule_data.beneficiary.address","typeLabel":"object"},"wallet_type":{"type":"string","description":"Indicates the custody model for the wallet. Use `self_custodied` for customer-owned wallets (customer controls private keys), `hosted` for wallets managed by a developer or regulated entity on behalf of the customer, or `external` for wallets belonging to external exchanges or smart contracts.","enum":["hosted","external","self_custodied"],"uniqueKey":"travel_rule_data.beneficiary.wallet_type","typeLabel":"enum\u003cstring>"},"wallet_attested_ownership_at":{"type":"string","format":"date-time","description":"Required when `wallet_type` is `self-custodied` or `hosted`. Must be a timestamp in the past indicating when wallet ownership was attested.","uniqueKey":"travel_rule_data.beneficiary.wallet_attested_ownership_at","typeLabel":"string\u003cdate-time>"},"legal_entity_identifier":{"type":"string","description":"The Legal Entity Identifier (LEI) or equivalent (e.g. VAT number) of the beneficiary. Provide this when the beneficiary is a legal entity rather than an individual.","uniqueKey":"travel_rule_data.beneficiary.legal_entity_identifier","typeLabel":"string"}},"uniqueKey":"travel_rule_data.beneficiary","typeLabel":"object"}},"uniqueKey":"travel_rule_data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"external_account_id":"\u003cstring>","prefunded_account_id":"\u003cstring>","bridge_wallet_id":"\u003cstring>","destination_wire_message":"\u003cstring>","destination_sepa_reference":"\u003cstring>","destination_ach_reference":"\u003cstring>","destination_spei_reference":"\u003cstring>","destination_swift_reference":"\u003cstring>","destination_swift_details":{"instructed_currency":"sgd","purpose":"\u003cstring>","category_purpose_code":"\u003cstring>"},"destination_reference":"\u003cstring>","destination_address":"\u003cstring>","destination_blockchain_memo":"\u003cstring>","return_address":"\u003cstring>","custom_developer_fee_percent":"0.1","travel_rule_data":{"originator":{"name":"Jane Smith","address":{"street_line_1":"123 Market St","street_line_2":null,"city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"},"identifying_information":{"type":"national_id","number":"1234567890","issuing_country":"USA"},"birth_date":"2000-01-31","place_of_birth":{"city":"San Francisco","country":"USA"},"wallet_type":"self_custodied","wallet_attested_ownership_at":"2026-04-01T12:00:00Z"},"beneficiary":{"is_self":true,"wallet_type":"external"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a30aa220-ff4c-44de-9b88-c5c3dc43e12c":{"description":"Liquidation Address object created","content":{"application/json":{"schema":{"type":"object","required":["currency","chain","destination_payment_rail","destination_currency"],"properties":{"currency":{"type":"string","enum":["usdb","usdc","usdt","usdl_linea","pyusd","eurc","all_supported"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"chain":{"type":"string","enum":["arbitrum","avalanche_c_chain","base","celo","ethereum","linea","optimism","polygon","solana","stellar","tempo","tron","xdc","evm"],"isRequired":true,"uniqueKey":"chain","typeLabel":"enum\u003cstring>"},"destination_payment_rail":{"type":"string","description":"The payment rail that Bridge will use to send funds to the customer.","enum":["ach","wire","ach_push","ach_same_day","arbitrum","avalanche_c_chain","base","bre_b","co_bank_transfer","celo","ethereum","faster_payments","fiat_deposit_return","linea","optimism","pix","polygon","sepa","solana","spei","stellar","swift","tempo","tron","xdc"],"isRequired":true,"uniqueKey":"destination_payment_rail","typeLabel":"enum\u003cstring>"},"destination_currency":{"type":"string","description":"The currency that Bridge will use to send funds to the customer.","enum":["brl","cop","eur","eurc","gbp","mxn","ousd","path_usd","pyusd","usd","usdb","usdc","usdt","usdl_linea"],"isRequired":true,"uniqueKey":"destination_currency","typeLabel":"enum\u003cstring>"},"external_account_id":{"type":"string","description":"External bank account to which Bridge will send the funds.","maxLength":42,"minLength":1,"pattern":"[a-z0-9]*","uniqueKey":"external_account_id","typeLabel":"string"},"prefunded_account_id":{"type":"string","description":"The developer's prefunded account to which Bridge will send the funds.","maxLength":42,"minLength":1,"pattern":"[a-z0-9]*","uniqueKey":"prefunded_account_id","typeLabel":"string"},"bridge_wallet_id":{"description":"The Bridge Wallet to which Bridge will send the funds. The chain associated with the Bridge Wallet must match the payment rail.","type":"string","pattern":"[a-z0-9]*","minLength":1,"maxLength":42,"uniqueKey":"bridge_wallet_id","typeLabel":"string"},"destination_wire_message":{"type":"string","description":"A message to be sent with a wire transfer.","maxLength":256,"minLength":1,"uniqueKey":"destination_wire_message","typeLabel":"string"},"destination_sepa_reference":{"type":"string","description":"A reference message to be sent with a SEPA transaction.","maxLength":140,"minLength":6,"uniqueKey":"destination_sepa_reference","typeLabel":"string"},"destination_ach_reference":{"description":"A reference message to be sent with an ACH transaction. It can be at most 10 characters, A-Z, a-z, 0-9, and spaces.","type":"string","minLength":1,"maxLength":10,"uniqueKey":"destination_ach_reference","typeLabel":"string"},"destination_spei_reference":{"description":"A payment reference message or remittance information to be included in a SPEI transaction. The allowed characters are alphanumeric `a-z`, `A-Z`, `0-9`, and space","type":"string","minLength":1,"maxLength":40,"uniqueKey":"destination_spei_reference","typeLabel":"string"},"destination_swift_reference":{"description":"A payment reference message or remittance information to be included in a SWIFT transaction. It can have at most 4 lines (separated by \"\\n\"), each line with a max length of 35 chars. The allowed characters are `a-z`, `A-Z`, `0-9`, special characters (`/` `-` `?` `:` `(` `)` `.` `,` `'` `+`), and space","type":"string","minLength":1,"maxLength":140,"uniqueKey":"destination_swift_reference","typeLabel":"string"},"destination_charge_bearer":{"description":"Which party bears the charges for each SWIFT payout. Defaults to `sha` when not specified. Only accepted when `destination_payment_rail` is `swift`.","type":"string","enum":["our","sha","ben"],"uniqueKey":"destination_charge_bearer","typeLabel":"enum\u003cstring>"},"destination_swift_details":{"description":"Additional instructions to apply to each SWIFT payout. Only accepted when `destination_payment_rail` is `swift`.","properties":{"instructed_currency":{"description":"The currency in which the beneficiary is to be credited, as a lowercase three-letter ISO 4217 code. When omitted, no conversion is requested and the payout is sent in the destination currency of the transfer or liquidation address. The exchange rate is determined when the payout is processed. Unsupported currencies are rejected.","type":"string","minLength":3,"maxLength":3,"example":"sgd","uniqueKey":"destination_swift_details.instructed_currency","typeLabel":"string"},"purpose":{"description":"The purpose of the payment, in the form the destination country requires: a local purpose code or a short free-text description. Required when `instructed_currency` is a currency other than `aud`, `cad`, `fjd`, or `usd`. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"destination_swift_details.purpose","typeLabel":"string"},"category_purpose_code":{"description":"The category purpose code that indicates how banks should process the payment, for destination countries that use one. Accepts an ISO 20022 category purpose code (e.g. `SALA`, case-insensitive) or a code from the destination country's own list. At most 35 characters. Allowed characters are `a-z`, `A-Z`, `0-9`, space, and `/ - ? : ( ) . , ' +`.","type":"string","minLength":1,"maxLength":35,"uniqueKey":"destination_swift_details.category_purpose_code","typeLabel":"string"}},"type":"object","uniqueKey":"destination_swift_details","typeLabel":"object"},"destination_reference":{"description":"A payment reference message for newer payment rails (e.g. Pix, Faster Payments, and FedNow).","type":"string","uniqueKey":"destination_reference","typeLabel":"string"},"destination_address":{"type":"string","description":"The crypto wallet address that Bridge will use to send funds to the customer.","uniqueKey":"destination_address","typeLabel":"string"},"destination_blockchain_memo":{"description":"The memo to include in the transaction, for blockchains that support memos only","type":"string","uniqueKey":"destination_blockchain_memo","typeLabel":"string"},"return_address":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated: use `return_instructions` instead.\n\nThe crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction.\nMust be on the same chain as the liquidation address.\nCannot be used on Stellar — use `return_instructions` with a `memo` instead.\n","uniqueKey":"return_address.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated: use `return_instructions` instead.\n\nThe crypto wallet address that Bridge will use to return funds to the customer in case of a failed transaction.\nMust be on the same chain as the liquidation address.\nCannot be used on Stellar — use `return_instructions` with a `memo` instead.\n","uniqueKey":"return_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_address","typeLabel":"string | null"},"return_instructions":{"type":"object","description":"The return instructions Bridge will use to route funds back to the customer when a transaction fails.\nReplaces the deprecated `return_address` field. Set one or the other, not both.\n\nFor memo-required chains (e.g. Stellar), both `address` and `memo` are required — without a memo, Bridge cannot\nroute the return to the correct end-customer at an omnibus wallet.\n","required":["address"],"properties":{"address":{"description":"The crypto wallet address to send returned funds to. Must be valid for the source payment rail's chain.","type":"string","isRequired":true,"uniqueKey":"return_instructions.address","typeLabel":"string"},"memo":{"description":"Memo to include with the return transaction. Required when the source payment rail is Stellar; optional for other memo-capable chains.","type":"string","uniqueKey":"return_instructions.memo","typeLabel":"string"}},"uniqueKey":"return_instructions","typeLabel":"object"},"custom_developer_fee_percent":{"oneOf":[{"type":"string","description":"The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.","format":"number","maximum":100,"minimum":0,"example":"0.1","exclusiveMaximum":true,"uniqueKey":"custom_developer_fee_percent.oneOf.0","typeLabel":"string\u003cnumber>"},{"type":"null","description":"The developer fee percent that will be applied to this Liquidation Address or null to use the default fee. The value is a base 100 percentage, i.e. 10.2% is 10.2 in the API.","format":"number","maximum":100,"minimum":0,"example":"0.1","exclusiveMaximum":true,"uniqueKey":"custom_developer_fee_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_developer_fee_percent","typeLabel":"string\u003cnumber> | null"},"travel_rule_data":{"type":"object","description":"Travel Rule data for this liquidation address. Use this only when the same originator or beneficiary should apply to every future movement through this liquidation address. If counterparties can vary by deposit or drain, submit the payload later with `POST /travel_rule_data/{id}` for the relevant movement.","example":{"originator":{"name":"Jane Smith","address":{"street_line_1":"123 Market St","street_line_2":null,"city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"},"identifying_information":{"type":"national_id","number":"1234567890","issuing_country":"USA"},"birth_date":"2000-01-31","place_of_birth":{"city":"San Francisco","country":"USA"},"wallet_type":"self_custodied","wallet_attested_ownership_at":"2026-04-01T12:00:00Z"},"beneficiary":{"is_self":true,"wallet_type":"external"}},"properties":{"originator":{"type":"object","description":"The party sending the crypto.","properties":{"is_self":{"type":"boolean","description":"Set to `true` when this party is the same person or business as the Bridge customer on the resource. When `true`, Bridge uses the customer's name and address on file instead of relying on `name` and `address` in this payload.","uniqueKey":"travel_rule_data.originator.is_self","typeLabel":"boolean"},"name":{"type":"string","description":"Legal name of the originator or beneficiary. Usually omitted when `is_self` is `true`.","uniqueKey":"travel_rule_data.originator.name","typeLabel":"string"},"address":{"type":"object","description":"Mailing or legal address of the originator. Usually omitted when `is_self` is `true`.","properties":{"street_line_1":{"type":"string","uniqueKey":"travel_rule_data.originator.address.street_line_1","typeLabel":"string"},"street_line_2":{"type":"string","uniqueKey":"travel_rule_data.originator.address.street_line_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"travel_rule_data.originator.address.city","typeLabel":"string"},"state":{"type":"string","description":"ISO 3166-2 subdivision code.","uniqueKey":"travel_rule_data.originator.address.state","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"travel_rule_data.originator.address.postal_code","typeLabel":"string"},"country":{"description":"Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.","type":"string","minLength":3,"maxLength":3,"uniqueKey":"travel_rule_data.originator.address.country","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.address","typeLabel":"object"},"wallet_type":{"type":"string","description":"Indicates the custody model for the wallet. Use `self_custodied` for customer-owned wallets (customer controls private keys), `hosted` for wallets managed by a developer or regulated entity on behalf of the customer, or `external` for wallets belonging to external exchanges or smart contracts.","enum":["hosted","external","self_custodied"],"uniqueKey":"travel_rule_data.originator.wallet_type","typeLabel":"enum\u003cstring>"},"wallet_attested_ownership_at":{"type":"string","format":"date-time","description":"Required when `wallet_type` is `self-custodied` or `hosted`. Must be a timestamp in the past indicating when wallet ownership was attested.","uniqueKey":"travel_rule_data.originator.wallet_attested_ownership_at","typeLabel":"string\u003cdate-time>"},"identifying_information":{"type":"array","items":{"type":"object","required":["issuing_country","type"],"properties":{"type":{"type":"string","description":"Tax identification number type or government-issued ID document type (see enum). Country-specific tax and national ID lists: [Individuals](https://apidocs.bridge.xyz/docs/individual-tax-identification-numbers-by-country), [Businesses](https://apidocs.bridge.xyz/docs/business-tax-identification-numbers-by-country).\n\n**EEA / BBSA (policy in `eea_requirements.rb`):** In-scope individuals and UBOs need **both** a valid national-ID-type entry and a valid TIN per [EEA updated requirements](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements). In-scope businesses need business registration **and** business tax ID types per country tables there. **TIN issuing country** must match residence (individuals) or incorporation (businesses). **Foreign tax** outside the incorporation country: set `has_foreign_tax_registration` on the business customer and add TIN objects per jurisdiction ([foreign tax / tax residency](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements#tax-residency-status-foreign-tax-registry)).\n","enum":["drivers_license","matriculate_id","military_id","national_id","passport","permanent_residency_id","state_or_provincial_id","visa","abn","acn","ahv","ak","aom","arbn","avs","bc","bce","bin","bir","bp","brn","bsn","bvn","cc","cdi","cedula_juridica","cf","cif","cin","cipc","cn","cnp","cnpj","cpf","cpr","crc","crib","crn","cro","cui","cuil","curp","cuit","cvr","edrpou","ein","embg","emirates_id","en","fin","fn","gstin","gui","hetu","hkid","hn","ic","ico","id","id_broj","idno","idnp","idnr","if","iin","ik","inn","ird","itin","itr","iva","jmbg","kbo","kvk","matricule","mf","mn","ms","mst","nic","nicn","nie","nif","nin","nino","nip","nipc","nipt","nit","npwp","nric","nrn","nrt","ntn","nuit","nzbn","oib","orgnr","other","pan","partita_iva","pesel","pib","pin","pk","ppsn","qid","rc","regon","rfc","ricn","rif","rn","rnc","rnokpp","rp","rrn","rtn","ruc","rut","si","sin","siren","siret","spi","ssm","ssn","steuer_id","strn","tckn","tfn","tin","tpin","trn","ucn","uen","uic","uid","usc","ust_idnr","utr","vat","vkn","voen","y_tunnus"],"isRequired":true,"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"issuing_country":{"type":"string","description":"The ISO 3166-1 (three-character) country code that issued the provided document.","isRequired":true,"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].issuing_country","typeLabel":"string"},"number":{"type":"string","description":"The unique identifier of the document. Required if this document is being used as a tax identification number (e.g., you are providing a passport or national_id with no other identification).","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].number","typeLabel":"string"},"description":{"type":"string","description":"A description describing the provided document. This field is required when `other` is selected.","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].description","typeLabel":"string"},"expiration":{"type":"string","description":"The expiration date of the given document in yyyy-mm-dd format.","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].expiration","typeLabel":"string"},"image_front":{"type":"string","description":"This field is optionally accepted for tax_id types, but required for government_id types. Base64 encoded image* of the front side of the provided document, following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents], with a minimum size of 200px x 200px\n\n*Maximum File Size: 15MB\n\n*Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif\n\n_Note: When combined with an `image_back`, the combined size of both images must not exceed 24MB._\n","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].image_front","typeLabel":"string"},"image_back":{"type":"string","description":"Base64 encoded image* of the back side of the provided document, following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents], with a minimum size of 200px x 200px\n\n*Maximum File Size: 15MB\n\n*Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif\n\n_Note: When combined with an `image_front`, the combined size of both images must not exceed 24MB._\n","uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX].image_back","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.identifying_information.items.[INDEX]","typeLabel":"object"},"title":"Identification Information","description":"List of identification objects for the originator. Do **not** include `image_front` or `image_back` fields in this context; those are not accepted in Travel Rule submissions.\n","uniqueKey":"travel_rule_data.originator.identifying_information","typeLabel":"Identification Information · object[]"},"birth_date":{"type":"string","description":"Date of birth in format yyyy-mm-dd.","minLength":10,"maxLength":10,"uniqueKey":"travel_rule_data.originator.birth_date","typeLabel":"string"},"place_of_birth":{"type":"object","description":"Country (and optionally city) of birth. **EEA / BBSA in-scope customers:** supply when onboarding individuals or associated persons under the [EEA updated requirements](https://apidocs.bridge.xyz/platform/customers/customers/eea-updated-requirements#country-of-birth-and-city-of-birth). This is a sparse address — no street address. At least `country` should be present when the object is sent; `city` is recommended and will be required by EU law in 2027.\n","properties":{"country":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 3166-1 alpha-3 country code for the place of birth.","uniqueKey":"travel_rule_data.originator.place_of_birth.country","typeLabel":"string"},"city":{"type":"string","minLength":1,"description":"City of birth (recommended for EEA).","uniqueKey":"travel_rule_data.originator.place_of_birth.city","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator.place_of_birth","typeLabel":"object"},"legal_entity_identifier":{"type":"string","description":"The Legal Entity Identifier (LEI) or equivalent (e.g. VAT number) of the originator. Provide this when the originator is a legal entity rather than an individual.","uniqueKey":"travel_rule_data.originator.legal_entity_identifier","typeLabel":"string"}},"uniqueKey":"travel_rule_data.originator","typeLabel":"object"},"beneficiary":{"type":"object","description":"The party receiving the crypto.","properties":{"is_self":{"type":"boolean","description":"Set to `true` when this party is the same person or business as the Bridge customer on the resource. When `true`, Bridge uses the customer's name and address on file instead of relying on `name` and `address` in this payload.","uniqueKey":"travel_rule_data.beneficiary.is_self","typeLabel":"boolean"},"name":{"type":"string","description":"Legal name of the originator or beneficiary. Usually omitted when `is_self` is `true`.","uniqueKey":"travel_rule_data.beneficiary.name","typeLabel":"string"},"address":{"type":"object","description":"Mailing or legal address of the beneficiary. Usually omitted when `is_self` is `true`.","properties":{"street_line_1":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.street_line_1","typeLabel":"string"},"street_line_2":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.street_line_2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.city","typeLabel":"string"},"state":{"type":"string","description":"ISO 3166-2 subdivision code.","uniqueKey":"travel_rule_data.beneficiary.address.state","typeLabel":"string"},"postal_code":{"type":"string","uniqueKey":"travel_rule_data.beneficiary.address.postal_code","typeLabel":"string"},"country":{"description":"Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.","type":"string","minLength":3,"maxLength":3,"uniqueKey":"travel_rule_data.beneficiary.address.country","typeLabel":"string"}},"uniqueKey":"travel_rule_data.beneficiary.address","typeLabel":"object"},"wallet_type":{"type":"string","description":"Indicates the custody model for the wallet. Use `self_custodied` for customer-owned wallets (customer controls private keys), `hosted` for wallets managed by a developer or regulated entity on behalf of the customer, or `external` for wallets belonging to external exchanges or smart contracts.","enum":["hosted","external","self_custodied"],"uniqueKey":"travel_rule_data.beneficiary.wallet_type","typeLabel":"enum\u003cstring>"},"wallet_attested_ownership_at":{"type":"string","format":"date-time","description":"Required when `wallet_type` is `self-custodied` or `hosted`. Must be a timestamp in the past indicating when wallet ownership was attested.","uniqueKey":"travel_rule_data.beneficiary.wallet_attested_ownership_at","typeLabel":"string\u003cdate-time>"},"legal_entity_identifier":{"type":"string","description":"The Legal Entity Identifier (LEI) or equivalent (e.g. VAT number) of the beneficiary. Provide this when the beneficiary is a legal entity rather than an individual.","uniqueKey":"travel_rule_data.beneficiary.legal_entity_identifier","typeLabel":"string"}},"uniqueKey":"travel_rule_data.beneficiary","typeLabel":"object"}},"uniqueKey":"travel_rule_data","typeLabel":"object"},"address":{"type":"string","description":"The blockchain address the customer will send funds to.","uniqueKey":"address","typeLabel":"string"},"memoless_address":{"description":"An alternative crypto wallet address that encodes the memo, allowing the customer to send funds without needing to include a separate memo. Currently only available for Stellar deposits.","type":"string","uniqueKey":"memoless_address","typeLabel":"string"},"state":{"type":"string","description":"The state of the liquidation address. It could be \"active\" or \"deactivated\"","uniqueKey":"state","typeLabel":"string"},"return_memo":{"oneOf":[{"type":"string","description":"The memo included with return transactions. Present when `return_instructions` was set with a memo (e.g. required for Stellar to route funds to the correct end-customer).","uniqueKey":"return_memo.oneOf.0","typeLabel":"string"},{"type":"null","description":"The memo included with return transactions. Present when `return_instructions` was set with a memo (e.g. required for Stellar to route funds to the correct end-customer).","uniqueKey":"return_memo.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_memo","typeLabel":"string | null"},"supported_currencies":{"description":"The currencies this Liquidation Address accepts on each chain. Keys are `LiquidationAddressSourceChain` values (e.g. `ethereum`, `polygon`, `base`). For a single-chain, single-currency address this is just that one chain and currency; for a multi-chain (`chain` is `evm`) or multi-currency (`currency` is `all_supported`) address it lists every currency actually accepted on each chain.\n","type":"object","readOnly":true,"additionalProperties":{"type":"array","items":{"type":"string","enum":["usdb","usdc","usdt","usdl_linea","pyusd","eurc"],"uniqueKey":"supported_currencies.additionalProperties.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"supported_currencies.additionalProperties","typeLabel":"enum\u003cstring>[]"},"example":{"ethereum":["usdc","eurc"],"polygon":["usdc"]},"uniqueKey":"supported_currencies","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"SuccessfulLiquidationAddressCreateResponse":{"title":"SuccessfulLiquidationAddressCreateResponse","summary":"A successful Liquidation Address creation response","value":{"id":"la_123","chain":"ethereum","customer_id":"cust_123","external_account_id":"ext_123","address":"0x4d0280da2f2fDA5103914bCc5aad114743152A9c","currency":"usdc","supported_currencies":{"ethereum":["usdc"]},"state":"active","created_at":"2023-11-22T21:31:30.515Z","updated_at":"2023-11-22T21:31:30.515Z"}},"SuccessfulSepaLiquidationAddressCreateResponse":{"title":"SuccessfulSepaLiquidationAddressCreateResponse","summary":"A creation response using SEPA as the destination rail","value":{"id":"la_123","chain":"ethereum","customer_id":"cust_123","external_account_id":"ext_123","address":"0x4d0280da2f2fDA5103914bCc5aad114743152A9c","currency":"usdc","destination_sepa_reference":"SEPA reference","destination_payment_rail":"sepa","destination_currency":"eur","supported_currencies":{"ethereum":["usdc"]},"state":"active","created_at":"2023-11-22T21:31:30.515Z","updated_at":"2023-11-22T21:31:30.515Z"}},"SuccessfulMultiChainLiquidationAddressCreateResponse":{"title":"SuccessfulMultiChainLiquidationAddressCreateResponse","summary":"A creation response for a multi-chain, multi-currency Liquidation Address","value":{"id":"la_123","chain":"evm","customer_id":"cust_123","external_account_id":"ext_123","address":"0x4d0280da2f2fDA5103914bCc5aad114743152A9c","currency":"all_supported","supported_currencies":{"ethereum":["usdc","eurc"],"polygon":["usdc"],"base":["usdc","eurc"]},"state":"active","created_at":"2023-11-22T21:31:30.515Z","updated_at":"2023-11-22T21:31:30.515Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"98f214fa-eb0a-4524-8a1b-0644052bb76f":{"description":"Request containing missing or invalid parameters.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"BadCustomerRequestErrorExample":{"title":"BadCustomerRequestErrorExample","summary":"Bad customer request","value":{"code":"bad_customer_request","message":"fields missing from customer body.","name":"first_name,ssn"}}},"exampleType":"examples"}},"exampleType":"examples"},"b0b6dbfd-fb92-449f-a823-3f358fd3c545":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"MissingTokenError":{"title":"MissingTokenError","summary":"No Api-Key header","description":"The header may be missing or misspelled.","value":{"code":"required","location":"header","name":"Api-Key","message":"Missing Api-Key header"}},"InvalidTokenError":{"title":"InvalidTokenError","summary":"Invalid key in Api-Key header","value":{"code":"invalid","location":"header","name":"Api-Key","message":"Invalid Api-Key header"}}},"exampleType":"examples"}},"exampleType":"examples"},"2e3048c8-79e8-44f8-9a73-cd62af8765ae":{"description":"Unexpected error. User may try and send the request again.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"string","minLength":1,"maxLength":256,"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"source":{"title":"ErrorSource","required":["location","key"],"properties":{"location":{"type":"string","enum":["path","query","body","header"],"isRequired":true,"uniqueKey":"source.location","typeLabel":"enum\u003cstring>"},"key":{"type":"string","description":"Comma separated names of the properties or parameters causing the error","isRequired":true,"uniqueKey":"source.key","typeLabel":"string"}},"type":"object","uniqueKey":"source","typeLabel":"ErrorSource · object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"UnexpectedError":{"title":"UnexpectedError","summary":"An unexpected error","value":{"errors":[{"code":"unexpected","message":"An expected error occurred, you may try again later"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ab600454-21be-4dfb-bb8b-e5b838e20b79":{"ApiKey":{"type":"apiKey","name":"Api-Key","in":"header","scopes":[],"schemeName":"ApiKey"}}},"servers":{"8cfd91ab-6780-4f17-8205-744d686f1bbb":{"url":"https://api.bridge.xyz/v0","description":"The base path for all resources"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Api-Key","in":"header","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"Api-Key"}],"title":"ApiKey"}]},"originalFileLocation":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json"},"subdomain":"bridge-727305d3","siteName":"Bridge","title":"Create a Liquidation Address - Bridge","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T23:37:06.568Z","originalFileLocation":"api-reference/liquidation-addresses/create-a-liquidation-address.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Bridge\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a Liquidation Address - Bridge\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bridge\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bridge-727305d3.mintlify.site/_mintlify/api/og/v2?division=Liquidation+Addresses\u0026amp;title=Create+a+Liquidation+Address\u0026amp;theme=7314417c372cd97a946fceed\u0026amp;signature=304a6258bd356d6ba210fffa15d723838e37d59fcbf26ee50129925d78a5ade6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a Liquidation Address - Bridge\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bridge-727305d3.mintlify.site/_mintlify/api/og/v2?division=Liquidation+Addresses\u0026amp;title=Create+a+Liquidation+Address\u0026amp;theme=7314417c372cd97a946fceed\u0026amp;signature=304a6258bd356d6ba210fffa15d723838e37d59fcbf26ee50129925d78a5ade6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/bridge-727305d3/mooRrVahPwlqVkg3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bridge\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#047857\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/liquidation-addresses/create-a-liquidation-address.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.bridge.xyz/#organization\",\"name\":\"Bridge\",\"url\":\"https://apidocs.bridge.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bridge-727305d3/Zr0t-7SjjubLpKla/logo/bridge-logo-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=Zr0t-7SjjubLpKla\u0026q=85\u0026s=c91d77ec31a41686da7d32d0c999b34a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.bridge.xyz#website\",\"name\":\"Bridge\",\"url\":\"https://apidocs.bridge.xyz\",\"publisher\":{\"@id\":\"https://apidocs.bridge.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#webpage\",\"url\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address\",\"name\":\"Create a Liquidation Address\",\"dateModified\":\"2026-11-13T23:37:06.568Z\",\"isPartOf\":{\"@id\":\"https://apidocs.bridge.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://apidocs.bridge.xyz/api-reference/bridge-wallets/get-all-bridge-wallets\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Liquidation Addresses\",\"item\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a Liquidation Address\",\"item\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#apireference\",\"headline\":\"Create a Liquidation Address\",\"name\":\"Create a Liquidation Address\",\"url\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.bridge.xyz/api-reference/liquidation-addresses/create-a-liquidation-address#webpage\"},\"dateModified\":\"2026-11-13T23:37:06.568Z\",\"publisher\":{\"@id\":\"https://apidocs.bridge.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.bridge.xyz#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/liquidation-addresses/create-a-liquidation-address.md","siteName":"Bridge","nav":{"global":null,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Get Started","icon":"play","pages":[{"title":"Get Started","href":"/get-started/introduction/overview"}]},{"tab":"Developer Platform","icon":"layer-group","pages":[{"title":"Developer Platform","href":"/platform/orchestration/overview"}]},{"tab":"API reference","icon":"brackets-curly","pages":[{"title":"Authentication","mode":"wide","href":"/api-reference/introduction/introduction"},{"title":"Idempotency","mode":"wide","href":"/api-reference/introduction/idempotence"},{"title":"Deprecation","mode":"wide","href":"/api-reference/introduction/deprecation"},{"title":"Postman collection","mode":"wide","href":"/api-reference/introduction/postman"},{"title":"Bridge API Pagination Guide","href":"/api-reference/pagination"},{"group":"Endpoints","pages":[{"group":"Bridge Wallets","pages":[{"title":"Get all Bridge Wallets","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets","href":"/api-reference/bridge-wallets/get-all-bridge-wallets"},{"title":"Get total balances of all Bridge Wallets","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets/total_balances","href":"/api-reference/bridge-wallets/get-total-balances-of-all-bridge-wallets"},{"title":"Get a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets/{bridgeWalletID}","href":"/api-reference/bridge-wallets/get-a-bridge-wallet"},{"title":"Get transaction history for a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /wallets/{bridgeWalletID}/history","href":"/api-reference/bridge-wallets/get-transaction-history-for-a-bridge-wallet"},{"title":"Get all Bridge Wallets for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/wallets","href":"/api-reference/bridge-wallets/get-all-bridge-wallets-for-a-customer"},{"title":"Create a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/wallets","href":"/api-reference/bridge-wallets/create-a-bridge-wallet"},{"title":"Get a Bridge Wallet","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/wallets/{bridgeWalletID}","href":"/api-reference/bridge-wallets/get-a-bridge-wallet-1"}]},{"group":"Customers","pages":[{"title":"Get all customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers","href":"/api-reference/customers/get-all-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers","href":"/api-reference/customers/create-a-customer"},{"title":"Get a single customer object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}","href":"/api-reference/customers/get-a-single-customer-object"},{"title":"Update a single customer object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}","href":"/api-reference/customers/update-a-single-customer-object"},{"title":"Delete a single customer object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /customers/{customerID}","href":"/api-reference/customers/delete-a-single-customer-object"},{"title":"Get associated persons for a business customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/associated_persons","href":"/api-reference/customers/get-associated-persons-for-a-business-customer"},{"title":"Create a new associated person for a business customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/associated_persons","href":"/api-reference/customers/create-a-new-associated-person-for-a-business-customer"},{"title":"Get a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/associated_persons/{associatedPersonID}","href":"/api-reference/customers/get-a-single-associated-person"},{"title":"Update a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/associated_persons/{associatedPersonID}","href":"/api-reference/customers/update-a-single-associated-person"},{"title":"Delete a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /customers/{customerID}/associated_persons/{associatedPersonID}","href":"/api-reference/customers/delete-a-single-associated-person"},{"title":"Retrieve a hosted URL for ToS acceptance for an existing customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/tos_acceptance_link","href":"/api-reference/customers/retrieve-a-hosted-url-for-tos-acceptance-for-an-existing-customer"},{"title":"Retrieve a hosted KYC Link for an existing customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/kyc_link","href":"/api-reference/customers/retrieve-a-hosted-kyc-link-for-an-existing-customer"},{"title":"Get all transfers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/transfers","href":"/api-reference/customers/get-all-transfers"},{"title":"Get all static templates for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/transfers/static_templates","href":"/api-reference/customers/get-all-static-templates-for-a-customer"},{"title":"Request a hosted URL for ToS acceptance for new customer creation","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/tos_links","href":"/api-reference/customers/request-a-hosted-url-for-tos-acceptance-for-new-customer-creation"}]},{"group":"External Accounts","pages":[{"title":"Get all External Accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/external_accounts","href":"/api-reference/external-accounts/get-all-external-accounts"},{"title":"Create a new External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts","href":"/api-reference/external-accounts/create-a-new-external-account"},{"title":"Retrieve an External Account object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/external_accounts/{externalAccountID}","href":"/api-reference/external-accounts/retrieve-an-external-account-object"},{"title":"Update an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/external_accounts/{externalAccountID}","href":"/api-reference/external-accounts/update-an-external-account"},{"title":"Delete a single External Account object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /customers/{customerID}/external_accounts/{externalAccountID}","href":"/api-reference/external-accounts/delete-a-single-external-account-object"},{"title":"Deactivate an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts/{externalAccountID}/deactivate","href":"/api-reference/external-accounts/deactivate-an-external-account"},{"title":"Verify an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts/{externalAccountID}/verify","href":"/api-reference/external-accounts/verify-an-external-account"},{"title":"Reactivate an External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/external_accounts/{externalAccountID}/reactivate","href":"/api-reference/external-accounts/reactivate-an-external-account"},{"title":"Get all External Accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /external_accounts","href":"/api-reference/external-accounts/get-all-external-accounts-1"}]},{"group":"Fiat Payout Configuration","pages":[{"title":"Get the fiat payout configuration for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/fiat_payout_configuration","href":"/api-reference/fiat-payout-configuration/get-the-fiat-payout-configuration-for-a-customer"},{"title":"Update the fiat payout configuration for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json patch /customers/{customerID}/fiat_payout_configuration","href":"/api-reference/fiat-payout-configuration/update-the-fiat-payout-configuration-for-a-customer"}]},{"group":"Plaid","pages":[{"title":"Generate a Plaid Link token for a customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/plaid_link_requests","href":"/api-reference/plaid/generate-a-plaid-link-token-for-a-customer"},{"title":"Exchange Plaid public token for an access token","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /plaid_exchange_public_token/{link_token}","href":"/api-reference/plaid/exchange-plaid-public-token-for-an-access-token"}]},{"group":"Transfers","pages":[{"title":"Get all transfers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers","href":"/api-reference/transfers/get-all-transfers"},{"title":"Create a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /transfers","href":"/api-reference/transfers/create-a-transfer"},{"title":"List transfers with pending USDT trades","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers/pending","href":"/api-reference/transfers/list-transfers-with-pending-usdt-trades"},{"title":"Get a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers/{transferID}","href":"/api-reference/transfers/get-a-transfer"},{"title":"Update a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /transfers/{transferID}","href":"/api-reference/transfers/update-a-transfer"},{"title":"Delete a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /transfers/{transferID}","href":"/api-reference/transfers/delete-a-transfer"},{"title":"Execute a pending USDT trade on a transfer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /transfers/{transferID}/execute","href":"/api-reference/transfers/execute-a-pending-usdt-trade-on-a-transfer"},{"title":"Get all static templates","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /transfers/static_templates","href":"/api-reference/transfers/get-all-static-templates"}]},{"group":"Prefunded Accounts","pages":[{"title":"Get a list of all Prefunded Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /prefunded_accounts","href":"/api-reference/prefunded-accounts/get-a-list-of-all-prefunded-account"},{"title":"Get details for a specific Prefunded Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /prefunded_accounts/{prefundedAccountID}","href":"/api-reference/prefunded-accounts/get-details-for-a-specific-prefunded-account"},{"title":"Get funding history of a Prefunded Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /prefunded_accounts/{prefundedAccountID}/history","href":"/api-reference/prefunded-accounts/get-funding-history-of-a-prefunded-account"}]},{"group":"Liquidation Addresses","pages":[{"title":"Get all Liquidation Addresses for a customer","description":"Get Liquidation Addresses","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses","href":"/api-reference/liquidation-addresses/get-all-liquidation-addresses-for-a-customer"},{"title":"Create a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/liquidation_addresses","href":"/api-reference/liquidation-addresses/create-a-liquidation-address"},{"title":"Get all Liquidation Addresses","description":"Get Liquidation Addresses","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /liquidation_addresses","href":"/api-reference/liquidation-addresses/get-all-liquidation-addresses"},{"title":"Get a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses/{liquidationAddressID}","href":"/api-reference/liquidation-addresses/get-a-liquidation-address"},{"title":"Update a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/liquidation_addresses/{liquidationAddressID}","href":"/api-reference/liquidation-addresses/update-a-liquidation-address"},{"title":"Get drain history of a Liquidation Address","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains","href":"/api-reference/liquidation-addresses/get-drain-history-of-a-liquidation-address"},{"title":"Execute a pending USDT trade on a drain","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/drains/{drainID}/execute","href":"/api-reference/liquidation-addresses/execute-a-pending-usdt-trade-on-a-drain"},{"title":"Get the balance of a Liquidation Address (deprecated)","deprecated":true,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/liquidation_addresses/{liquidationAddressID}/balances","href":"/api-reference/liquidation-addresses/get-the-balance-of-a-liquidation-address-deprecated"},{"title":"Liquidation Address Activity Across All Customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /liquidation_addresses/drains","href":"/api-reference/liquidation-addresses/liquidation-address-activity-across-all-customers"},{"title":"List drains with pending USDT trades","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /liquidation_addresses/drains/pending","href":"/api-reference/liquidation-addresses/list-drains-with-pending-usdt-trades"}]},{"group":"Virtual Accounts","pages":[{"title":"List Virtual Accounts by Customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/virtual_accounts","href":"/api-reference/virtual-accounts/list-virtual-accounts-by-customer"},{"title":"Create a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/virtual_accounts","href":"/api-reference/virtual-accounts/create-a-virtual-account"},{"title":"Get a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/virtual_accounts/{virtualAccountID}","href":"/api-reference/virtual-accounts/get-a-virtual-account"},{"title":"Update a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/virtual_accounts/{virtualAccountID}","href":"/api-reference/virtual-accounts/update-a-virtual-account"},{"title":"Deactivate a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/virtual_accounts/{virtualAccountID}/deactivate","href":"/api-reference/virtual-accounts/deactivate-a-virtual-account"},{"title":"Reactivate a Virtual Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/virtual_accounts/{virtualAccountID}/reactivate","href":"/api-reference/virtual-accounts/reactivate-a-virtual-account"},{"title":"Virtual Account Activity","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/virtual_accounts/{virtualAccountID}/history","href":"/api-reference/virtual-accounts/virtual-account-activity"},{"title":"List Virtual Accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /virtual_accounts","href":"/api-reference/virtual-accounts/list-virtual-accounts"},{"title":"Virtual Account Activity Across All Customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /virtual_accounts/history","href":"/api-reference/virtual-accounts/virtual-account-activity-across-all-customers"}]},{"group":"Static Memos","pages":[{"title":"List Static Memos","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /static_memos","href":"/api-reference/static-memos/list-static-memos"},{"title":"List Static Memos for Customer","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/static_memos","href":"/api-reference/static-memos/list-static-memos-for-customer"},{"title":"Create a Static Memo","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/static_memos","href":"/api-reference/static-memos/create-a-static-memo"},{"title":"Get a Static Memo","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/static_memos/{staticMemoID}","href":"/api-reference/static-memos/get-a-static-memo"},{"title":"Update a Static Memo","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/static_memos/{staticMemoID}","href":"/api-reference/static-memos/update-a-static-memo"},{"title":"Static Memo Activity","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/static_memos/{staticMemoID}/history","href":"/api-reference/static-memos/static-memo-activity"},{"title":"Static Memo Activity Across All Customers","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /static_memos/history","href":"/api-reference/static-memos/static-memo-activity-across-all-customers"}]},{"group":"Cards","pages":[{"title":"Create Card PIN Update URL","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/pin","href":"/api-reference/cards/create-card-pin-update-url"},{"title":"Generate an Ephemeral Key to Reveal Card Details","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/ephemeral_keys","href":"/api-reference/cards/generate-an-ephemeral-key-to-reveal-card-details"},{"title":"Get a summary of your card program","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/cards/summary","href":"/api-reference/cards/get-a-summary-of-your-card-program"},{"title":"Get a listing of your card program's card designs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/cards/designs","href":"/api-reference/cards/get-a-listing-of-your-card-programs-card-designs"},{"title":"Retrieve a card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}","href":"/api-reference/cards/retrieve-a-card-account"},{"title":"Update a card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /customers/{customerID}/card_accounts/{cardAccountID}","href":"/api-reference/cards/update-a-card-account"},{"title":"Get all card accounts","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts","href":"/api-reference/cards/get-all-card-accounts"},{"title":"Provision a card account","deprecated":true,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts","href":"/api-reference/cards/provision-a-card-account"},{"title":"Place a freeze on the card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/freeze","href":"/api-reference/cards/place-a-freeze-on-the-card-account"},{"title":"Unfreeze the card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/unfreeze","href":"/api-reference/cards/unfreeze-the-card-account"},{"title":"Create a mobile wallet push provisioning request","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/create_mobile_wallet_provisioning_request","href":"/api-reference/cards/create-a-mobile-wallet-push-provisioning-request"},{"title":"Retrieve pending card authorizations","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/authorizations","href":"/api-reference/cards/retrieve-pending-card-authorizations"},{"title":"Retrieve card transactions","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/transactions","href":"/api-reference/cards/retrieve-card-transactions"},{"title":"Retrieve a card transaction","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/transactions/{transactionID}","href":"/api-reference/cards/retrieve-a-card-transaction"},{"title":"Retrieve authorization controls","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/auth_controls","href":"/api-reference/cards/retrieve-authorization-controls"},{"title":"Provision an additional top-up deposit address for the card account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/deposit_addresses","href":"/api-reference/cards/provision-an-additional-top-up-deposit-address-for-the-card-account"},{"title":"Retrieve the withdrawal history of funds","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/withdrawals","href":"/api-reference/cards/retrieve-the-withdrawal-history-of-funds"},{"title":"Create a funds withdrawal request","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/withdrawals","href":"/api-reference/cards/create-a-funds-withdrawal-request"},{"title":"Retrieve a card withdrawal","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /customers/{customerID}/card_accounts/{cardAccountID}/withdrawals/{cardWithdrawalID}","href":"/api-reference/cards/retrieve-a-card-withdrawal"},{"title":"Generate a card account statement","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/card_accounts/{cardAccountID}/statements/{period}.pdf","href":"/api-reference/cards/generate-a-card-account-statement"},{"title":"Generate a card statement using Stripe IDs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /cardholders/{cardholderID}/cards/{cardID}/statements/{period}.pdf","href":"/api-reference/cards/generate-a-card-statement-using-stripe-ids"}]},{"group":"Batch Settlements","pages":[{"title":"Create a Batch Settlement Schedule","deprecated":true,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/batch_settlement_schedules","href":"/api-reference/batch-settlements/create-a-batch-settlement-schedule"}]},{"group":"Developers","pages":[{"title":"Get the configured fees","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/fees","href":"/api-reference/developers/get-the-configured-fees"},{"title":"Update the configured fees","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /developer/fees","href":"/api-reference/developers/update-the-configured-fees"},{"title":"Get the configured fee External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /developer/fee_external_account","href":"/api-reference/developers/get-the-configured-fee-external-account"},{"title":"Configure a fee External Account","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /developer/fee_external_account","href":"/api-reference/developers/configure-a-fee-external-account"}]},{"group":"API Keys","pages":[{"title":"Create a scoped API key","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /api_keys","href":"/api-reference/api-keys/create-a-scoped-api-key"},{"title":"Describe the calling API key","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /api_keys/whoami","href":"/api-reference/api-keys/describe-the-calling-api-key"}]},{"group":"KYC Links","pages":[{"title":"Get all KYC links.","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /kyc_links","href":"/api-reference/kyc-links/get-all-kyc-links"},{"title":"Generate the Links needs to complete KYC for an individual or business","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /kyc_links","href":"/api-reference/kyc-links/generate-the-links-needs-to-complete-kyc-for-an-individual-or-business"},{"title":"Check the status of a KYC link","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /kyc_links/{kycLinkID}","href":"/api-reference/kyc-links/check-the-status-of-a-kyc-link"}]},{"group":"RFIs","pages":[{"title":"Get all RFIs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rfis","href":"/api-reference/rfis/get-all-rfis"},{"title":"Get an RFI","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rfis/{rfiID}","href":"/api-reference/rfis/get-an-rfi"},{"title":"Submit responses to an RFI","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /rfis/{rfiID}/responses","href":"/api-reference/rfis/submit-responses-to-an-rfi"}]},{"group":"Funds Requests","pages":[{"title":"Get all funds requests","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /funds_requests","href":"/api-reference/funds-requests/get-all-funds-requests"}]},{"group":"Webhooks","pages":[{"title":"Get all webhook endpoints","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhooks","href":"/api-reference/webhooks/get-all-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /webhooks/{webhookID}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /webhooks/{webhookID}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"List upcoming events","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhooks/{webhookID}/events","href":"/api-reference/webhooks/list-upcoming-events"},{"title":"View logs","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhooks/{webhookID}/logs","href":"/api-reference/webhooks/view-logs"},{"title":"Send event","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /webhooks/{webhookID}/send","href":"/api-reference/webhooks/send-event"},{"title":"List webhook events","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /webhook_events","href":"/api-reference/webhooks/list-webhook-events"}]},{"group":"Associated Persons","pages":[{"title":"Get a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /associated_persons/{associatedPersonID}","href":"/api-reference/associated-persons/get-a-single-associated-person"},{"title":"Update a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /associated_persons/{associatedPersonID}","href":"/api-reference/associated-persons/update-a-single-associated-person"},{"title":"Delete a single associated person","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /associated_persons/{associatedPersonID}","href":"/api-reference/associated-persons/delete-a-single-associated-person"}]},{"group":"Travel Rule","pages":[{"title":"Submit travel rule data.","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /travel_rule_data/{id}","href":"/api-reference/travel-rule/submit-travel-rule-data"}]},{"group":"Exchange Rates","pages":[{"title":"Get current exchange rate between two currencies.","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /exchange_rates","href":"/api-reference/exchange-rates/get-current-exchange-rate-between-two-currencies"}]},{"group":"Lists","pages":[{"title":"Get occupation codes","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /lists/occupation_codes","href":"/api-reference/lists/get-occupation-codes"},{"title":"Get countries","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /lists/countries","href":"/api-reference/lists/get-countries"}]},{"group":"Crypto Return Policies","pages":[{"title":"Get all crypto return policies","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /crypto_return_policies","href":"/api-reference/crypto-return-policies/get-all-crypto-return-policies"},{"title":"Create a new crypto return policy","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /crypto_return_policies","href":"/api-reference/crypto-return-policies/create-a-new-crypto-return-policy"},{"title":"Update an existing crypto return policy","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json put /crypto_return_policies/{policyID}","href":"/api-reference/crypto-return-policies/update-an-existing-crypto-return-policy"},{"title":"Delete a single crypto return policy object","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json delete /crypto_return_policies/{policyID}","href":"/api-reference/crypto-return-policies/delete-a-single-crypto-return-policy-object"}]},{"group":"Developer Fees","pages":[]},{"group":"Rewards","pages":[{"title":"Get a summary of all rewards for a given stablecoin","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}","href":"/api-reference/rewards/get-a-summary-of-all-rewards-for-a-given-stablecoin"},{"title":"Get daily reward history for a stablecoin","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}/history","href":"/api-reference/rewards/get-daily-reward-history-for-a-stablecoin"},{"title":"Get a summary of a customer's rewards","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}/customer/{customerID}","href":"/api-reference/rewards/get-a-summary-of-a-customers-rewards"},{"title":"Get a history of a customer's rewards","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /rewards/{currency}/customer/{customerID}/history","href":"/api-reference/rewards/get-a-history-of-a-customers-rewards"}]},{"group":"Sandbox","pages":[{"title":"Simulate KYC approval (sandbox only)","deprecated":null,"version":null,"openapi":"https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json post /customers/{customerID}/simulate_kyc_approval","href":"/api-reference/sandbox/simulate-kyc-approval-sandbox-only"}]}]}]},{"tab":"Changelog","icon":"calendar","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"Create a Liquidation Address - Bridge","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}