Update a representative

If a representative’s information has changed you can patch the information associated with a specific representative ID.

To use this endpoint from the browser, you’ll need to specify the /accounts/{accountID}/representatives.write scope when generating a token, and provide the changed information.

When can profile data be updated:

For unverified representatives, all profile data can be edited.
During the verification process, missing or incomplete profile data can be edited.
Verified representatives can only add missing profile data.

When can’t profile data be updated:

Verified representatives cannot change any existing profile data.

If you need to update information in a locked state, please contact Moov support.

PATCH

/accounts/{accountID}/representatives/{representativeID}

cURL JavaScript

1
2
3
4
5


curl -X PATCH "https://api.moov.io/accounts/{accountID}/representatives/{representativeID}"
  -H "Authorization: Bearer {token}" \
  --data-raw '{
    "email":"amandayang@classbooker.dev"
  }'\

1
2
3
4
5
6
7
8
9


const moov = new Moov(credentialsObject);

const accountID = "accountID";
const representativeID = "representativeID";
const accountPayload = {
  email: "amandayang@classbooker.dev"
};

const account = await moov.representatives.update(accountID, representativeID, accountPayload);

200 404 409 422 429

representative patched

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"
}

The specified account or representative was not found.

Representative fields locked due to verification status.

The request body could not be processed.

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.

representativeID


      string
      <uuid>

required

ID of the representative.

Body

application/json

Describes the fields available when patching a representative.

address


        object

An individual’s residential address. Business addresses not accepted.

Show child attributes

addressLine1


        string

<=32 characters

addressLine2


        string

<=32 characters

city


        string

<=24 characters

country


        string

<=2 characters

postalCode


        string

<=5 characters

stateOrProvince


        string

<=2 characters

birthDate


        object

An individual’s birthdate.

Show child attributes

day


        integer

required

month


        integer

required

year


        integer

required

email


        string

Email address.

governmentID


        object

Show child attributes

itin


        object

Show child attributes

full


        string

<=64 characters

lastFour


        string

<=4 characters

ssn


        object

Show child attributes

full


        string

<=64 characters

lastFour


        string

<=4 characters

name


        object

An individual’s name.

Show child attributes

firstName


        string

Name this person was given. This is usually the the same as first name.

lastName


        string

Family name of this person. This is usually the the same as last name.

middleName


        string

Name this person was given. This is usually the the same as first name.

suffix


        string

Suffix of a given name.

phone


        object

Show child attributes

countryCode


        string

<=1 characters

number


        string<phone>

<=10 characters

responsibilities


        object

Describes the job responsibilities of an individual.

Show child attributes

isController


        boolean

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

isOwner


        boolean

If true, this field indicates 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

ownershipPercentage


        integer

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

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

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

Name this person was given. This is usually the the same as first name.

lastName


        string

<=64 characters required

Family name of this person. This is usually the the same as last name.

middleName


        string

<=64 characters

Name this person was given. This is usually the the same as first name.

suffix


        string

<=20 characters

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 v4

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

Update a representative

Response headers

Was this helpful?