Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases
SDKs & UIs
API Changelog
  1. API reference
  2. Moov accounts
  3. Business representatives

List representatives

A Moov account may have multiple representatives depending on the associated business’s ownership and management structure. You can use this method to list all the representatives for a given Moov account. Note that Moov accounts associated with an individual do not have representatives.

To use this endpoint from the browser, you need to specify the /accounts/{accountID}/representatives.read scope when generating a token.
GET
/accounts/{accountID}/representatives
200 429
Successfully retrieved representatives
[
  {
    "address": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Apt 302",
      "city": "Boulder",
      "country": "US",
      "postalCode": "80301",
      "stateOrProvince": "CO"
    },
    "birthDateProvided": false,
    "createdOn": "2019-08-24T14:15:22Z",
    "disabledOn": "2019-08-24T14:15:22Z",
    "email": "amanda@classbooker.dev",
    "governmentIDProvided": false,
    "name": {
      "firstName": "Amanda",
      "lastName": "Yang",
      "middleName": "Amanda",
      "suffix": "Jr"
    },
    "phone": {
      "countryCode": "1",
      "number": "8185551212"
    },
    "representativeID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "responsibilities": {
      "isController": false,
      "isOwner": true,
      "jobTitle": "CEO",
      "ownershipPercentage": 38
    },
    "updatedOn": "2019-08-24T14:15:22Z"
  }
]
Request was refused due to rate limiting.

Response headers

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

address

object
right_key Show child attributes

addressLine1

string <=60 characters required

addressLine2

string <=32 characters

city

string <=24 characters required

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

birthDateProvided

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

createdOn

string<date-time> <=24 characters

disabledOn

string

email

string<email> <=255 characters Pattern
Email address.

governmentIDProvided

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

name

object
An individual’s name.
right_key Show child attributes

firstName

string <=64 characters required Pattern
Name this person was given. This is usually the the same as first name.

lastName

string <=64 characters required Pattern
Family name of this person. This is usually the the same as last name.

middleName

string <=64 characters Pattern
Name this person was given. This is usually the the same as first name.

suffix

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

phone

object
right_key Show child attributes

countryCode

string <=1 characters

number

string<phone> <=10 characters

representativeID

string<uuid> <=36 characters Pattern
UUID v4

responsibilities

object
Describes the job responsibilities of an individual.
right_key Show child attributes

isController

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

isOwner

boolean required
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 required

ownershipPercentage

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

updatedOn

string<date-time> <=24 characters