Representatives

We require all business accounts to have valid information for at least one representative. Moov accounts must have verified business representatives before a business account can send funds, collect money from other accounts, or store funds in a wallet.

Create

Create representative The REPRESENTATIVE_WRITE scope enum is required when making a request from the browser.

1

representatives.create(accountID, representative)

Parameters

Name	Type	Description
accountID	`string`	Account on which to add representative
representative	RepresentativeCreateUpdate	Representative to add

Returns

Promise.<Representative>

List

List representatives The REPRESENTATIVE_READ scope enum is required when making a request from the browser.

1

representatives.list(accountID)

Parameters

Name	Type	Description
accountID	`string`	Account on which to add representative

Returns

Promise.<Array.<Representative>>

Get

Retrieve a specific representative associated with a given Moov account. The REPRESENTATIVE_READ scope enum is required when making a request from the browser.

1

representatives.get(accountID, representativeID)

Parameters

Name	Type	Description
accountID	`string`	Account on which to add representative
representativeID	`string`	Identifier of representative to retrieve

Returns

Promise.<Representative>

Delete

Deletes a business representative associated with a Moov account. The REPRESENTATIVE_WRITE scope enum is required when making a request from the browser.

1

representatives.delete(accountID, representativeID)

Parameters

Name	Type	Description
accountID	`string`	Account on which to add representative
representativeID	`string`	Identifier of representative to retrieve

Returns

Promise.<void>

Update

Update a specific representative. The REPRESENTATIVE_WRITE scope enum is required when making a request from the browser.

1

representatives.update(accountID, representativeID, representative)

Parameters

Name	Type	Description
accountID	`string`	Account on which to add representative
representativeID	`string`	Identifier of representative to retrieve
representative	RepresentativeCreateUpdate	Representative to add

Returns

Promise.<Representative>

Types

Representative

Describes an individual who represents the business.

Properties

Property	Type	Description
representativeID	`string`	Representative identifier
name	RepresentativeName	Name for an individual
phone	RepresentativePhone	Phone for an individual
email	`string`	Email Address. string <= 255 characters
address	RepresentativeAddress	Address for an individual.
birthDateProvided	`boolean`	Indicates whether this Representative’s birth date has been provided
governmentIDProvided	`boolean`	Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this Representative
responsibilities	RepresentativeResponsibilities	Describes the job responsibilities of an individual
createdOn	`Date`	Date Representative was created
updatedOn	`Date`	Date Representative was last updated
disabledOn	`Date`	Optional date Representative was disabled

 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


{
  "representativeID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "name": {
    "firstName": "Amanda",
    "middleName": "Amanda",
    "lastName": "Yang",
    "suffix": "Jr"
  },
  "phone": {
    "number": "8185551212",
    "countryCode": "1"
  },
  "email": "amanda@classbooker.dev",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 302",
    "city": "Boulder",
    "stateOrProvince": "CO",
    "postalCode": "80301",
    "country": "US"
  },
  "birthDateProvided": false,
  "governmentIDProvided": false,
  "responsibilities": {
    "isController": false,
    "isOwner": true,
    "ownershipPercentage": 38,
    "jobTitle": "CEO"
  },
  "createdOn": "2024-08-24T14:15:22Z",
  "updatedOn": "2024-08-24T14:15:22Z",
  "disabledOn": "2024-08-24T14:15:22Z"
}

RepresentativeName

Representative name

Properties

Property	Type	Description
firstName	`string`	Name this person was given. This is usually the same as first name. string <= 64 characters
middleName	`string`	Name this person was given. This is usually the same as middle name. string <= 64 characters
lastName	`string`	Family name of this person. This is usually the same as last name. string <= 64 characters
suffix	`string`	Suffix of a given name. string <= 20 characters

RepresentativePhone

Representative phone

Properties

Property	Type	Description
number	`string`	string <= 10 characters
countryCode	`string`	string <= 1 characters

RepresentativeAddress

Properties

Property	Type	Description
addressLine1	`string`	string <= 32 characters
addressLine2	`string`	string <= 32 characters
city	`string`	string <= 24 characters
stateOrProvince	`string`	string <= 2 characters
postalCode	`string`	string <= 5 characters
country	`string`	string <= 2 characters

RepresentativeResponsibilities

Properties

Property	Type	Description
isController	`boolean`	Indicates whether this individual has significant management responsibilities within the business
isOwner	`boolean`	Indiciates whether this individual has an ownership stake of at least 25% in the business
ownershipPercentage	`number`	The percentage of ownership this individual has in the business (required if `isOwner` is `true`)
jobTitle	`string`	string <= 64 characters

RepresentativeBirthDate

Properties

Property	Type	Description
day	`number`	1 or 2 digit day of birth
month	`number`	1 or 2 digit month of birth
year	`number`	4 digit year of birth

GovernmentID

Properties

Property	Type	Description
full	`string`	string <= 64 characters
lastFour	`string`	string <= 4 characters

RepresentativeGovernmentID

Properties

Property	Type	Description
ssn	GovernmentID	Social Security Number
itin	GovernmentID	Individual Taxpayer Identification Number

RepresentativeCreateUpdate

Properties

Property	Type	Description
name	RepresentativeName	Name for an individual
phone	RepresentativePhone	Phone for an individual
email	`string`	Email Address. string <= 255 characters
address	RepresentativeAddress	Address for an individual
birthDate	RepresentativeBirthDate	Birth date for an individual
governmentID	RepresentativeGovernmentID	Social Security Number, or Individual Taxpayer Identification Number
responsibilities	RepresentativeResponsibilities	Describes the job responsibilities of an individual

Was this helpful?