Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Accounts

List accounts

List or search accounts to which the caller is connected.

All supported query parameters are optional. If none are provided the response will include all connected accounts. Pagination is supported via the skip and count query parameters. Searching by name and email will overlap and return results based on relevance.

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

GET
/accounts
cURL Go Java PHP Python TypeScript 
1
2

curl -X GET "https://api.moov.io/accounts" \
  -H "Authorization: Bearer {token}"

1
2
3

mc, _ := moov.NewClient()

mc.ListAccounts(ctx)

 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
26
27
28
29
30
31
32
33
34
35

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.AccountType;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListAccountsRequest;
import io.moov.sdk.models.operations.ListAccountsResponse;
import java.lang.Exception;

public class Application {

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

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

        ListAccountsRequest req = ListAccountsRequest.builder()
                .type(AccountType.BUSINESS)
                .skip(60L)
                .count(20L)
                .build();

        ListAccountsResponse res = sdk.accounts().list()
                .request(req)
                .call();

        if (res.accounts().isPresent()) {
            // handle response
        }
    }
}
 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
26
27
28
29
30

declare(strict_types=1);

require 'vendor/autoload.php';

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

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

$request = new Operations\ListAccountsRequest(
    type: Components\AccountType::Business,
    skip: 60,
    count: 20,
);

$response = $sdk->accounts->list(
    request: $request
);

if ($response->accounts !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.accounts.list(type_=components.AccountType.BUSINESS, skip=60, count=20)

    # 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

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

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

async function run() {
  const result = await moov.accounts.list({
    type: "business",
    skip: 60,
    count: 20,
  });

  // Handle the result
  console.log(result);
}

run();
200 401 403 429 500 504
The request completed successfully.
schema
{
  "items": {
    "example": {
      "accountID": "53ca67ea-6fd3-423f-9544-ce2404159d33",
      "accountType": "business",
      "createdOn": "2024-12-16T17:55:20.557151867Z",
      "displayName": "Whole Body Fitness LLC",
      "mode": "sandbox",
      "profile": {
        "business": {
          "legalBusinessName": "Whole Body Fitness LLC",
          "ownersProvided": false
        }
      },
      "settings": {
        "achPayment": {
          "companyName": "Whole Body Fitne"
        },
        "cardPayment": {
          "statementDescriptor": "Whole Body Fitness LLC"
        }
      },
      "updatedOn": "2024-12-16T17:55:20.557151867Z",
      "verification": {
        "status": "unverified",
        "verificationStatus": "unverified"
      }
    },
    "properties": {
      "accountID": {
        "description": "Unique identifier for this account.",
        "example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
        "format": "uuid",
        "type": "string"
      },
      "accountType": {
        "description": "The type of entity represented by this account.",
        "enum": [
          "individual",
          "business",
          "guest"
        ],
        "example": "business",
        "type": "string"
      },
      "capabilities": {
        "items": {
          "description": "Describes an action or set of actions that an account is permitted to perform.",
          "properties": {
            "capability": {
              "type": "string"
            },
            "status": {
              "type": "string"
            }
          },
          "required": [
            "capability",
            "status"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "createdOn": {
        "example": "2024-05-06T12:20:38.184Z",
        "format": "date-time",
        "type": "string"
      },
      "customerSupport": {
        "description": "User-provided information that can be displayed on credit card transactions for customers to use when\ncontacting a customer support team. This data is only allowed on a business account.",
        "properties": {
          "address": {
            "properties": {
              "addressLine1": {
                "example": "123 Main Street",
                "maxLength": 60,
                "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                "type": "string"
              },
              "addressLine2": {
                "example": "Apt 302",
                "maxLength": 32,
                "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                "type": "string"
              },
              "city": {
                "example": "Boulder",
                "maxLength": 32,
                "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                "type": "string"
              },
              "country": {
                "example": "US",
                "maxLength": 2,
                "type": "string"
              },
              "postalCode": {
                "example": "80301",
                "maxLength": 5,
                "type": "string"
              },
              "stateOrProvince": {
                "example": "CO",
                "maxLength": 2,
                "type": "string"
              }
            },
            "required": [
              "addressLine1",
              "city",
              "stateOrProvince",
              "postalCode",
              "country"
            ],
            "type": "object"
          },
          "email": {
            "example": "[email protected]",
            "format": "email",
            "maxLength": 255,
            "type": "string"
          },
          "phone": {
            "properties": {
              "countryCode": {
                "example": "1",
                "maxLength": 1,
                "type": "string"
              },
              "number": {
                "example": "8185551212",
                "maxLength": 10,
                "type": "string"
              }
            },
            "type": "object"
          },
          "website": {
            "format": "uri",
            "type": "string"
          }
        },
        "type": "object"
      },
      "disconnectedOn": {
        "example": "2024-05-06T12:20:38.184Z",
        "format": "date-time",
        "type": "string"
      },
      "displayName": {
        "example": "Whole Body Fitness",
        "maxLength": 64,
        "type": "string"
      },
      "foreignID": {
        "description": "Optional alias from a foreign/external system which can be used to reference this resource.",
        "maxLength": 64,
        "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {
          "type": "string"
        },
        "description": "Free-form key-value pair list. Useful for storing information that is not captured elsewhere.",
        "example": {
          "optional": "metadata"
        },
        "type": "object"
      },
      "mode": {
        "description": "The operating mode for an account.",
        "enum": [
          "sandbox",
          "production"
        ],
        "example": "production",
        "type": "string"
      },
      "profile": {
        "description": "Describes a Moov account profile. A profile will have a business or an individual, depending on the account's type.",
        "properties": {
          "business": {
            "description": "Describes a business.",
            "properties": {
              "address": {
                "properties": {
                  "addressLine1": {
                    "example": "123 Main Street",
                    "maxLength": 60,
                    "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                    "type": "string"
                  },
                  "addressLine2": {
                    "example": "Apt 302",
                    "maxLength": 32,
                    "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                    "type": "string"
                  },
                  "city": {
                    "example": "Boulder",
                    "maxLength": 32,
                    "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                    "type": "string"
                  },
                  "country": {
                    "example": "US",
                    "maxLength": 2,
                    "type": "string"
                  },
                  "postalCode": {
                    "example": "80301",
                    "maxLength": 5,
                    "type": "string"
                  },
                  "stateOrProvince": {
                    "example": "CO",
                    "maxLength": 2,
                    "type": "string"
                  }
                },
                "required": [
                  "addressLine1",
                  "city",
                  "stateOrProvince",
                  "postalCode",
                  "country"
                ],
                "type": "object"
              },
              "businessType": {
                "description": "The type of entity represented by this business.",
                "enum": [
                  "soleProprietorship",
                  "unincorporatedAssociation",
                  "trust",
                  "publicCorporation",
                  "privateCorporation",
                  "llc",
                  "partnership",
                  "unincorporatedNonProfit",
                  "incorporatedNonProfit",
                  "governmentEntity"
                ],
                "example": "llc",
                "type": "string"
              },
              "description": {
                "example": "Local fitness gym paying out instructors",
                "maxLength": 100,
                "minLength": 10,
                "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                "type": "string"
              },
              "doingBusinessAs": {
                "description": "A registered trade name under which the business operates, if different from its legal name.",
                "maxLength": 64,
                "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                "type": "string"
              },
              "email": {
                "example": "[email protected]",
                "format": "email",
                "maxLength": 255,
                "type": "string"
              },
              "industryCodes": {
                "properties": {
                  "mcc": {
                    "example": "7997",
                    "maxLength": 4,
                    "minLength": 4,
                    "type": "string"
                  },
                  "naics": {
                    "example": "713940",
                    "maxLength": 6,
                    "minLength": 2,
                    "type": "string"
                  },
                  "sic": {
                    "example": "7991",
                    "maxLength": 4,
                    "minLength": 4,
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "legalBusinessName": {
                "description": "The legal name under which the entity is registered.",
                "example": "Classbooker, LLC",
                "maxLength": 64,
                "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                "type": "string"
              },
              "ownersProvided": {
                "type": "boolean"
              },
              "phone": {
                "properties": {
                  "countryCode": {
                    "example": "1",
                    "maxLength": 1,
                    "type": "string"
                  },
                  "number": {
                    "example": "8185551212",
                    "maxLength": 10,
                    "type": "string"
                  }
                },
                "type": "object"
              },
              "primaryRegulator": {
                "description": "If the business is a financial institution, this field describes its primary regulator.",
                "enum": [
                  "OCC",
                  "FDIC",
                  "NCUA",
                  "FRB"
                ],
                "type": "string"
              },
              "representatives": {
                "items": {
                  "description": "Describes a business representative.",
                  "properties": {
                    "address": {
                      "properties": {
                        "addressLine1": {
                          "example": "123 Main Street",
                          "maxLength": 60,
                          "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                          "type": "string"
                        },
                        "addressLine2": {
                          "example": "Apt 302",
                          "maxLength": 32,
                          "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                          "type": "string"
                        },
                        "city": {
                          "example": "Boulder",
                          "maxLength": 32,
                          "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                          "type": "string"
                        },
                        "country": {
                          "example": "US",
                          "maxLength": 2,
                          "type": "string"
                        },
                        "postalCode": {
                          "example": "80301",
                          "maxLength": 5,
                          "type": "string"
                        },
                        "stateOrProvince": {
                          "example": "CO",
                          "maxLength": 2,
                          "type": "string"
                        }
                      },
                      "required": [
                        "addressLine1",
                        "city",
                        "stateOrProvince",
                        "postalCode",
                        "country"
                      ],
                      "type": "object"
                    },
                    "birthDateProvided": {
                      "description": "Indicates whether this representative's birth date has been provided.",
                      "type": "boolean"
                    },
                    "createdOn": {
                      "format": "date-time",
                      "type": "string"
                    },
                    "disabledOn": {
                      "format": "date-time",
                      "type": "string"
                    },
                    "email": {
                      "example": "[email protected]",
                      "format": "email",
                      "maxLength": 255,
                      "type": "string"
                    },
                    "governmentIDProvided": {
                      "description": "Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this representative.",
                      "type": "boolean"
                    },
                    "name": {
                      "properties": {
                        "firstName": {
                          "description": "The individual's first given name.",
                          "example": "Jordan",
                          "maxLength": 64,
                          "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                          "type": "string"
                        },
                        "lastName": {
                          "description": "The individual's family name.",
                          "example": "Lee",
                          "maxLength": 64,
                          "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                          "type": "string"
                        },
                        "middleName": {
                          "description": "The individual's second given name, if any.",
                          "example": "Reese",
                          "maxLength": 64,
                          "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                          "type": "string"
                        },
                        "suffix": {
                          "description": "Suffix of a given name.",
                          "example": "Jr",
                          "maxLength": 20,
                          "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                          "type": "string"
                        }
                      },
                      "required": [
                        "firstName",
                        "lastName"
                      ],
                      "type": "object"
                    },
                    "phone": {
                      "properties": {
                        "countryCode": {
                          "example": "1",
                          "maxLength": 1,
                          "type": "string"
                        },
                        "number": {
                          "example": "8185551212",
                          "maxLength": 10,
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "representativeID": {
                      "description": "Unique identifier for this representative.",
                      "format": "uuid",
                      "type": "string"
                    },
                    "responsibilities": {
                      "description": "Describes the job responsibilities of a business representative.",
                      "properties": {
                        "isController": {
                          "description": "Indicates whether this individual has significant management responsibilities within the business.",
                          "type": "boolean"
                        },
                        "isOwner": {
                          "description": "If `true`, this field indicates that the individual has a business ownership stake of at least 25% in the\nbusiness. If the representative does not own at least 25% of the business, this field should be `false`.",
                          "type": "boolean"
                        },
                        "jobTitle": {
                          "example": "CEO",
                          "maxLength": 64,
                          "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                          "type": "string"
                        },
                        "ownershipPercentage": {
                          "description": "The percentage of ownership this individual has in the business (required if `isOwner` is `true`).",
                          "example": 38,
                          "type": "integer"
                        }
                      },
                      "type": "object"
                    },
                    "updatedOn": {
                      "format": "date-time",
                      "type": "string"
                    }
                  },
                  "required": [
                    "representativeID",
                    "name",
                    "createdOn",
                    "updatedOn"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "taxIDProvided": {
                "description": "Indicates whether a tax ID has been provided for this business.",
                "type": "boolean"
              },
              "website": {
                "format": "uri",
                "maxLength": 100,
                "type": "string"
              }
            },
            "required": [
              "legalBusinessName",
              "ownersProvided"
            ],
            "type": "object"
          },
          "guest": {
            "description": "Describes a guest account profile.",
            "properties": {
              "email": {
                "example": "[email protected]",
                "format": "email",
                "maxLength": 255,
                "type": "string"
              },
              "name": {
                "description": "The name associated with the guest account.\nThis will default to \"Guest {accountIDfirst8}\" if no other name is provided.",
                "example": "Guest 75e5fbb8",
                "maxLength": 64,
                "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                "type": "string"
              },
              "phone": {
                "properties": {
                  "countryCode": {
                    "example": "1",
                    "maxLength": 1,
                    "type": "string"
                  },
                  "number": {
                    "example": "8185551212",
                    "maxLength": 10,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            },
            "required": [
              "name"
            ],
            "type": "object"
          },
          "individual": {
            "description": "Describes an individual.",
            "properties": {
              "address": {
                "properties": {
                  "addressLine1": {
                    "example": "123 Main Street",
                    "maxLength": 60,
                    "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                    "type": "string"
                  },
                  "addressLine2": {
                    "example": "Apt 302",
                    "maxLength": 32,
                    "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                    "type": "string"
                  },
                  "city": {
                    "example": "Boulder",
                    "maxLength": 32,
                    "pattern": "[a-zA-Z0-9,./?:'\"|~!@#$%^\u0026*()-+_= ]+",
                    "type": "string"
                  },
                  "country": {
                    "example": "US",
                    "maxLength": 2,
                    "type": "string"
                  },
                  "postalCode": {
                    "example": "80301",
                    "maxLength": 5,
                    "type": "string"
                  },
                  "stateOrProvince": {
                    "example": "CO",
                    "maxLength": 2,
                    "type": "string"
                  }
                },
                "required": [
                  "addressLine1",
                  "city",
                  "stateOrProvince",
                  "postalCode",
                  "country"
                ],
                "type": "object"
              },
              "birthDateProvided": {
                "description": "Indicates whether this individual's birth date has been provided.",
                "type": "boolean"
              },
              "email": {
                "example": "[email protected]",
                "format": "email",
                "maxLength": 255,
                "type": "string"
              },
              "governmentIDProvided": {
                "description": "Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this individual.",
                "type": "boolean"
              },
              "name": {
                "properties": {
                  "firstName": {
                    "description": "The individual's first given name.",
                    "example": "Jordan",
                    "maxLength": 64,
                    "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                    "type": "string"
                  },
                  "lastName": {
                    "description": "The individual's family name.",
                    "example": "Lee",
                    "maxLength": 64,
                    "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                    "type": "string"
                  },
                  "middleName": {
                    "description": "The individual's second given name, if any.",
                    "example": "Reese",
                    "maxLength": 64,
                    "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                    "type": "string"
                  },
                  "suffix": {
                    "description": "Suffix of a given name.",
                    "example": "Jr",
                    "maxLength": 20,
                    "pattern": "[À-ÖØ-öø-ÿ\"'(),-.0-9A-Za-z~ \u0026!]*",
                    "type": "string"
                  }
                },
                "required": [
                  "firstName",
                  "lastName"
                ],
                "type": "object"
              },
              "phone": {
                "properties": {
                  "countryCode": {
                    "example": "1",
                    "maxLength": 1,
                    "type": "string"
                  },
                  "number": {
                    "example": "8185551212",
                    "maxLength": 10,
                    "type": "string"
                  }
                },
                "type": "object"
              }
            },
            "required": [
              "name"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "settings": {
        "description": "User provided settings to manage an account.",
        "properties": {
          "achPayment": {
            "properties": {
              "companyName": {
                "description": "The description that shows up on ACH transactions. This will default to the account's display name on account creation.",
                "example": "WholeBodyFitness",
                "maxLength": 16,
                "minLength": 1,
                "pattern": "[a-zA-Z0-9- ]+",
                "type": "string"
              }
            },
            "required": [
              "companyName"
            ],
            "type": "object"
          },
          "cardPayment": {
            "description": "User provided settings to manage card payments. This data is only allowed on a business account.",
            "properties": {
              "statementDescriptor": {
                "description": "The description that shows up on credit card transactions. This will default to the accounts display name on account creation.",
                "example": "Whole Body Fitness",
                "maxLength": 22,
                "minLength": 4,
                "pattern": "[a-zA-Z0-9.!*-+_ ]+",
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "termsOfService": {
        "description": "Describes the acceptance of the Terms of Service.",
        "properties": {
          "acceptedDate": {
            "description": "The date and time the terms of service were accepted.",
            "format": "date-time",
            "type": "string"
          },
          "acceptedIP": {
            "description": "The IP address from which the terms of service were accepted.",
            "example": "172.217.2.46",
            "format": "ipv4",
            "type": "string"
          }
        },
        "required": [
          "acceptedDate",
          "acceptedIP"
        ],
        "type": "object"
      },
      "updatedOn": {
        "example": "2024-05-06T12:20:38.184Z",
        "format": "date-time",
        "type": "string"
      },
      "verification": {
        "description": "Describes identity verification status and relevant identity verification documents.",
        "properties": {
          "details": {
            "deprecated": true,
            "description": "Additional detail for a verification status.",
            "enum": [
              "failedAutoVerify",
              "docDobMismatch",
              "docNameMismatch",
              "docAddressMismatch",
              "docNumberMismatch",
              "docIncomplete",
              "docFailedRisk",
              "potentialAccountSanctionsMatch",
              "potentialRepresentativeSanctionsMatch",
              "failedOther"
            ],
            "type": "string"
          },
          "documents": {
            "items": {
              "properties": {
                "contentType": {
                  "description": "The document's MIME type.",
                  "example": "application/pdf",
                  "type": "string"
                },
                "documentID": {
                  "example": "e07e83e8-9429-4e99-ac99-c941f719eb39",
                  "format": "uuid",
                  "type": "string"
                },
                "parseErrors": {
                  "description": "Optional array of errors encountered during automated parsing.",
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "type": {
                  "description": "Types of documents that can be uploaded.",
                  "enum": [
                    "driversLicense",
                    "passport",
                    "utilityBill",
                    "bankStatement"
                  ],
                  "example": "bankStatement",
                  "type": "string"
                },
                "uploadedAt": {
                  "example": "2024-05-06T12:20:38.184Z",
                  "format": "date-time",
                  "type": "string"
                }
              },
              "required": [
                "documentID",
                "type",
                "contentType",
                "uploadedAt"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "status": {
            "deprecated": true,
            "description": "Possible states an account verification can be in.",
            "enum": [
              "unverified",
              "pending",
              "verified",
              "errored"
            ],
            "type": "string"
          },
          "verificationStatus": {
            "deprecated": true,
            "description": "Possible states an account verification can be in.",
            "enum": [
              "unverified",
              "pending",
              "resubmit",
              "review",
              "verified",
              "failed"
            ],
            "type": "string"
          }
        },
        "required": [
          "status"
        ],
        "type": "object"
      }
    },
    "required": [
      "accountID",
      "mode",
      "accountType",
      "displayName",
      "profile",
      "verification",
      "createdOn",
      "updatedOn"
    ],
    "type": "object"
  },
  "type": "array"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

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

Query parameters

name

string

Filter connected accounts by name.

If provided, this query will attempt to find matches against the following Account and Profile fields:

  • Account `displayName`
  • Individual Profile `firstName`, `middleName`, and `lastName`
  • Business Profile `legalBusinessName`

email

string

Filter connected accounts by email address.

Provide the full email address to filter by email.

type

string

Filter connected accounts by AccountType.

If the type parameter is used in combination with name, only the corresponding type's name fields will be searched. For example, if type=business and name=moov, the search will attempt to find matches against the display name and Business Profile name fields (legalBusinessName, and doingBusinessAs).

Possible values: individual, business, guest

includeGuest

boolean

Filter accounts with AccountType guest.

If true, the response will include guest accounts.

foreignID

string
Serves as an optional alias from a foreign/external system which can be used to reference this resource.

includeDisconnected

boolean

Filter disconnected accounts.

If true, the response will include disconnected accounts.

capability

string
Filter connected accounts by the capability.
Possible values: transfers, send-funds, collect-funds, wallet, card-issuing, production-app

capabilityStatus

string
Filter connected accounts by the capability.
Possible values: enabled, disabled, pending, in-review

skip

integer <int64>

count

integer <int64>

Response

application/json

accountID

string<uuid>
Unique identifier for this account.

accountType

string<enum>
The type of entity represented by this account.
Possible values: individual, business, guest

capabilities

array
Show child attributes

capability

string

status

string

createdOn

string<date-time>

customerSupport

object
User-provided information that can be displayed on credit card transactions for customers to use when contacting a customer support team. This data is only allowed on a business account.
Show child attributes

address

object
Show child attributes

addressLine1

string <=60 characters required Pattern

city

string <=32 characters required Pattern

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

addressLine2

string <=32 characters Pattern

email

string<email> <=255 characters

phone

object
Show child attributes

countryCode

string <=1 characters

number

string <=10 characters

website

string<uri>

disconnectedOn

string<date-time>

displayName

string <=64 characters

foreignID

string <=64 characters Pattern
Optional alias from a foreign/external system which can be used to reference this resource.

metadata

object
Free-form key-value pair list. Useful for storing information that is not captured elsewhere.

mode

string<enum>
The operating mode for an account.
Possible values: sandbox, production

profile

object
Describes a Moov account profile. A profile will have a business or an individual, depending on the account's type.
Show child attributes

business

object
Describes a business.
Show child attributes

legalBusinessName

string <=64 characters required Pattern
The legal name under which the entity is registered.

ownersProvided

boolean required

address

object
Show child attributes

addressLine1

string <=60 characters required Pattern

city

string <=32 characters required Pattern

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

addressLine2

string <=32 characters Pattern

businessType

string<enum>
The type of entity represented by this business.
Possible values: soleProprietorship, unincorporatedAssociation, trust, publicCorporation, privateCorporation, llc, partnership, unincorporatedNonProfit, incorporatedNonProfit, governmentEntity

description

string [10 to 100] characters Pattern

doingBusinessAs

string <=64 characters Pattern
A registered trade name under which the business operates, if different from its legal name.

email

string<email> <=255 characters

industryCodes

object
Show child attributes

mcc

string 4 characters

naics

string [2 to 6] characters

sic

string 4 characters

phone

object
Show child attributes

countryCode

string <=1 characters

number

string <=10 characters

primaryRegulator

string<enum>
If the business is a financial institution, this field describes its primary regulator.
Possible values: OCC, FDIC, NCUA, FRB

representatives

array
Show child attributes

address

object
Show child attributes

addressLine1

string <=60 characters required Pattern

city

string <=32 characters required Pattern

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

addressLine2

string <=32 characters Pattern

birthDateProvided

boolean
Indicates whether this representative's birth date has been provided.

createdOn

string<date-time>

disabledOn

string<date-time>

email

string<email> <=255 characters

governmentIDProvided

boolean
Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this representative.

name

object
Show child attributes

firstName

string <=64 characters required Pattern
The individual's first given name.

lastName

string <=64 characters required Pattern
The individual's family name.

middleName

string <=64 characters Pattern
The individual's second given name, if any.

suffix

string <=20 characters Pattern
Suffix of a given name.

phone

object
Show child attributes

countryCode

string <=1 characters

number

string <=10 characters

representativeID

string<uuid>
Unique identifier for this representative.

responsibilities

object
Describes the job responsibilities of a business representative.
Show child attributes

isController

boolean
Indicates whether this individual has significant management responsibilities within the business.

isOwner

boolean
If true, this field indicates that the individual has a business ownership stake of at least 25% in the business. If the representative does not own at least 25% of the business, this field should be false.

jobTitle

string <=64 characters Pattern

ownershipPercentage

integer
The percentage of ownership this individual has in the business (required if isOwner is true).

updatedOn

string<date-time>

taxIDProvided

boolean
Indicates whether a tax ID has been provided for this business.

website

string<uri> <=100 characters

guest

object
Describes a guest account profile.
Show child attributes

name

string <=64 characters required Pattern
The name associated with the guest account. This will default to "Guest {accountIDfirst8}" if no other name is provided.

email

string<email> <=255 characters

phone

object
Show child attributes

countryCode

string <=1 characters

number

string <=10 characters

individual

object
Describes an individual.
Show child attributes

name

object required
Show child attributes

firstName

string <=64 characters required Pattern
The individual's first given name.

lastName

string <=64 characters required Pattern
The individual's family name.

middleName

string <=64 characters Pattern
The individual's second given name, if any.

suffix

string <=20 characters Pattern
Suffix of a given name.

address

object
Show child attributes

addressLine1

string <=60 characters required Pattern

city

string <=32 characters required Pattern

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

addressLine2

string <=32 characters Pattern

birthDateProvided

boolean
Indicates whether this individual's birth date has been provided.

email

string<email> <=255 characters

governmentIDProvided

boolean
Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this individual.

phone

object
Show child attributes

countryCode

string <=1 characters

number

string <=10 characters

settings

object
User provided settings to manage an account.
Show child attributes

achPayment

object
Show child attributes

companyName

string [1 to 16] characters required Pattern
The description that shows up on ACH transactions. This will default to the account's display name on account creation.

cardPayment

object
User provided settings to manage card payments. This data is only allowed on a business account.
Show child attributes

statementDescriptor

string [4 to 22] characters Pattern
The description that shows up on credit card transactions. This will default to the accounts display name on account creation.

termsOfService

object
Describes the acceptance of the Terms of Service.
Show child attributes

acceptedDate

string<date-time> required
The date and time the terms of service were accepted.

acceptedIP

string<ipv4> required
The IP address from which the terms of service were accepted.

updatedOn

string<date-time>

verification

object
Describes identity verification status and relevant identity verification documents.
Show child attributes

status

string<enum> required deprecated
Possible states an account verification can be in.
Possible values: unverified, pending, verified, errored

details

string<enum> deprecated
Additional detail for a verification status.
Possible values: failedAutoVerify, docDobMismatch, docNameMismatch, docAddressMismatch, docNumberMismatch, docIncomplete, docFailedRisk, potentialAccountSanctionsMatch, potentialRepresentativeSanctionsMatch, failedOther

documents

array
Show child attributes

contentType

string
The document's MIME type.

documentID

string<uuid>

parseErrors

array
Optional array of errors encountered during automated parsing.

type

string<enum>
Types of documents that can be uploaded.
Possible values: driversLicense, passport, utilityBill, bankStatement

uploadedAt

string<date-time>

verificationStatus

string<enum> deprecated
Possible states an account verification can be in.
Possible values: unverified, pending, resubmit, review, verified, failed
OSZAR »