Retrieve a capability

Retrieve a specific capability that an account has requested. Read our capabilities guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/capabilities.read scope.

GET

/accounts/{accountID}/capabilities/{capabilityID}

cURL Go TypeScript PHP Python Java Ruby (beta)

1
2
3


curl -X GET "https://api.moov.io/accounts/{accountID}/capabilities/{capabilityID}" \
  -H "Authorization: Bearer {token}" \
  -H "x-moov-version: v2024.01.00" \

1
2
3
4
5
6


mc, _ := moov.NewClient()

var accountID string
var capabilityID = moov.CapabilityName_Transfers

mc.GetCapability(ctx, accountID, capabilityID)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


import { SDK } from "openapi";

const sdk = new SDK({
  xMoovVersion: "v2024.01.00",
});

async function run() {
  const result = await sdk.capabilities.get({
    accountID: "c1697ea6-c984-4ba1-9b81-93e5e18660af",
    capabilityID: "send-funds.ach",
  });

  console.log(result);
}

run();

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


declare(strict_types=1);

require 'vendor/autoload.php';

use OpenAPI\OpenAPI;
use OpenAPI\OpenAPI\Models\Components;

$sdk = OpenAPI\SDK::builder()
    ->setXMoovVersion('v2024.01.00')
    ->build();



$response = $sdk->capabilities->get(
    accountID: 'c1697ea6-c984-4ba1-9b81-93e5e18660af',
    capabilityID: Components\CapabilityID::SendFundsAch

);

if ($response->capability !== null) {
    // handle response
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


from openapi import SDK


with SDK(
    x_moov_version="v2024.01.00",
) as sdk:

    res = sdk.capabilities.get(account_id="c1697ea6-c984-4ba1-9b81-93e5e18660af", capability_id="send-funds.ach")

    # Handle response
    print(res)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


package hello.world;

import java.lang.Exception;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.components.CapabilityID;
import org.openapis.openapi.models.operations.GetCapabilityResponse;

public class Application {

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

        SDK sdk = SDK.builder()
                .xMoovVersion("v2024.01.00")
            .build();

        GetCapabilityResponse res = sdk.capabilities().get()
                .accountID("c1697ea6-c984-4ba1-9b81-93e5e18660af")
                .capabilityID(CapabilityID.SEND_FUNDS_ACH)
                .call();

        if (res.capability().isPresent()) {
            // handle response
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


require 'openapi'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::SDK.new(
      x_moov_version: 'v2024.01.00',
    )

res = s.capabilities.get(account_id: 'c1697ea6-c984-4ba1-9b81-93e5e18660af', capability_id: Models::Components::CapabilityID::SEND_FUNDS_ACH)

unless res.capability.nil?
  # handle response
end

200 401 403 404 429 500 504

The request completed successfully.

application/json

{
  "capability": "transfers",
  "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
  "status": "enabled",
  "requirements": {
    "currentlyDue": [
      "account.tos-acceptance"
    ],
    "errors": [
      {
        "requirement": "account.tos-acceptance",
        "errorCode": "invalid-value"
      }
    ]
  },
  "disabledReason": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "updatedOn": "2019-08-24T14:15:22Z",
  "disabledOn": "2019-08-24T14:15:22Z"
}

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request contained missing or expired authentication.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The user is not authorized to make the request.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The requested resource was not found.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Request was refused due to rate limiting.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed due to an unexpected error.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed because a downstream service failed to respond.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Headers

X-Moov-Version


      string

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

YYYY is the year
QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
BB is the build number, starting at .01, for subsequent builds in the same quarter.
- For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Possible values: transfers, send-funds, send-funds.push-to-card, money-transfer.push-to-card, send-funds.ach, send-funds.rtp, send-funds.instant-bank, collect-funds, collect-funds.card-payments, money-transfer.pull-from-card, collect-funds.ach, wallet, wallet.balance, card-issuing, production-app, platform.production-app, platform.wallet-transfers

Response

application/json

accountID


        string<uuid>

required

capability


        string<enum>

required

Moov account capabilities.

The production-app, platform.production-app, and / or platform.wallet-transfers capabilities might appear in your list. These are read-only capabilities that Moov requests and uses for account verification purposes. These capabilities remains active with your account and require no additional action.

Possible values: transfers, send-funds, send-funds.push-to-card, money-transfer.push-to-card, send-funds.ach, send-funds.rtp, send-funds.instant-bank, collect-funds, collect-funds.card-payments, money-transfer.pull-from-card, collect-funds.ach, wallet, wallet.balance, card-issuing, platform.production-app, platform.wallet-transfers

createdOn


        string<date-time>

required

status


        string<enum>

required

The status of the capability requested for an account.

Possible values: enabled, disabled, pending, in-review

updatedOn


        string<date-time>

required

disabledOn


        string<date-time>

disabledReason


        string

requirements


        object

Represents individual and business data necessary to facilitate the enabling of a capability for an account.

Show child attributes

currentlyDue


        array

Possible values: account.tos-acceptance, individual.mobile, individual.email, individual.email-or-mobile, individual.firstname, individual.lastname, individual.address, individual.ssn-last4, individual.ssn, individual.birthdate, business.legalname, business.description-or-website, business.entity-type, business.business-type, business.dba, business.ein, business.address, business.phone, business.admins, business.controllers, business.owners, business.classification, business.industry-code-mcc, business.industry, business.indicate-owners-provided, business.average-transaction-size, business.max-transaction-size, business.average-monthly-transaction-volume, business.volume-by-customer-type, business.card-volume-distribution, business.fulfillment, business.description, business.underwriting-documents-tier-one, bank-accounts.name, bank-accounts.routing-number, bank-accounts.account-number, document.business.verification, document.individual.tin, document.individual.verification, document.representative.{rep-uuid}.tin, document.representative.{rep-uuid}.verification, representative.{rep-uuid}.mobile, representative.{rep-uuid}.email, representative.{rep-uuid}.email-or-mobile, representative.{rep-uuid}.firstname, representative.{rep-uuid}.lastname, representative.{rep-uuid}.address, representative.{rep-uuid}.ssn-last4, representative.{rep-uuid}.ssn, representative.{rep-uuid}.birthdate, representative.{rep-uuid}.job-title, representative.{rep-uuid}.is-controller, representative.{rep-uuid}.is-owner, representative.{rep-uuid}.ownership, document.{doc-uuid}, underwriting.businessPresence, underwriting.geographicReach, underwriting.volumeShareByCustomerType, underwriting.pendingLitigation, underwriting.documents.processingStatementsPast3Months, underwriting.collectFunds.cardPayments.cardAcceptanceMethods, underwriting.collectFunds.cardPayments.currentlyAcceptsCards, underwriting.collectFunds.cardPayments.estimatedActivity.averageTransactionAmount, underwriting.collectFunds.cardPayments.estimatedActivity.maximumTransactionAmount, underwriting.collectFunds.cardPayments.estimatedActivity.monthlyVolumeRange, underwriting.collectFunds.cardPayments.fulfillment, underwriting.collectFunds.cardPayments.refundPolicy, underwriting.collectFunds.ach.cardAcceptanceMethods, underwriting.collectFunds.ach.currentlyAcceptsCards, underwriting.collectFunds.ach.estimatedActivity.averageTransactionAmount, underwriting.collectFunds.ach.estimatedActivity.maximumTransactionAmount, underwriting.collectFunds.ach.estimatedActivity.monthlyVolumeRange, underwriting.collectFunds.ach.fulfillment, underwriting.collectFunds.ach.refundPolicy, underwriting.sendFunds.ach.cardAcceptanceMethods, underwriting.sendFunds.ach.currentlyAcceptsCards, underwriting.sendFunds.ach.estimatedActivity.averageTransactionAmount, underwriting.sendFunds.ach.estimatedActivity.maximumTransactionAmount, underwriting.sendFunds.ach.estimatedActivity.monthlyVolumeRange, underwriting.sendFunds.ach.fulfillment, underwriting.sendFunds.ach.refundPolicy, underwriting.sendFunds.rtp.cardAcceptanceMethods, underwriting.sendFunds.rtp.currentlyAcceptsCards, underwriting.sendFunds.rtp.estimatedActivity.averageTransactionAmount, underwriting.sendFunds.rtp.estimatedActivity.maximumTransactionAmount, underwriting.sendFunds.rtp.estimatedActivity.monthlyVolumeRange, underwriting.sendFunds.rtp.fulfillment, underwriting.sendFunds.rtp.refundPolicy, underwriting.sendFunds.pushToCard.cardAcceptanceMethods, underwriting.sendFunds.pushToCard.currentlyAcceptsCards, underwriting.sendFunds.pushToCard.estimatedActivity.averageTransactionAmount, underwriting.sendFunds.pushToCard.estimatedActivity.maximumTransactionAmount, underwriting.sendFunds.pushToCard.estimatedActivity.monthlyVolumeRange, underwriting.sendFunds.pushToCard.fulfillment, underwriting.sendFunds.pushToCard.refundPolicy, underwriting.moneyTransfer.pullFromCard.cardAcceptanceMethods, underwriting.moneyTransfer.pullFromCard.currentlyAcceptsCards, underwriting.moneyTransfer.pullFromCard.estimatedActivity.averageTransactionAmount, underwriting.moneyTransfer.pullFromCard.estimatedActivity.maximumTransactionAmount, underwriting.moneyTransfer.pullFromCard.estimatedActivity.monthlyVolumeRange, underwriting.moneyTransfer.pullFromCard.fulfillment, underwriting.moneyTransfer.pullFromCard.refundPolicy, underwriting.moneyTransfer.pushToCard.cardAcceptanceMethods, underwriting.moneyTransfer.pushToCard.currentlyAcceptsCards, underwriting.moneyTransfer.pushToCard.estimatedActivity.averageTransactionAmount, underwriting.moneyTransfer.pushToCard.estimatedActivity.maximumTransactionAmount, underwriting.moneyTransfer.pushToCard.estimatedActivity.monthlyVolumeRange, underwriting.moneyTransfer.pushToCard.fulfillment, underwriting.moneyTransfer.pushToCard.refundPolicy

errors


        array

Show child attributes

errorCode


        string<enum>

Possible values: invalid-value, failed-automatic-verification, failed-other, invalid-address, address-restricted, tax-id-mismatch, document-id-mismatch, document-date-of-birth-mismatch, document-name-mismatch, document-address.mismatch, document-number-mismatch, document-incomplete, document-failed-risk, document-illegible, document-unsupported, document-not-uploaded, document-corrupt, document-expired

requirement


        string<enum>

The unique ID of what the requirement is asking to be filled out.

cURL Go TypeScript PHP Python Java Ruby (beta)

1
2
3


curl -X GET "https://api.moov.io/accounts/{accountID}/capabilities/{capabilityID}" \
  -H "Authorization: Bearer {token}" \
  -H "x-moov-version: v2024.01.00" \

1
2
3
4
5
6


mc, _ := moov.NewClient()

var accountID string
var capabilityID = moov.CapabilityName_Transfers

mc.GetCapability(ctx, accountID, capabilityID)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


import { SDK } from "openapi";

const sdk = new SDK({
  xMoovVersion: "v2024.01.00",
});

async function run() {
  const result = await sdk.capabilities.get({
    accountID: "c1697ea6-c984-4ba1-9b81-93e5e18660af",
    capabilityID: "send-funds.ach",
  });

  console.log(result);
}

run();

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


declare(strict_types=1);

require 'vendor/autoload.php';

use OpenAPI\OpenAPI;
use OpenAPI\OpenAPI\Models\Components;

$sdk = OpenAPI\SDK::builder()
    ->setXMoovVersion('v2024.01.00')
    ->build();



$response = $sdk->capabilities->get(
    accountID: 'c1697ea6-c984-4ba1-9b81-93e5e18660af',
    capabilityID: Components\CapabilityID::SendFundsAch

);

if ($response->capability !== null) {
    // handle response
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


from openapi import SDK


with SDK(
    x_moov_version="v2024.01.00",
) as sdk:

    res = sdk.capabilities.get(account_id="c1697ea6-c984-4ba1-9b81-93e5e18660af", capability_id="send-funds.ach")

    # Handle response
    print(res)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


package hello.world;

import java.lang.Exception;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.components.CapabilityID;
import org.openapis.openapi.models.operations.GetCapabilityResponse;

public class Application {

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

        SDK sdk = SDK.builder()
                .xMoovVersion("v2024.01.00")
            .build();

        GetCapabilityResponse res = sdk.capabilities().get()
                .accountID("c1697ea6-c984-4ba1-9b81-93e5e18660af")
                .capabilityID(CapabilityID.SEND_FUNDS_ACH)
                .call();

        if (res.capability().isPresent()) {
            // handle response
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


require 'openapi'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::SDK.new(
      x_moov_version: 'v2024.01.00',
    )

res = s.capabilities.get(account_id: 'c1697ea6-c984-4ba1-9b81-93e5e18660af', capability_id: Models::Components::CapabilityID::SEND_FUNDS_ACH)

unless res.capability.nil?
  # handle response
end

200 401 403 404 429 500 504

The request completed successfully.

application/json

{
  "capability": "transfers",
  "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
  "status": "enabled",
  "requirements": {
    "currentlyDue": [
      "account.tos-acceptance"
    ],
    "errors": [
      {
        "requirement": "account.tos-acceptance",
        "errorCode": "invalid-value"
      }
    ]
  },
  "disabledReason": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "updatedOn": "2019-08-24T14:15:22Z",
  "disabledOn": "2019-08-24T14:15:22Z"
}

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request contained missing or expired authentication.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The user is not authorized to make the request.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The requested resource was not found.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Request was refused due to rate limiting.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed due to an unexpected error.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed because a downstream service failed to respond.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Retrieve a capability

Response headers

x-request-id

Response headers

x-request-id

Response headers

x-request-id

Response headers

x-request-id

Response headers

x-request-id

Response headers

x-request-id

Response headers

x-request-id

Headers

X-Moov-Version

Path parameters

accountID

capabilityID

Response

accountID

capability

createdOn

status

updatedOn

disabledOn

disabledReason

requirements

currentlyDue

errors

errorCode

requirement

Was this helpful?