# Zynk ## Docs - [Introduction](https://docs.zynk.money/introduction-1023565m0.md): - [Partner Portal](https://docs.zynk.money/partner-portal-1037959m0.md): - [#Zring - Communications channel](https://docs.zynk.money/zring-communications-channel-1051476m0.md): - Transformer - Cross Border Transfer [Overview](https://docs.zynk.money/overview-1650459m0.md): - Transformer - Cross Border Transfer > Customers & Identity [Entities/Customers](https://docs.zynk.money/entitiescustomers-1051487m0.md): - Transformer - Cross Border Transfer > Customers & Identity [About KYC/KYB](https://docs.zynk.money/about-kyckyb-1051504m0.md): - Transformer - Cross Border Transfer > Customers & Identity [RFI Scenarios for Customers](https://docs.zynk.money/rfi-scenarios-for-customers-1195714m0.md): - Transformer - Cross Border Transfer > Customers & Identity [Identity Rejection Reasons](https://docs.zynk.money/identity-rejection-reasons-1369006m0.md): - Transformer - Cross Border Transfer > Accounts & Wallets [External Accounts](https://docs.zynk.money/external-accounts-1195592m0.md): - Transformer - Cross Border Transfer > Accounts & Wallets [Fetch Requirements for External Accounts V2](https://docs.zynk.money/fetch-requirements-for-external-accounts-v2-1299962m0.md): - Transformer - Cross Border Transfer > Accounts & Wallets [External Accounts V2](https://docs.zynk.money/external-accounts-v2-1282139m0.md): - Transformer - Cross Border Transfer > Accounts & Wallets [Funding Accounts](https://docs.zynk.money/funding-accounts-1282038m0.md): - Transformer - Cross Border Transfer > Accounts & Wallets [About Plaid Integration](https://docs.zynk.money/about-plaid-integration-1219002m0.md): - Transformer - Cross Border Transfer > Transfers [Counterparty Risk details](https://docs.zynk.money/counterparty-risk-details-1195746m0.md): - Transformer - Cross Border Transfer > Transfers [Addition transfer requirements](https://docs.zynk.money/addition-transfer-requirements-1546300m0.md): - Transformer - Cross Border Transfer > Transfers [Transfer in Action ](https://docs.zynk.money/transfer-in-action-1051559m0.md): - Transformer - Cross Border Transfer > Transfers [Limits and Minimums ](https://docs.zynk.money/limits-and-minimums-1051572m0.md): - Transformer - Cross Border Transfer > Transfers [Fee details](https://docs.zynk.money/fee-details-1051573m0.md): - Transformer - Cross Border Transfer > Miscellaneous [Bank Codes](https://docs.zynk.money/bank-codes-1195614m0.md): - Transformer - Cross Border Transfer > Miscellaneous [Supported chains and currencies](https://docs.zynk.money/supported-chains-and-currencies-1051580m0.md): - Transformer - Cross Border Transfer > Miscellaneous [Partner payments signature generation](https://docs.zynk.money/partner-payments-signature-generation-1195655m0.md): - Transformer - Cross Border Transfer > Miscellaneous [Reserves requirements](https://docs.zynk.money/reserves-requirements-1291565m0.md): - Transformer - Cross Border Transfer > Miscellaneous [Partner Payments](https://docs.zynk.money/partner-payments-1283962m0.md): - Transformer - Cross Border Transfer > Miscellaneous [Status updates - Webhooks](https://docs.zynk.money/status-updates-webhooks-1051574m0.md): - Transporter - Automated Liquidity Manager [Overview](https://docs.zynk.money/overview-1648584m0.md): - Transporter - Automated Liquidity Manager [Visibility Protocol](https://docs.zynk.money/visibility-protocol-1698535m0.md): - Transporter - Automated Liquidity Manager [Instant liquidity process - How it works](https://docs.zynk.money/instant-liquidity-process-how-it-works-1698536m0.md): - Transporter - Automated Liquidity Manager [Status updates - Webhooks](https://docs.zynk.money/status-updates-webhooks-1805830m0.md): - Teleport - Pay-In Accounts [Overview](https://docs.zynk.money/overview-1648583m0.md): - Teleport - Pay-In Accounts [About Teleport routes](https://docs.zynk.money/about-teleport-routes-1678306m0.md): - Warp - Pay-Outs [Overview](https://docs.zynk.money/overview-1648579m0.md): - Continuum - Wallet Infrastructure [Overview](https://docs.zynk.money/overview-1648577m0.md): - Continuum - Wallet Infrastructure [Authentication](https://docs.zynk.money/authentication-1706961m0.md): - Continuum - Wallet Infrastructure [Continuum APIs](https://docs.zynk.money/continuum-apis-1718141m0.md): - Continuum - Wallet Infrastructure [Transactions on Continuum](https://docs.zynk.money/transactions-on-continuum-1723110m0.md): - Continuum - Wallet Infrastructure [Details on generating signatures](https://docs.zynk.money/details-on-generating-signatures-1730009m0.md): - General [Getting Started](https://docs.zynk.money/getting-started-1252151m0.md): - General [Integration](https://docs.zynk.money/integration-1252258m0.md): - Technical > Transformer - Cross Border Transfer [API Questions](https://docs.zynk.money/api-questions-1252261m0.md): - Technical > Transformer - Cross Border Transfer [Troubleshooting](https://docs.zynk.money/troubleshooting-1252262m0.md): - Technical > Transformer - Cross Border Transfer [General FAQ's](https://docs.zynk.money/general-faqs-1035502m0.md): - Transformer - Cross Border Transfer [Creating a verified customer (with Webhook Integration)](https://docs.zynk.money/creating-a-verified-customer-with-webhook-integration-1253123m0.md): - Transformer - Cross Border Transfer [Fiat deposit to receive stablecoins flow](https://docs.zynk.money/fiat-deposit-to-receive-stablecoins-flow-1284012m0.md): - Transformer - Cross Border Transfer [Stablecoin deposit to receive Fiat](https://docs.zynk.money/stablecoin-deposit-to-receive-fiat-1284013m0.md): - Transformer - Cross Border Transfer [Demo Video for ACH pull in USD jurisdiction](https://docs.zynk.money/demo-video-for-ach-pull-in-usd-jurisdiction-1369135m0.md): - Transformer - Cross Border Transfer [Example webhook events](https://docs.zynk.money/example-webhook-events-1546235m0.md): ## API Docs - Transformer - Cross border transfer > Transformer: Entity [Create Entity](https://docs.zynk.money/create-entity-17031960e0.md): This endpoint allows you to create a new entity with personal information, address details, and optional fields. - Transformer - Cross border transfer > Transformer: Entity [Entities](https://docs.zynk.money/entities-17031961e0.md): This endpoint retrieves all entities associated with the authenticated partner. - Transformer - Cross border transfer > Transformer: Entity [Entity By ID](https://docs.zynk.money/entity-by-id-17031962e0.md): This endpoint retrieves a specific entity by its ID. - Transformer - Cross border transfer > Transformer: Entity [Entity By Email](https://docs.zynk.money/entity-by-email-17031963e0.md): This endpoint retrieves a specific entity by its email address. - Transformer - Cross border transfer > Transformer: Entity [KYC Status](https://docs.zynk.money/kyc-status-17031964e0.md): This endpoint retrieves the current verification status for a specific entity across all available routing providers. - Transformer - Cross border transfer > Transformer: Entity [KYC Requirements](https://docs.zynk.money/kyc-requirements-17031965e0.md): This endpoint retrieves the KYC requirements for a specific entity and routing provider. - Transformer - Cross border transfer > Transformer: Entity [Submit KYC/KYB](https://docs.zynk.money/submit-kyckyb-17031966e0.md): This endpoint allows you to submit collected verification data for processing. This endpoint accepts a structured payload containing the required information and documents based on the requirements obtained from the KYC/KYB Requirements API. - Transformer - Cross border transfer > Transformer: Entity [Get KYC Documents](https://docs.zynk.money/get-kyc-documents-19465465e0.md): Retrieve all KYC documents associated with a specific entity. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Generate Plaid Link Token](https://docs.zynk.money/generate-plaid-link-token-19392138e0.md): This endpoint will help you geenrate a plaid link token for the specified `entity id`. This is used to do plaid integration of ACH pull functionaity in USD jurisidiction. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Update Plaid Link Token](https://docs.zynk.money/update-plaid-link-token-19468746e0.md): This endpoint will help you refresh the plaid link token for expired plaid integrations of an entity. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Get External Account Payload Requirements](https://docs.zynk.money/get-external-account-payload-requirements-19605127e0.md): Returns the JSON Schema Draft-07 and uiSchema for the required payload for adding an external account (fiat or blockchain) for a given jurisdiction. The schema describes the structure and validation rules for the `account` (fiat) or `wallet` (blockchain) object in the Add External Account API. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Add External Account](https://docs.zynk.money/add-external-account-19256151e0.md): Registers an external bank account or crypto wallet that users own at their financial institutions. This registration allows Zynklabs to identify and process transactions to and from these accounts. The payload structure varies based on the jurisdiction type (fiat or blockchain). - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Enable External Account](https://docs.zynk.money/enable-external-account-19256788e0.md): Activates a previously disabled external account, allowing it to be used for deposits and withdrawals. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Disable External Account](https://docs.zynk.money/disable-external-account-19257053e0.md): Deactivates an external account, preventing it from being used for deposits and withdrawals. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Delete External Account](https://docs.zynk.money/delete-external-account-19257163e0.md): Permanently deletes an external account from the system. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Get External Account by ID](https://docs.zynk.money/get-external-account-by-id-19257200e0.md): Retrieves detailed information about a specific external account by its ID. - Transformer - Cross border transfer > Transformer: Accounts > External Accounts [Get External Accounts](https://docs.zynk.money/get-external-accounts-19257208e0.md): Retrieves a list of all external accounts associated with a specific entity. - Transformer - Cross border transfer > Transformer: Accounts > Funding Accounts [Create Funding Account](https://docs.zynk.money/create-funding-account-19246067e0.md): Creates a new virtual account in a chosen jurisdiction with unique banking details for fiat currency transactions. Note that creating a funding account incurs a fee, and only one funding account per jurisdiction is allowed. - Transformer - Cross border transfer > Transformer: Accounts > Funding Accounts [Activate Funding Account](https://docs.zynk.money/activate-funding-account-19248228e0.md): Re-enables a previously deactivated funding account. Note that active accounts incur monthly maintenance fees. - Transformer - Cross border transfer > Transformer: Accounts > Funding Accounts [Deactivate Funding Account](https://docs.zynk.money/deactivate-funding-account-19247769e0.md): Temporarily disables a funding account while preserving its setup. Deactivated accounts do not incur monthly maintenance fees. - Transformer - Cross border transfer > Transformer: Accounts > Funding Accounts [Funding Account by ID](https://docs.zynk.money/funding-account-by-id-19250403e0.md): Retrieves complete details of a specific funding account including its status and banking details. - Transformer - Cross border transfer > Transformer: Accounts > Funding Accounts [All Funding Accounts](https://docs.zynk.money/all-funding-accounts-19250431e0.md): Lists all funding accounts for an entity across all jurisdictions, including their status and banking details. - Transformer - Cross border transfer > Transformer: Accounts > Entity Accounts (Deprecated) [Add Entity Account](https://docs.zynk.money/add-entity-account-17031968e0.md): This endpoint allows you to add a new account for an entity. The account type (bank account or blockchain wallet) depends on the jurisdiction type. - Transformer - Cross border transfer > Transformer: Accounts > Entity Accounts (Deprecated) [Remove Entity Account](https://docs.zynk.money/remove-entity-account-17031971e0.md): This endpoint allows the removal of an account associated with an entity. - Transformer - Cross border transfer > Transformer: Accounts > Entity Accounts (Deprecated) [Get Entity Account](https://docs.zynk.money/get-entity-account-17031970e0.md): This endpoint retrieves a specific account associated with an entity. - Transformer - Cross border transfer > Transformer: Accounts > Entity Accounts (Deprecated) [Get Entity Accounts](https://docs.zynk.money/get-entity-accounts-17031969e0.md): This endpoint retrieves all accounts associated with an entity. - Transformer - Cross border transfer > Transformer: Transfers [Simulate](https://docs.zynk.money/simulate-17031972e0.md): This endpoint simulates a transaction between two entities. It validates the entities, accounts, and jurisdictions, finds eligible infrastructure providers, and creates an execution record. - Transformer - Cross border transfer > Transformer: Transfers [Transfer](https://docs.zynk.money/transfer-17031973e0.md): This endpoint executes a previously simulated transaction. It starts the transfer workflow process using the provided execution ID. - Transformer - Cross border transfer > Transformer: Transfers [All transfers for partner](https://docs.zynk.money/all-transfers-for-partner-17031975e0.md): This endpoint retrieves all transfers associated with the authenticated partner. - Transformer - Cross border transfer > Transformer: Transfers [Transfer by execution ID](https://docs.zynk.money/transfer-by-execution-id-17031976e0.md): This endpoint retrieves the details of a specific execution by its ID. - Transformer - Cross border transfer > Transformer: Utility [Partner Payments Account Balance](https://docs.zynk.money/partner-payments-account-balance-19110098e0.md): The Partner Payments Account Balance API allows partners to check their current payment balance and retrieve deposit instructions. This endpoint is useful for partners who want to prefund their account to streamline various payment processes within the platform. - Transformer - Cross border transfer > Transformer: Utility [Partner Payments Deposit](https://docs.zynk.money/partner-payments-deposit-19110099e0.md): The Partner Payments Deposit API enables partners to notify the system about funds they've deposited into the designated wallet address (provided in the deposit instructions). After the system verifies this payment transaction, an equivalent amount of partner utility tokens is minted directly to the partner's account. These tokens can then be used for various payment operations within the platform. - Transformer - Cross border transfer > Transformer: Utility [Get Jurisdictions](https://docs.zynk.money/get-jurisdictions-17514743e0.md): This endpoint retrieves all available jurisdictions in the system. - Transformer - Cross border transfer > Webhooks [Get Webhook Events History](https://docs.zynk.money/get-webhook-events-history-24120959e0.md): This endpoint retrieves the historical webhook events for the authenticated partner. It returns all webhook events that have been triggered for the partner, sorted by creation date (newest first). - Transformer - Cross border transfer > Webhooks [Registered Webhook URL](https://docs.zynk.money/registered-webhook-url-17031987e0.md): Retrieves the currently registered webhook URL for your integration. This endpoint allows you to verify which webhook URL is set to receive real-time notifications about events in your integration. - Transformer - Cross border transfer > Webhooks [Register or Update Webhook URL](https://docs.zynk.money/register-or-update-webhook-url-17031988e0.md): Registering or Updating Your Webhook URL - Transporter - Automated Liquidity Manager > ALM Market [Create Reserve Quote](https://docs.zynk.money/create-reserve-quote-24319576e0.md): Generate a quote for reserving funds with upfront fees. - Transporter - Automated Liquidity Manager > ALM Market [Accept Reserve Frame](https://docs.zynk.money/accept-reserve-frame-24319577e0.md): Accept a reserve frame by providing the fee transaction hash. - Transporter - Automated Liquidity Manager > ALM Market [Get Active Reserves](https://docs.zynk.money/get-active-reserves-24319578e0.md): Fetches all currently active reserves for the authenticated partner. - Transporter - Automated Liquidity Manager > ALM Market [Get All Reserves](https://docs.zynk.money/get-all-reserves-24319579e0.md): Fetches all reserves for the authenticated partner with optional filtering. - Transporter - Automated Liquidity Manager [Transaction Details by ID, Partner Transaction ID, or Transaction Hash](https://docs.zynk.money/transaction-details-by-id-partner-transaction-id-or-transaction-hash-24829261e0.md): Retrieves detailed information about a specific transaction using one of three identifiers: ID, Partner Transaction ID, or Transaction Hash. - Transporter - Automated Liquidity Manager [Transaction Details](https://docs.zynk.money/transaction-details-21782768e0.md): Retrieves detailed information about a specific transaction by its hash. - Transporter - Automated Liquidity Manager [Transaction Details by ID](https://docs.zynk.money/transaction-details-by-id-24801569e0.md): Retrieves detailed information about a specific transaction by its ID. - Transporter - Automated Liquidity Manager [Partner Details](https://docs.zynk.money/partner-details-24115114e0.md): Retrieves detailed information about a partner including their configuration, wallet addresses, credit limits, fee rates, transaction statistics, and current token balances. The endpoint can be accessed by the partner themselves (using their authenticated context). - Transporter - Automated Liquidity Manager [Initiate Transaction](https://docs.zynk.money/initiate-transaction-17031982e0.md): The transaction initiate endpoint will enable you to initiate a transaction through Zynk. Use this to transfer fiat or stables to a predefined destination - Transporter - Automated Liquidity Manager [Replenish Fee Quote](https://docs.zynk.money/replenish-fee-quote-17031983e0.md): The replenish fee quote endpoint provides the fee quote for your requested amount of the transaction. This includes both the network fees and the Zynk fees as per the applicable fee guidelines. - Transporter - Automated Liquidity Manager [Quote Fulfilled](https://docs.zynk.money/quote-fulfilled-23258220e0.md): Please reach out to support to understand the specific use case in which this API has to be used. - Transporter - Automated Liquidity Manager [Replenish Initiate](https://docs.zynk.money/replenish-initiate-17031986e0.md): The replenish transaction endpoint enables you to replenish and reconcile the transactions for which you requested a fee quote from the replenish fee quote endpoint. - Transporter - Automated Liquidity Manager [Replenish Batch Transaction](https://docs.zynk.money/replenish-batch-transaction-17031985e0.md): This endpoint allows the initiation of batch replenish transactions based on a previously obtained batch fee quote. The initial response is not descriptive enough since the processing is done in async manner. The final response will be fetched from the websocket. - Transporter - Automated Liquidity Manager [Replenish Fee Quote Batch](https://docs.zynk.money/replenish-fee-quote-batch-17031984e0.md): The replenish fee quote batch endpoint provides fee quotes for multiple requested transactions simultaneously. Each quote includes network and Zynk fees based on the applicable fee guidelines. The initial response is not descriptive since the processing is done in async manner. The final response will be fetched from the websocket. - Teleport - Pay-In Accounts [Create Teleport Route](https://docs.zynk.money/create-teleport-route-22687192e0.md): This endpoint will create a teleport route for the specific entity - Teleport - Pay-In Accounts [Update Teleport Destination](https://docs.zynk.money/update-teleport-destination-22687193e0.md): Updates the destination account for an existing teleport route. - Teleport - Pay-In Accounts [Toggle Teleport Status](https://docs.zynk.money/toggle-teleport-status-22687194e0.md): Enables or disables a teleport route. - Teleport - Pay-In Accounts [Teleport Details](https://docs.zynk.money/teleport-details-22687195e0.md): Retrieves detailed information about a specific teleport route including: - Teleport - Pay-In Accounts [Teleport Routes by Entity](https://docs.zynk.money/teleport-routes-by-entity-22687196e0.md): Lists all teleport routes configured for a specific entity. - Continuum - Wallet Infrastructure > Authentication [Register primary authentication](https://docs.zynk.money/register-primary-authentication-23544765e0.md): Registers primary authentication for an entity. This must be called before any wallet operations. - Continuum - Wallet Infrastructure > Wallet Management [Prepare wallet creation challenge (Step 1)](https://docs.zynk.money/prepare-wallet-creation-challenge-step-1-23544766e0.md): Generates an unsigned wallet creation challenge that must be signed by the user. - Continuum - Wallet Infrastructure > Wallet Management [Submit wallet creation activity (Step 2)](https://docs.zynk.money/submit-wallet-creation-activity-step-2-23544767e0.md): Submits the signed wallet creation activity to complete wallet creation. - Continuum - Wallet Infrastructure > Account Management [Prepare account creation challenge (Step 1)](https://docs.zynk.money/prepare-account-creation-challenge-step-1-23544768e0.md): Generates an unsigned account creation challenge for adding a new blockchain - Continuum - Wallet Infrastructure > Account Management [Submit account creation activity (Step 2)](https://docs.zynk.money/submit-account-creation-activity-step-2-23544769e0.md): Submits the signed account creation activity to complete account creation. - Continuum - Wallet Infrastructure > Passkey Management [Prepare passkey registration (Step 1)](https://docs.zynk.money/prepare-passkey-registration-step-1-23544770e0.md): Prepares a passkey registration challenge for adding a new authenticator to an entity. - Continuum - Wallet Infrastructure > Passkey Management [Submit passkey registration (Step 2)](https://docs.zynk.money/submit-passkey-registration-step-2-23544771e0.md): Submits the signed passkey registration activity. - Continuum - Wallet Infrastructure > Passkey Management [Get passkey authenticators](https://docs.zynk.money/get-passkey-authenticators-23544772e0.md): Retrieves all passkey authenticators registered for an entity. - Continuum - Wallet Infrastructure > Passkey Management [Prepare passkey deletion (Step 1)](https://docs.zynk.money/prepare-passkey-deletion-step-1-23544773e0.md): Prepares a passkey deletion challenge. - Continuum - Wallet Infrastructure > Passkey Management [Submit passkey deletion (Step 2)](https://docs.zynk.money/submit-passkey-deletion-step-2-23544774e0.md): Submits the signed passkey deletion activity. - Continuum - Wallet Infrastructure > Wallet Information [Get wallet details](https://docs.zynk.money/get-wallet-details-23544775e0.md): Retrieves wallet details including all accounts. - Continuum - Wallet Infrastructure > Wallet Information [Get wallet balances](https://docs.zynk.money/get-wallet-balances-23544776e0.md): Retrieves wallet details with balance information for all accounts and supported tokens. - Continuum - Wallet Infrastructure > Wallet Information [Get transactions for address](https://docs.zynk.money/get-transactions-for-address-23544777e0.md): Retrieves transaction history for a specific address in a wallet. - Continuum - Wallet Infrastructure > Sessions [Initiate OTP delivery](https://docs.zynk.money/initiate-otp-delivery-23544778e0.md): Initiates OTP delivery for Email_Auth or SMS_Auth registered entities. - Continuum - Wallet Infrastructure > Sessions [Start authentication session](https://docs.zynk.money/start-authentication-session-23544779e0.md): Creates a time-limited authentication session for OAuth/Email/SMS Auth. - Archive [KYC Documents](https://docs.zynk.money/kyc-documents-17031967e0.md): Retrieve all KYC documents associated with a specific entity. - Archive [Prepaid KYC Balance](https://docs.zynk.money/prepaid-kyc-balance-17031980e0.md): (Soon to be deprecated) Please checkout the APIs in the Partner Payments section instead. - Archive [Prepaid KYC Deposit](https://docs.zynk.money/prepaid-kyc-deposit-17031981e0.md): (Soon to be deprecated) Please checkout the APIs in the Partner Payments section instead.