Create an account
You can create business or individual accounts for your users (i.e., customers, merchants) by passing the required information to Moov. Requirements differ per account type and requested capabilities.
If you’re requesting the wallet
, send-funds
, collect-funds
, or card-issuing
capabilities, you’ll need to:
- Send Moov the user platform terms of service agreement acceptance. This can be done upon account creation, or by patching the account using the
termsOfService
field.
If you’re creating a business account with the business type llc
, partnership
, or privateCorporation
, you’ll need to:
- Provide business representatives after creating the account.
- Patch the account to indicate that business representative ownership information is complete.
Visit our documentation to read more about creating accounts and verification requirements.
Note that the mode
field (for production or sandbox) is only required when creating a facilitator account. All non-facilitator account requests will ignore the mode field and be set to the calling facilitator’s mode.
To use this endpoint from the browser, you will need to specify the /accounts.write
scope when generating a token.
|
|
|
|
|
|
{
"accountID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"accountType": "business",
"capabilities": [
{
"capability": "transfers",
"status": "enabled"
}
],
"createdOn": "2019-08-24T14:15:22Z",
"customerSupport": {
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 302",
"city": "Boulder",
"country": "US",
"postalCode": "80301",
"stateOrProvince": "CO"
},
"email": "amanda@classbooker.dev",
"phone": {
"countryCode": "1",
"number": "8185551212"
},
"website": "www.wholebodyfitnessgym.com"
},
"disconnectedOn": "2019-08-24T14:15:22Z",
"displayName": "Whole Body Fitness",
"foreignID": "4528aba-b9a1-11eb-8529-0242ac13003",
"metadata": {
"property1": "string",
"property2": "string"
},
"mode": "production",
"profile": {
"business": {
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 302",
"city": "Boulder",
"country": "US",
"postalCode": "80301",
"stateOrProvince": "CO"
},
"businessType": "llc",
"description": "Local fitness gym paying out instructors",
"doingBusinessAs": "string",
"email": "amanda@classbooker.dev",
"industryCodes": {
"mcc": "7997",
"naics": "713940",
"sic": "7991"
},
"legalBusinessName": "string",
"ownersProvided": true,
"phone": {
"countryCode": "1",
"number": "8185551212"
},
"primaryRegulator": "FDIC",
"representatives": [],
"taxIDProvided": false,
"website": "www.wholebodyfitnessgym.com"
},
"individual": {
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 302",
"city": "Boulder",
"country": "US",
"postalCode": "80301",
"stateOrProvince": "CO"
},
"birthDateProvided": false,
"email": "amanda@classbooker.dev",
"governmentIDProvided": false,
"name": {
"firstName": "Amanda",
"lastName": "Yang",
"middleName": "Amanda",
"suffix": "Jr"
},
"phone": {
"countryCode": "1",
"number": "8185551212"
}
}
},
"settings": {
"achPayment": {
"companyName": "Whole Body Fitness"
},
"cardPayment": {
"statementDescriptor": "Whole Body Fitness"
}
},
"termsOfService": {
"acceptedDate": "2019-08-24T14:15:22Z",
"acceptedIP": "127.0.0.1"
},
"updatedOn": "2019-08-24T14:15:22Z",
"verification": {
"details": "failedAutoVerify",
"documents": [
{
"contentType": "application/pdf",
"documentID": "e210a9d6",
"parseErrors": [
"string"
],
"type": "DriversLicense",
"uploadedAt": "2019-08-24T14:15:22Z"
}
],
"status": "unverified",
"verificationStatus": "unverified"
}
}
Response headers
X-Retry-In
string
<duration>
Headers
X-Wait-For
string
connection
Body
accountType
string<enum>
required
individual
,
business
profile
object
required
accountType
is set to individual
, the individual
object should be completed. All others should populate business
.
Show child attributes
business
object
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
addressLine2
string
<=32 characters
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
businessType
string
soleProprietorship
,
unincorporatedAssociation
,
trust
,
publicCorporation
,
privateCorporation
,
llc
,
partnership
,
unincorporatedNonProfit
,
incorporatedNonProfit
,
governmentEntity
description
string
[10 to 100] characters
doingBusinessAs
string
<=64 characters
Pattern
string<email>
<=255 characters
Pattern
industryCodes
object
Show child attributes
mcc
string
4 characters
naics
string
[2 to 6] characters
sic
string
4 characters
legalBusinessName
string
<=64 characters
required
Pattern
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string<phone>
<=10 characters
primaryRegulator
string
OCC
,
FDIC
,
NCUA
,
FRB
taxID
object
Show child attributes
ein
object
Show child attributes
number
string
<=64 characters
website
string
<=100 characters
individual
object
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
addressLine2
string
<=32 characters
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
birthDate
object
Show child attributes
day
integer
required
month
integer
required
year
integer
required
string<email>
<=255 characters
Pattern
governmentID
object
Show child attributes
itin
object
Show child attributes
full
string
<=64 characters
lastFour
string
<=4 characters
ssn
object
Show child attributes
full
string
<=64 characters
lastFour
string
<=4 characters
name
object
required
Show child attributes
firstName
string
<=64 characters
required
Pattern
lastName
string
<=64 characters
required
Pattern
middleName
string
<=64 characters
Pattern
suffix
string
<=20 characters
Pattern
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string<phone>
<=10 characters
capabilities
array
transfers
,
send-funds
,
collect-funds
,
wallet
,
card-issuing
customerSupport
object
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
addressLine2
string
<=32 characters
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
string<email>
<=255 characters
Pattern
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string<phone>
<=10 characters
website
string
<=100 characters
foreignID
string
<=64 characters
metadata
object
mode
string<enum>
sandbox
,
production
settings
object
Show child attributes
achPayment
object
Show child attributes
companyName
string
[1 to 16] characters
Pattern
cardPayment
object
Show child attributes
statementDescriptor
string
[4 to 22] characters
Pattern
termsOfService
object
Show child attributes
token
string
acceptedDate
string<date-time>
<=24 characters
acceptedDomain
string<url>
<=255 characters
acceptedIP
string<ipv4>
<=15 characters
acceptedUserAgent
string
<=255 characters
Response
accountID
string<uuid>
<=36 characters
Pattern
accountType
string<enum>
individual
,
business
capabilities
array
Show child attributes
capability
string<enum>
transfers
,
send-funds
,
collect-funds
,
wallet
,
card-issuing
status
string<enum>
enabled
,
disabled
,
pending
,
in-review
createdOn
string<date-time>
<=24 characters
customerSupport
object
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
addressLine2
string
<=32 characters
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
string<email>
<=255 characters
Pattern
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string<phone>
<=10 characters
website
string
<=100 characters
disconnectedOn
string
displayName
string
<=64 characters
foreignID
string
<=64 characters
metadata
object
mode
string<enum>
sandbox
,
production
profile
object
Show child attributes
business
object
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
addressLine2
string
<=32 characters
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
businessType
string
soleProprietorship
,
unincorporatedAssociation
,
trust
,
publicCorporation
,
privateCorporation
,
llc
,
partnership
,
unincorporatedNonProfit
,
incorporatedNonProfit
,
governmentEntity
description
string
[10 to 100] characters
doingBusinessAs
string
<=64 characters
string<email>
<=255 characters
Pattern
industryCodes
object
Show child attributes
mcc
string
4 characters
naics
string
[2 to 6] characters
sic
string
4 characters
legalBusinessName
string
<=64 characters
ownersProvided
boolean
required
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string<phone>
<=10 characters
primaryRegulator
string
OCC
,
FDIC
,
NCUA
,
FRB
representatives
array
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
addressLine2
string
<=32 characters
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
birthDateProvided
boolean
createdOn
string<date-time>
<=24 characters
disabledOn
string
string<email>
<=255 characters
Pattern
governmentIDProvided
boolean
name
object
Show child attributes
firstName
string
<=64 characters
required
Pattern
lastName
string
<=64 characters
required
Pattern
middleName
string
<=64 characters
Pattern
suffix
string
<=20 characters
Pattern
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string<phone>
<=10 characters
representativeID
string<uuid>
<=36 characters
Pattern
responsibilities
object
Show child attributes
isController
boolean
required
isOwner
boolean
required
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
required
ownershipPercentage
integer
required
isOwner
is true
).
updatedOn
string<date-time>
<=24 characters
taxIDProvided
boolean
website
string
<=100 characters
individual
object
Show child attributes
address
object
Show child attributes
addressLine1
string
<=60 characters
required
addressLine2
string
<=32 characters
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
birthDateProvided
boolean
string<email>
<=255 characters
Pattern
governmentIDProvided
boolean
name
object
Show child attributes
firstName
string
<=64 characters
required
Pattern
lastName
string
<=64 characters
required
Pattern
middleName
string
<=64 characters
Pattern
suffix
string
<=20 characters
Pattern
phone
object
Show child attributes
countryCode
string
<=1 characters
number
string<phone>
<=10 characters
settings
object
Show child attributes
achPayment
object
Show child attributes
companyName
string
[1 to 16] characters
Pattern
cardPayment
object
Show child attributes
statementDescriptor
string
[4 to 22] characters
Pattern
termsOfService
object
Show child attributes
acceptedDate
string<date-time>
<=24 characters
required
acceptedIP
string<ipv4>
<=15 characters
required
updatedOn
string<date-time>
<=24 characters
verification
object
Show child attributes
status
string<enum>
required
deprecated
unverified
,
pending
,
verified
,
errored
details
string<enum>
deprecated
failedAutoVerify
,
docDobMismatch
,
docNameMismatch
,
docAddressMismatch
,
docNumberMismatch
,
docIncomplete
,
docFailedRisk
,
potentialAccountSanctionsMatch
,
potentialRepresentativeSanctionsMatch
,
failedOther
documents
array
Show child attributes
contentType
string
documentID
string
parseErrors
array
type
string<enum>
DriversLicense
,
Passport
,
UtilityBill
,
BankStatement
uploadedAt
string<date-time>
<=24 characters
verificationStatus
string<enum>
deprecated
unverified
,
pending
,
resubmit
,
review
,
verified
,
failed