Moov Representatives API

openapi: 3.2.0
info:
  title: Moov Representatives API
  version: '1.0'
  description: 'Operations tagged Representatives across 3 of this provider''s published API definitions: moov-api-v2026.01.00-openapi.yml, moov-openapi.yml, moov-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.moov.io
  description: Production API host
  variables: {}
tags:
- name: Representatives
paths:
  /accounts/{accountID}/representatives:
    post:
      operationId: createRepresentative
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        description: ID of the account.
        schema:
          type: string
      responses:
        '200':
          description: The request completed successfully.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Representative'
        '400':
          description: The server could not understand the request due to invalid syntax.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '404':
          description: The requested resource was not found.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '409':
          description: The request conflicted with the current state of the target resource.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '422':
          description: The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepresentativeValidationError'
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Representatives
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRepresentative'
      x-speakeasy-name-override: create
      security:
      - BasicAuth: []
      summary: Create representative
      x-summary-source: derived
    get:
      operationId: listRepresentatives
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        description: ID of the account.
        schema:
          type: string
      responses:
        '200':
          description: The request completed successfully.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Representative'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Representatives
      x-speakeasy-name-override: list
      security:
      - BasicAuth: []
      summary: List representatives
      x-summary-source: derived
    parameters:
    - $ref: '#/components/parameters/accountID'
    servers:
    - url: https://api.moov.io
      description: Production API host
      variables: {}
  /accounts/{accountID}/representatives/{representativeID}:
    delete:
      operationId: deleteRepresentative
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        description: ID of the account.
        schema:
          type: string
      - name: representativeID
        in: path
        required: true
        description: ID of the representative.
        schema:
          type: string
      responses:
        '204':
          description: The request completed successfully, but there is no content to return.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '400':
          description: The server could not understand the request due to invalid syntax.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '404':
          description: The requested resource was not found.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '409':
          description: The request conflicted with the current state of the target resource.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Representatives
      x-speakeasy-name-override: delete
      security:
      - BasicAuth: []
      summary: Delete representative
      x-summary-source: derived
    get:
      operationId: getRepresentative
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        description: ID of the account.
        schema:
          type: string
      - name: representativeID
        in: path
        required: true
        description: ID of the representative.
        schema:
          type: string
      responses:
        '200':
          description: The request completed successfully.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Representative'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '404':
          description: The requested resource was not found.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Representatives
      x-speakeasy-name-override: get
      security:
      - BasicAuth: []
      summary: Get representative
      x-summary-source: derived
    patch:
      operationId: updateRepresentative
      description: '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.'
      parameters:
      - $ref: '#/components/parameters/VersionHeader'
      - name: accountID
        in: path
        required: true
        description: ID of the account.
        schema:
          type: string
      - name: representativeID
        in: path
        required: true
        description: ID of the representative.
        schema:
          type: string
      responses:
        '200':
          description: The request completed successfully.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Representative'
        '400':
          description: The server could not understand the request due to invalid syntax.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '401':
          description: The request contained missing or expired authentication.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '403':
          description: The user is not authorized to make the request.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '404':
          description: The requested resource was not found.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '409':
          description: The request conflicted with the current state of the target resource.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericError'
        '429':
          description: Request was refused due to rate limiting.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '500':
          description: The request failed due to an unexpected error.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
        '504':
          description: The request failed because a downstream service failed to respond.
          headers:
            x-request-id:
              required: true
              description: A unique identifier used to trace requests.
              schema:
                type: string
      tags:
      - Representatives
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRepresentative'
      x-speakeasy-name-override: update
      security:
      - BasicAuth: []
      summary: Update representative
      x-summary-source: derived
    parameters:
    - $ref: '#/components/parameters/accountID'
    - $ref: '#/components/parameters/representativeID'
    servers:
    - url: https://api.moov.io
      description: Production API host
      variables: {}
components:
  schemas:
    PhoneNumberError:
      type: object
      properties:
        number:
          type: string
        countryCode:
          type: string
    Address:
      type: object
      required:
      - addressLine1
      - city
      - stateOrProvince
      - postalCode
      - country
      properties:
        addressLine1:
          type: string
          maxLength: 60
          pattern: '[a-zA-Z0-9,.\/?:''"|~!@#$%^&*()+_= -]+'
          example: 123 Main Street
        addressLine2:
          type: string
          maxLength: 32
          pattern: '[a-zA-Z0-9,.\/?:''"|~!@#$%^&*()+_= -]+'
          example: Apt 302
        city:
          type: string
          maxLength: 32
          pattern: '[a-zA-Z0-9,.\/?:''"|~!@#$%^&*()+_= -]+'
          example: Boulder
        stateOrProvince:
          type: string
          maxLength: 2
          example: CO
        postalCode:
          type: string
          maxLength: 5
          example: '80301'
        country:
          type: string
          maxLength: 2
          example: US
    PhoneNumber:
      type: object
      properties:
        number:
          type: string
          maxLength: 10
          example: '8185551212'
        countryCode:
          type: string
          maxLength: 1
          example: '1'
    Email:
      type: string
      maxLength: 255
      format: email
      example: jordan.lee@classbooker.dev
    BirthDate:
      type: object
      required:
      - day
      - month
      - year
      properties:
        day:
          type: integer
          example: 9
        month:
          type: integer
          example: 11
        year:
          type: integer
          example: 1989
    BirthDateUpdate:
      type: object
      properties:
        day:
          type: integer
          example: 9
        month:
          type: integer
          example: 11
        year:
          type: integer
          example: 1989
    IndividualNameUpdate:
      type: object
      properties:
        firstName:
          type: string
          maxLength: 64
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: The individual's first given name.
          example: Jordan
        middleName:
          type: string
          maxLength: 64
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: The individual's second given name, if any.
          example: Reese
        lastName:
          type: string
          maxLength: 64
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: The individual's family name.
          example: Lee
        suffix:
          type: string
          maxLength: 20
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: Suffix of a given name.
          example: Jr
    RepresentativeValidationError:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          properties:
            name:
              $ref: '#/components/schemas/IndividualNameError'
            phone:
              $ref: '#/components/schemas/PhoneNumberError'
            email:
              type: string
            address:
              $ref: '#/components/schemas/AddressError'
            birthDate:
              $ref: '#/components/schemas/BirthDateValidationError'
            governmentID:
              $ref: '#/components/schemas/GovernmentIDError'
            responsibilities:
              $ref: '#/components/schemas/RepresentativeResponsibilitiesError'
    CreateRepresentative:
      type: object
      properties:
        birthDate:
          $ref: '#/components/schemas/BirthDate'
        governmentID:
          $ref: '#/components/schemas/GovernmentID'
        responsibilities:
          $ref: '#/components/schemas/RepresentativeResponsibilities'
      allOf:
      - type: object
        required:
        - name
        properties:
          name:
            $ref: '#/components/schemas/IndividualName'
          phone:
            $ref: '#/components/schemas/PhoneNumber'
          email:
            $ref: '#/components/schemas/Email'
          address:
            $ref: '#/components/schemas/Address'
        description: The template for omitting properties.
      description: Describes a business representative to create.
    GovernmentID:
      type: object
      properties:
        ssn:
          type: object
          properties:
            full:
              type: string
              pattern: ^\d{3}[-]?\d{2}[-]?\d{4}$
            lastFour:
              type: string
        itin:
          type: object
          properties:
            full:
              type: string
              pattern: ^\d{3}[-]?\d{2}[-]?\d{4}$
            lastFour:
              type: string
    IndividualNameError:
      type: object
      properties:
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        suffix:
          type: string
    Representative:
      type: object
      required:
      - representativeID
      - name
      - createdOn
      - updatedOn
      properties:
        representativeID:
          type: string
          description: Unique identifier for this representative.
        name:
          $ref: '#/components/schemas/IndividualName'
        phone:
          $ref: '#/components/schemas/PhoneNumber'
        email:
          $ref: '#/components/schemas/Email'
        address:
          $ref: '#/components/schemas/Address'
        birthDateProvided:
          type: boolean
          description: Indicates whether this representative's birth date has been provided.
        governmentIDProvided:
          type: boolean
          description: Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this representative.
        responsibilities:
          $ref: '#/components/schemas/RepresentativeResponsibilities'
        createdOn:
          type: string
          format: date-time
        updatedOn:
          type: string
          format: date-time
        disabledOn:
          type: string
          format: date-time
      description: Describes a business representative.
    BirthDateValidationError:
      type: object
      properties:
        day:
          type: string
        month:
          type: string
        year:
          type: string
    AddressError:
      type: object
      properties:
        addressLine1:
          type: string
        addressLine2:
          type: string
        city:
          type: string
        stateOrProvince:
          type: string
        postalCode:
          type: string
        country:
          type: string
    GenericError:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    AddressUpdate:
      type: object
      properties:
        addressLine1:
          type: string
          maxLength: 60
          pattern: '[a-zA-Z0-9,.\/?:''"|~!@#$%^&*()+_= -]+'
          example: 123 Main Street
        addressLine2:
          type: string
          maxLength: 32
          pattern: '[a-zA-Z0-9,.\/?:''"|~!@#$%^&*()+_= -]+'
          example: Apt 302
        city:
          type: string
          maxLength: 32
          pattern: '[a-zA-Z0-9,.\/?:''"|~!@#$%^&*()+_= -]+'
          example: Boulder
        stateOrProvince:
          type: string
          maxLength: 2
          example: CO
        postalCode:
          type: string
          maxLength: 5
          example: '80301'
        country:
          type: string
          maxLength: 2
          example: US
    IndividualName:
      type: object
      required:
      - firstName
      - lastName
      properties:
        firstName:
          type: string
          maxLength: 64
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: The individual's first given name.
          example: Jordan
        middleName:
          type: string
          maxLength: 64
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: The individual's second given name, if any.
          example: Reese
        lastName:
          type: string
          maxLength: 64
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: The individual's family name.
          example: Lee
        suffix:
          type: string
          maxLength: 20
          pattern: '[À-ÖØ-öø-ÿ"''(),.0-9A-Za-z~ &!-]*'
          description: Suffix of a given name.
          example: Jr
    UpdateRepresentative:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/IndividualNameUpdate'
        phone:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/PhoneNumber'
        email:
          type:
          - string
          - 'null'
          allOf:
          - $ref: '#/components/schemas/Email'
        address:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/AddressUpdate'
        birthDate:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/BirthDateUpdate'
        governmentID:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/GovernmentID'
        responsibilities:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/RepresentativeResponsibilities'
    GovernmentIDError:
      type: object
      properties:
        ssn:
          type: object
          properties:
            full:
              type: string
            lastFour:
              type: string
        itin:
          type: object
          properties:
            full:
              type: string
            lastFour:
              type: string
    RepresentativeResponsibilities:
      type: object
      properties:
        isController:
          type: boolean
          description: Indicates whether this individual has significant management responsibilities within the business.
        isOwner:
          type: boolean
          description: '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`.'
        ownershipPercentage:
          type: integer
          description: The percentage of ownership this individual has in the business (required if `isOwner` is `true`).
          example: 38
        jobTitle:
          type: string
          maxLength: 64
          pattern: '[a-zA-Z0-9,.\/?:''"|~!@#$%^&*()+_= -]+'
          example: CEO
      description: Describes the job responsibilities of a business representative.
    RepresentativeResponsibilitiesError:
      type: object
      properties:
        isController:
          type: string
        isOwner:
          type: string
        ownershipPercentage:
          type: string
        jobTitle:
          type: string
  parameters:
    VersionHeader:
      name: X-Moov-Version
      in: header
      required: false
      description: 'Set this header to v2026.01.00 to use the API described in this specification.

        When omitted, the server defaults to v2024.01.00, the earliest supported version, which may not match the behavior documented here.

        An unrecognized well-formed version uses the latest supported version that is not newer than the requested version, when one exists.

        For example, `v2026.08.00` uses `v2026.07.00`.

        A malformed value, such as `2022`, returns a `404` response.'
      schema:
        type: string
        enum:
        - v2026.01.00
        example: v2026.01.00
        x-speakeasy-ignore: true
      x-speakeasy-ignore: true
    representativeID:
      name: representativeID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    accountID:
      name: accountID
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: The Moov account identifier.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: Basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token passed as a Bearer token.
x-refined-from:
- moov-api-v2026.01.00-openapi.yml
- moov-openapi.yml
- moov-openapi.yml