Retrieve an account

Retrieves details for the account with the specified ID.

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

GET

/accounts/{accountID}

cURL Go

1
2


curl -X GET "https://api.moov.io/accounts/{accountID}" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5


mc, _ := moov.NewClient()

var accountID string

mc.GetAccount(ctx, accountID)

200 401 403 404 429 500 504

The request completed successfully.

{
  "accountID": "53ca67ea-6fd3-423f-9544-ce2404159d33",
  "accountType": "business",
  "createdOn": "2024-12-16T17:55:20.557151867Z",
  "displayName": "Whole Body Fitness LLC",
  "mode": "sandbox",
  "profile": {
    "business": {
      "legalBusinessName": "Whole Body Fitness LLC",
      "ownersProvided": false
    }
  },
  "settings": {
    "achPayment": {
      "companyName": "Whole Body Fitne"
    },
    "cardPayment": {
      "statementDescriptor": "Whole Body Fitness LLC"
    }
  },
  "updatedOn": "2024-12-16T17:55:20.557151867Z",
  "verification": {
    "status": "unverified",
    "verificationStatus": "unverified"
  }
}

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request contained missing or expired authentication.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The user is not authorized to make the request.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The requested resource was not found.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Request was refused due to rate limiting.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed due to an unexpected error.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed because a downstream service failed to respond.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Headers

x-moov-version


      string

API version

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.

Default: v2024.01.00

Path parameters

accountID


      string
      <uuid>

required

Response

application/json

accountID


        string<uuid>

required

Unique identifier for this account.

accountType


        string<enum>

required

The type of entity represented by this account.

Possible values: individual, business

createdOn


        string<date-time>

required

displayName


        string

<=64 characters required

mode


        string<enum>

required

The operating mode for an account.

Possible values: sandbox, production

profile


        object

required

Describes a Moov account profile. A profile will have a business or an individual, depending on the account’s type.

Show child attributes

business


        object

Describes a business.

Show child attributes

legalBusinessName


        string

<=64 characters required

The legal name under which the entity is registered.

ownersProvided


        boolean

required

address


        object

Show child attributes

addressLine1


        string

<=60 characters required

city


        string

<=32 characters required

country


        string

<=2 characters required

postalCode


        string

<=5 characters required

stateOrProvince


        string

<=2 characters required

addressLine2


        string

<=32 characters

businessType


        string<enum>

The type of entity represented by this business.

Possible values: soleProprietorship, unincorporatedAssociation, trust, publicCorporation, privateCorporation, llc, partnership, unincorporatedNonProfit, incorporatedNonProfit, governmentEntity

description


        string

[10 to 100] characters

doingBusinessAs


        string

<=64 characters

A registered trade name under which the business operates, if different from its legal name.

email


        string<email>

<=255 characters

industryCodes


        object

Show child attributes

mcc


        string

4 characters

naics


        string

[2 to 6] characters

sic


        string

4 characters

phone


        object

Show child attributes

countryCode


        string

<=1 characters

number


        string

<=10 characters

primaryRegulator


        string<enum>

If the business is a financial institution, this field describes its primary regulator.

Possible values: OCC, FDIC, NCUA, FRB

representatives


        array

Show child attributes

address


        object

Show child attributes

addressLine1


        string

<=60 characters required

city


        string

<=32 characters required

country


        string

<=2 characters required

postalCode


        string

<=5 characters required

stateOrProvince


        string

<=2 characters required

addressLine2


        string

<=32 characters

birthDateProvided


        boolean

Indicates whether this representative’s birth date has been provided.

createdOn


        string<date-time>

disabledOn


        string<date-time>

email


        string<email>

<=255 characters

governmentIDProvided


        boolean

Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this representative.

name


        object

Show child attributes

firstName


        string

<=64 characters required

The individual’s first given name.

lastName


        string

<=64 characters required

The individual’s family name.

middleName


        string

<=64 characters

The individual’s second given name, if any.

suffix


        string

<=20 characters

Suffix of a given name.

phone


        object

Show child attributes

countryCode


        string

<=1 characters

number


        string

<=10 characters

representativeID


        string<uuid>

Unique identifier for this representative.

responsibilities


        object

Describes the job responsibilities of a business representative.

Show child attributes

isController


        boolean

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

isOwner


        boolean

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

ownershipPercentage


        integer

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

updatedOn


        string<date-time>

taxIDProvided


        boolean

Indicates whether a tax ID has been provided for this business.

website


        string<uri>

<=100 characters

individual


        object

Describes an individual.

Show child attributes

name


        object

required

Show child attributes

firstName


        string

<=64 characters required

The individual’s first given name.

lastName


        string

<=64 characters required

The individual’s family name.

middleName


        string

<=64 characters

The individual’s second given name, if any.

suffix


        string

<=20 characters

Suffix of a given name.

address


        object

Show child attributes

addressLine1


        string

<=60 characters required

city


        string

<=32 characters required

country


        string

<=2 characters required

postalCode


        string

<=5 characters required

stateOrProvince


        string

<=2 characters required

addressLine2


        string

<=32 characters

birthDateProvided


        boolean

Indicates whether this individual’s birth date has been provided.

email


        string<email>

<=255 characters

governmentIDProvided


        boolean

Indicates whether a government ID (SSN, ITIN, etc.) has been provided for this individual.

phone


        object

Show child attributes

countryCode


        string

<=1 characters

number


        string

<=10 characters

updatedOn


        string<date-time>

required

verification


        object

required

Describes identity verification status and relevant identity verification documents.

Show child attributes

status


        string<enum>

required deprecated

Possible states an account verification can be in.

Possible values: unverified, pending, verified, errored

details


        string<enum>

deprecated

Additional detail for a verification status.

Possible values: failedAutoVerify, docDobMismatch, docNameMismatch, docAddressMismatch, docNumberMismatch, docIncomplete, docFailedRisk, potentialAccountSanctionsMatch, potentialRepresentativeSanctionsMatch, failedOther

documents


        array

Show child attributes

contentType


        string

The document’s MIME type.

documentID


        string<uuid>

parseErrors


        array

Optional array of errors encountered during automated parsing.

type


        string<enum>

Types of documents that can be uploaded.

Possible values: driversLicense, passport, utilityBill, bankStatement

uploadedAt


        string<date-time>

verificationStatus


        string<enum>

deprecated

Possible states an account verification can be in.

Possible values: unverified, pending, resubmit, review, verified, failed

capabilities


        array

Show child attributes

capability


        string

status


        string

customerSupport


        object

User-provided information that can be displayed on credit card transactions for customers to use when contacting a customer support team. This data is only allowed on a business account.

Show child attributes

address


        object

Show child attributes

addressLine1


        string

<=60 characters required

city


        string

<=32 characters required

country


        string

<=2 characters required

postalCode


        string

<=5 characters required

stateOrProvince


        string

<=2 characters required

addressLine2


        string

<=32 characters

email


        string<email>

<=255 characters

phone


        object

Show child attributes

countryCode


        string

<=1 characters

number


        string

<=10 characters

website


        string<uri>

disconnectedOn


        string<date-time>

foreignID


        string

<=64 characters

Optional alias from a foreign/external system which can be used to reference this resource.

metadata


        object

Free-form key-value pair list. Useful for storing information that is not captured elsewhere.

settings


        object

User provided settings to manage an account.

Show child attributes

achPayment


        object

Show child attributes

companyName


        string

[1 to 16] characters required

The description that shows up on ACH transactions. This will default to the account’s display name on account creation.

cardPayment


        object

User provided settings to manage card payments. This data is only allowed on a business account.

Show child attributes

statementDescriptor


        string

[4 to 22] characters

The description that shows up on credit card transactions. This will default to the accounts display name on account creation.

termsOfService


        object

Describes the acceptance of the Terms of Service.

Show child attributes

acceptedDate


        string<date-time>

required

The date and time the terms of service were accepted.

acceptedIP


        string<ipv4>

required

The IP address from which the terms of service were accepted.

cURL Go

1
2


curl -X GET "https://api.moov.io/accounts/{accountID}" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5


mc, _ := moov.NewClient()

var accountID string

mc.GetAccount(ctx, accountID)

200 401 403 404 429 500 504

The request completed successfully.

{
  "accountID": "53ca67ea-6fd3-423f-9544-ce2404159d33",
  "accountType": "business",
  "createdOn": "2024-12-16T17:55:20.557151867Z",
  "displayName": "Whole Body Fitness LLC",
  "mode": "sandbox",
  "profile": {
    "business": {
      "legalBusinessName": "Whole Body Fitness LLC",
      "ownersProvided": false
    }
  },
  "settings": {
    "achPayment": {
      "companyName": "Whole Body Fitne"
    },
    "cardPayment": {
      "statementDescriptor": "Whole Body Fitness LLC"
    }
  },
  "updatedOn": "2024-12-16T17:55:20.557151867Z",
  "verification": {
    "status": "unverified",
    "verificationStatus": "unverified"
  }
}

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request contained missing or expired authentication.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The user is not authorized to make the request.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The requested resource was not found.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

Request was refused due to rate limiting.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed due to an unexpected error.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.

The request failed because a downstream service failed to respond.

x-request-id


      string
      <uuid>

required

A unique identifier used to trace requests.