Share account connection | Moov Documentation

Share account connection

Shares access scopes from the account specified to the caller, establishing a connection between the two accounts with the specified permissions.

POST

/accounts/{accountID}/connections

Ask

curl -X POST "https://api.moov.io/accounts/{accountID}/connections" \
  -H "Authorization: Bearer {token}" \
  -H "X-Moov-Version: v2026.07.00" \
  -d '{
  "principalAccountID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69"
}'

Ask

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.accounts.connect({
    accountID: "456cb5b6-20dc-4585-97b4-745d013adb1f",
    shareScopes: {
      principalAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
      allowScopes: [\
        "transfers.write",\
        "payment-methods.read",\
      ],
    },
  });

console.log(result);
}

run();

Ask

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$shareScopes = new Components\ShareScopes(
    principalAccountID: 'c520f1b9-0ba7-42f5-b977-248cdbe41c69',
    allowScopes: [\
        Components\ApplicationScope::TransfersWrite,\
        Components\ApplicationScope::PaymentMethodsRead,\
    ],
);

$response = $sdk->accounts->connect(
    accountID: '456cb5b6-20dc-4585-97b4-745d013adb1f',
    shareScopes: $shareScopes
);

if ($response->statusCode === 200) {
    // handle response
}

Ask

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.ConnectAccountRequestValidationError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.ConnectAccountResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

public static void main(String[] args) throws GenericError, ConnectAccountRequestValidationError, Exception {

Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

ConnectAccountResponse res = sdk.accounts().connect()
                .accountID("456cb5b6-20dc-4585-97b4-745d013adb1f")
                .shareScopes(ShareScopes.builder()
                    .principalAccountID("c520f1b9-0ba7-42f5-b977-248cdbe41c69")
                    .allowScopes(List.of(
                        ApplicationScope.TRANSFERS_WRITE,
                        ApplicationScope.PAYMENT_METHODS_READ))
                    .build())
                .call();

// handle response
    }
}

Ask

from moovio_sdk import Moov
from moovio_sdk.models import components

with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

res = moov.accounts.connect(account_id="456cb5b6-20dc-4585-97b4-745d013adb1f", principal_account_id="c520f1b9-0ba7-42f5-b977-248cdbe41c69", allow_scopes=[\
        components.ApplicationScope.TRANSFERS_WRITE,\
        components.ApplicationScope.PAYMENT_METHODS_READ,\
    ])

# Handle response
    print(res)

Ask

require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
  security: Models::Components::Security.new(
    username: '',
    password: ''
  )
)
res = s.accounts.connect(account_id: '456cb5b6-20dc-4585-97b4-745d013adb1f', share_scopes: Models::Components::ShareScopes.new(
  principal_account_id: 'c520f1b9-0ba7-42f5-b977-248cdbe41c69',
  allow_scopes: [\
    Models::Components::ApplicationScope::TRANSFERS_WRITE,\
    Models::Components::ApplicationScope::PAYMENT_METHODS_READ,\
  ]
))

if res.status_code == 200
  # handle response
end