Package io.moov.sdk

Class Representatives

java.lang.Object

io.moov.sdk.Representatives

public class Representatives
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CreateRepresentativeRequestBuilder	create()	Moov accounts associated with businesses require information regarding individuals who represent the business.
CreateRepresentativeResponse	create(java.lang.String accountID, CreateRepresentative createRepresentative)	Moov accounts associated with businesses require information regarding individuals who represent the business.
DeleteRepresentativeRequestBuilder	delete()	Deletes a business representative associated with a Moov account.
DeleteRepresentativeResponse	delete(java.lang.String accountID, java.lang.String representativeID)	Deletes a business representative associated with a Moov account.
GetRepresentativeRequestBuilder	get()	Retrieve a specific representative associated with a given Moov account.
GetRepresentativeResponse	get(java.lang.String accountID, java.lang.String representativeID)	Retrieve a specific representative associated with a given Moov account.
ListRepresentativesRequestBuilder	list()	A Moov account may have multiple representatives depending on the associated business's ownership and management structure.
ListRepresentativesResponse	list(java.lang.String accountID)	A Moov account may have multiple representatives depending on the associated business's ownership and management structure.
UpdateRepresentativeRequestBuilder	update()	If a representative's information has changed you can patch the information associated with a specific representative ID.
UpdateRepresentativeResponse	update(java.lang.String accountID, java.lang.String representativeID, UpdateRepresentative updateRepresentative)	If a representative's information has changed you can patch the information associated with a specific representative ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public CreateRepresentativeRequestBuilder create()

Moov accounts associated with businesses require information regarding individuals who represent the business. You can provide this information by creating a representative. Each account is allowed a maximum of 7 representatives. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.write` scope.

Returns:

The call builder

create

public CreateRepresentativeResponse create(java.lang.String accountID,
                                           CreateRepresentative createRepresentative)
                                    throws java.lang.Exception

Moov accounts associated with businesses require information regarding individuals who represent the business. You can provide this information by creating a representative. Each account is allowed a maximum of 7 representatives. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.write` scope.

Parameters:

accountID - ID of the account.

createRepresentative - Describes a business representative to create.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListRepresentativesRequestBuilder list()

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. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.read` scope.

Returns:

The call builder

list

public ListRepresentativesResponse list(java.lang.String accountID)
                                 throws java.lang.Exception

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. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.read` scope.

Parameters:

accountID - ID of the account.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

delete

public DeleteRepresentativeRequestBuilder delete()

Deletes a business representative associated with a Moov account. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.write` scope.

Returns:

The call builder

delete

public DeleteRepresentativeResponse delete(java.lang.String accountID,
                                           java.lang.String representativeID)
                                    throws java.lang.Exception

Deletes a business representative associated with a Moov account. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.write` scope.

Parameters:

accountID - ID of the account.

representativeID - ID of the representative.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetRepresentativeRequestBuilder get()

Retrieve a specific representative associated with a given Moov account. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.read` scope.

Returns:

The call builder

get

public GetRepresentativeResponse get(java.lang.String accountID,
                                     java.lang.String representativeID)
                              throws java.lang.Exception

Retrieve a specific representative associated with a given Moov account. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.read` scope.

Parameters:

accountID - ID of the account.

representativeID - ID of the representative.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

update

public UpdateRepresentativeRequestBuilder update()

If a representative's information has changed you can patch the information associated with a specific representative ID. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

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.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.write` scope.

Returns:

The call builder

update

public UpdateRepresentativeResponse update(java.lang.String accountID,
                                           java.lang.String representativeID,
                                           UpdateRepresentative updateRepresentative)
                                    throws java.lang.Exception

If a representative's information has changed you can patch the information associated with a specific representative ID. Read our [business representatives guide](https://docs.moov.io/guides/accounts/requirements/business-representatives/) to learn more.

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.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/representatives.write` scope.

Parameters:

accountID - ID of the account.

representativeID - ID of the representative.

updateRepresentative -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails