List capabilities for an account

Retrieve all the capabilities an account has requested. Read our capabilities guide to learn more.

To use this endpoint from the browser, you’ll need to specify the /accounts/{accountID}/capabilities.read scope when generating a token.
GET
/accounts/{accountID}/capabilities
cURL Go JavaScript
1
2
curl -X GET "https://api.moov.io/accounts/{accountID}/capabilities/" \
  -H "Authorization: Bearer {token}" \
1
2
3
mc := moov.NewClient()

mc.ListCapabilities(ctx, account.AccountID)
1
2
3
4
5
const moov = new Moov(credentialsObject);

const accountID = "accountID";

moov.accounts.capabilities.list(accountID);
200 429
The list of capabilities for the account.
[
  {
    "accountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
    "capability": "transfers",
    "createdOn": "2019-08-24T14:15:22Z",
    "disabledOn": "2019-08-24T14:15:22Z",
    "disabledReason": "string",
    "requirements": {
      "currentlyDue": [
        "account.tos-acceptance"
      ],
      "errors": [
        {
          "errorCode": "invalid-value",
          "requirement": "account.tos-acceptance"
        }
      ]
    },
    "status": "enabled",
    "updatedOn": "2019-08-24T14:15:22Z"
  }
]
Request was refused due to rate limiting.

X-Retry-In

string <duration>
How long (in milliseconds) to wait until able to retry the request.

Path parameters

accountID

string <uuid> required
ID of the account.

Response

application/json

accountID

string<uuid> <=36 characters Pattern
ID of account.

capability

string<enum>
Identifier for the capability.
Possible values: transfers, send-funds, collect-funds, wallet, card-issuing

createdOn

string<date-time> <=24 characters

disabledOn

string<date-time> <=24 characters

disabledReason

string
If status is disabled, the reason this capability was disabled.

requirements

object
Represents individual and business data necessary to facilitate the enabling of a capability for an account.
right_key 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.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}

errors

array
right_key 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.
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.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}

status

string<enum>
The status of the capability requested for an account.
Possible values: enabled, disabled, pending, in-review

updatedOn

string<date-time> <=24 characters