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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$createRepresentative = new Components\CreateRepresentative(
    name: new Components\IndividualName(
        firstName: 'Jordan',
        middleName: 'Reese',
        lastName: 'Lee',
        suffix: 'Jr',
    ),
    phone: new Components\PhoneNumber(
        number: '8185551212',
        countryCode: '1',
    ),
    email: 'jordan.lee@classbooker.dev',
    address: new Components\Address(
        addressLine1: '123 Main Street',
        addressLine2: 'Apt 302',
        city: 'Boulder',
        stateOrProvince: 'CO',
        postalCode: '80301',
        country: 'US',
    ),
    birthDate: new Components\BirthDate(
        day: 9,
        month: 11,
        year: 1989,
    ),
    responsibilities: new Components\RepresentativeResponsibilities(
        ownershipPercentage: 38,
        jobTitle: 'CEO',
    ),
);

$response = $sdk->representatives->create(
    accountID: '7a621cf0-21cd-49cf-8540-3315211a509a',
    createRepresentative: $createRepresentative,
    xMoovVersion: 'v2024.01.00'

);

if ($response->representative !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
`accountID`	string	✔️	ID of the account.
`createRepresentative`	Components\CreateRepresentative	✔️	N/A
`xMoovVersion`	?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 the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Response

?Operations\CreateRepresentativeResponse

Errors

Error Type	Status Code	Content Type
Errors\GenericError	400, 409	application/json
Errors\RepresentativeValidationError	422	application/json
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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->representatives->list(
    accountID: 'c8a232aa-0b11-4b8a-b005-71e9e705d0e6',
    xMoovVersion: 'v2024.01.00'

);

if ($response->representatives !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
`accountID`	string	✔️	ID of the account.
`xMoovVersion`	?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 the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Response

?Operations\ListRepresentativesResponse

Errors

Error Type	Status Code	Content Type
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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->representatives->delete(
    accountID: '8b6fe91a-a0b1-4b3e-ab7b-e83a32f2399e',
    representativeID: '7aa10743-a04f-44af-84fe-b54259caa1ba',
    xMoovVersion: 'v2024.01.00'

);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
`accountID`	string	✔️	ID of the account.
`representativeID`	string	✔️	ID of the representative.
`xMoovVersion`	?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 the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Response

?Operations\DeleteRepresentativeResponse

Errors

Error Type	Status Code	Content Type
Errors\GenericError	400, 409	application/json
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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->representatives->get(
    accountID: 'b888f774-3e7c-4135-a18c-6b985523c4bc',
    representativeID: 'e50f7622-81da-484b-9c66-1c8a99c6b71b',
    xMoovVersion: 'v2024.01.00'

);

if ($response->representative !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
`accountID`	string	✔️	ID of the account.
`representativeID`	string	✔️	ID of the representative.
`xMoovVersion`	?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 the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Response

?Operations\GetRepresentativeResponse

Errors

Error Type	Status Code	Content Type
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

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$updateRepresentative = new Components\UpdateRepresentative(
    name: new Components\IndividualNameUpdate(
        firstName: 'Jordan',
        middleName: 'Reese',
        lastName: 'Lee',
        suffix: 'Jr',
    ),
    phone: new Components\Phone(
        number: '8185551212',
        countryCode: '1',
    ),
    address: new Components\UpdateRepresentativeAddress(
        addressLine1: '123 Main Street',
        addressLine2: 'Apt 302',
        city: 'Boulder',
        stateOrProvince: 'CO',
        postalCode: '80301',
        country: 'US',
    ),
    birthDate: new Components\UpdateRepresentativeBirthDate(
        day: 9,
        month: 11,
        year: 1989,
    ),
    responsibilities: new Components\Responsibilities(
        ownershipPercentage: 38,
        jobTitle: 'CEO',
    ),
);

$response = $sdk->representatives->update(
    accountID: 'd95fa7f0-e743-42ce-b47c-b60cc78135dd',
    representativeID: 'b85898c1-25a1-4907-a1c5-562af6646dad',
    updateRepresentative: $updateRepresentative,
    xMoovVersion: 'v2024.01.00'

);

if ($response->representative !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
`accountID`	string	✔️	ID of the account.
`representativeID`	string	✔️	ID of the representative.
`updateRepresentative`	Components\UpdateRepresentative	✔️	N/A
`xMoovVersion`	?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 the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Response

?Operations\UpdateRepresentativeResponse

Errors

Error Type	Status Code	Content Type
Errors\GenericError	400, 409	application/json
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