Representatives

(representatives())

Overview

Available Operations

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 to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.write scope.

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 to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.read scope.

delete - Deletes a business representative associated with a Moov account. Read our business representatives guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.write scope.

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

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.read scope.

update - If a representative's information has changed you can patch the information associated with a specific representative ID. Read our business representatives guide 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 you'll need to specify the /accounts/{accountID}/representatives.write scope.

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 to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Address;
import io.moov.sdk.models.components.BirthDate;
import io.moov.sdk.models.components.CreateRepresentative;
import io.moov.sdk.models.components.IndividualName;
import io.moov.sdk.models.components.PhoneNumber;
import io.moov.sdk.models.components.RepresentativeResponsibilities;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.errors.RepresentativeValidationError;
import io.moov.sdk.models.operations.CreateRepresentativeResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, RepresentativeValidationError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateRepresentativeResponse res = sdk.representatives().create()
                .xMoovVersion("v2024.01")
                .accountID("602bcb92-e33e-47e9-874b-f8c8cdea8a6e")
                .createRepresentative(CreateRepresentative.builder()
                    .name(IndividualName.builder()
                        .firstName("Jordan")
                        .lastName("Lee")
                        .middleName("Reese")
                        .suffix("Jr")
                        .build())
                    .phone(PhoneNumber.builder()
                        .number("8185551212")
                        .countryCode("1")
                        .build())
                    .email("jordan.lee@classbooker.dev")
                    .address(Address.builder()
                        .addressLine1("123 Main Street")
                        .city("Boulder")
                        .stateOrProvince("CO")
                        .postalCode("80301")
                        .country("US")
                        .addressLine2("Apt 302")
                        .build())
                    .birthDate(BirthDate.builder()
                        .day(9L)
                        .month(11L)
                        .year(1989L)
                        .build())
                    .responsibilities(RepresentativeResponsibilities.builder()
                        .ownershipPercentage(38L)
                        .jobTitle("CEO")
                        .build())
                    .build())
                .call();

        if (res.representative().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the account.
`createRepresentative`	CreateRepresentative	✔️	N/A

Response

CreateRepresentativeResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400, 409	application/json
models/errors/RepresentativeValidationError	422	application/json
models/errors/APIException	4XX, 5XX	/

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 to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListRepresentativesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListRepresentativesResponse res = sdk.representatives().list()
                .xMoovVersion("v2024.01")
                .accountID("33c72fc5-9781-4400-9547-0fa6966c8791")
                .call();

        if (res.representatives().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the account.

Response

ListRepresentativesResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

delete

Deletes a business representative associated with a Moov account. Read our business representatives guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.DeleteRepresentativeResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        DeleteRepresentativeResponse res = sdk.representatives().delete()
                .xMoovVersion("v2024.01")
                .accountID("8c15ae30-39cc-45a6-a9b1-f96dfd44efa8")
                .representativeID("302eff0a-1b46-4437-bfa0-532d4401ffcd")
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the account.
`representativeID`	String	✔️	ID of the representative.

Response

DeleteRepresentativeResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400, 409	application/json
models/errors/APIException	4XX, 5XX	/

get

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

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/representatives.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetRepresentativeResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetRepresentativeResponse res = sdk.representatives().get()
                .xMoovVersion("v2024.01")
                .accountID("64980616-9a3a-476e-b482-151eb6571b76")
                .representativeID("7b611595-93d0-48cc-9da4-3aac709d069a")
                .call();

        if (res.representative().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the account.
`representativeID`	String	✔️	ID of the representative.

Response

GetRepresentativeResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

update

If a representative's information has changed you can patch the information associated with a specific representative ID. Read our business representatives guide 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 you'll need to specify the /accounts/{accountID}/representatives.write scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.IndividualNameUpdate;
import io.moov.sdk.models.components.Phone;
import io.moov.sdk.models.components.Responsibilities;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.components.UpdateRepresentative;
import io.moov.sdk.models.components.UpdateRepresentativeAddress;
import io.moov.sdk.models.components.UpdateRepresentativeBirthDate;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.UpdateRepresentativeResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        UpdateRepresentativeResponse res = sdk.representatives().update()
                .xMoovVersion("v2024.01")
                .accountID("377d9553-179a-45f6-8ed4-c92810fbb4d0")
                .representativeID("54619159-548e-45ed-b917-271fb71fc438")
                .updateRepresentative(UpdateRepresentative.builder()
                    .name(IndividualNameUpdate.builder()
                        .firstName("Jordan")
                        .middleName("Reese")
                        .lastName("Lee")
                        .suffix("Jr")
                        .build())
                    .phone(Phone.builder()
                        .number("8185551212")
                        .countryCode("1")
                        .build())
                    .address(UpdateRepresentativeAddress.builder()
                        .addressLine1("123 Main Street")
                        .addressLine2("Apt 302")
                        .city("Boulder")
                        .stateOrProvince("CO")
                        .postalCode("80301")
                        .country("US")
                        .build())
                    .birthDate(UpdateRepresentativeBirthDate.builder()
                        .day(9L)
                        .month(11L)
                        .year(1989L)
                        .build())
                    .responsibilities(Responsibilities.builder()
                        .ownershipPercentage(38L)
                        .jobTitle("CEO")
                        .build())
                    .build())
                .call();

        if (res.representative().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`xMoovVersion`	Optional<String>	➖	Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is an optional build number starting at `.01` for subsequent builds in the same quarter. - If no build number is specified, the version refers to the initial release of the quarter. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
`accountID`	String	✔️	ID of the account.
`representativeID`	String	✔️	ID of the representative.
`updateRepresentative`	UpdateRepresentative	✔️	N/A

Response

UpdateRepresentativeResponse

Errors

Error Type	Status Code	Content Type
models/errors/GenericError	400, 409	application/json
models/errors/APIException	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Representatives

Overview

Available Operations

create

Example Usage

Parameters

Response

Errors

list

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

Files

README.md

Latest commit

History

README.md

File metadata and controls

Representatives

Overview

Available Operations

create

Example Usage

Parameters

Response

Errors

list

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors