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

Retrieve a representative

Retrieve a specific representative associated with a given Moov account. Read our business representatives guide to learn more.

To use this endpoint from the browser, you’ll need to specify the /accounts/{accountID}/representatives.read scope when generating a token.
GET
/accounts/{accountID}/representatives/{representativeID}
cURL Go JavaScript 
1
2

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

1
2
3
4
5
6

mc, _ := moov.NewClient()

var accountID string
var representativeID string

mc.GetRepresentative(ctx, accountID, representativeID)

1
2
3

const moov = new Moov(credentialsObject);

const transfer = await moov.representatives.get(accountID, representativeID);
200 404 429
The representative.
Describes a business representative.
{
  "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"
}
No representative with the specified representativeID was found.
Request was refused due to rate limiting.

Response headers

Retry-After

number

Path parameters

accountID

string <uuid> required
ID of the account.

representativeID

string <uuid> required
ID of the representative.

Response

application/json
Describes a business representative.

address

object
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.
Show child attributes

firstName

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

lastName

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

middleName

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

suffix

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

phone

object
Show child attributes

countryCode

string <=1 characters

number

string<phone> <=10 characters

representativeID

string<uuid> <=36 characters
UUID

responsibilities

object
Describes the job responsibilities of an individual.
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