Add External Account

POST

/api/v1/transformer/accounts/{entityId}/add/external_account

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

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/transformer/accounts/entity_c2f742c5_ea24_405f_a329_c73c0b3234a2/add/external_account' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jurisdictionID": "jurisdiction_ab6f2a82_51da_497f_a124_96fc360ad8de",
    "type": "deposit",
    "ownershipType": "first_party",
    "wallet": {
        "walletAddress": "0x42C45f26a31B41513da5e3B7f6E3BDbd7eCe823f"
    }
}'

Response Example

200 - Success

{
    "success": true,
    "data": {
        "message": "External account added successfully",
        "accountId": "acc_6437894"
    }
}

Modified at 2025-11-11 17:23:20

Get External Account Payload Requirements

Enable External Account