Update a Client account (Upgrade partial account or retry verification on full account))

POST https://api-sandbox.dwolla.com/clients/{{clientAccountId}}

Update a Client Account's information to convert them from a partial account to a full account or to retry verification. A Client Account's information can only be updated if they are a partial account or they are a full account with a verification status of retry.

Request parameters

Parameter	Required	Type	Description
email	yes	string	The email of the account admin.
firstName	yes	string	The legal first name of the account admin.
lastName	yes	string	The legal last name of the account admin.
title	yes	string	The job title of the account admin.
businessName	yes	string	Registered business name.
ein	yes	string	Employer Identification Number.
businessAddress	yes	object	businessAddress object for the client account’s business.
accountType	yes	string	Account Type. Possible values are: `commercial`, `government`, `nonprofit`.
businessType	yes	string	Business structure. Possible values are: `corporation`, `llc`, `partnership`.
businessClassification	yes	string	The industry classification Id that corresponds to account's business. Reference the Business Classifications section to learn how to generate this Id.
ownershipType	yes	string	Possible values are: `Public`, `Private`, `Unknown`.
ownersOverThreshold	yes	string	Possible values are: `None`, `OneOrMore`, `Unknown`.
website	yes	string	Business’ website. e.g. https://www.domain.com
registeredState	yes	string	Two-letter US state or territory abbreviation code of where business was registered.
businessDescription	yes	string	Description of the business.
controller	yes	object	A controller object.
correlationId	no	string	A unique string value attached to a Client Account which can be used for traceability between Dwolla and your application.
preferredOrganizationName	no	string	Preferred business name – also known as fictitious name, or assumed name.

Account Opening `businessAddress` JSON object

Parameter	Required	Type	Description
address1	yes	string	Street number, street name of business’ physical address.
address2	no	string	Apartment, floor, suite, bldg. # of business’ physical address.
city	no	string	City of business’ physical address.
state	no	string	Two-letter US state or territory abbreviation code of business’ physical address.
postalCode	no	string	Business’ US five-digit ZIP or ZIP + 4 code.

Account Opening `controller` JSON object

Parameter	Required	Type	Description
firstName	yes	String	The legal first name of the controller.
lastName	yes	String	The legal last name of the controller.
title	yes	String	Job title of the controller. IE - Chief Financial Officer
dateOfBirth	yes	String	The date of birth of the controller. Formatted in YYYY-MM-DD format. Must be between 18 to 125 years of age.
address	yes	object	An address JSON object. Full address of the controller's physical address.
ssn	conditional	String	Last four or full 9 digits of controller’s Social Security Number. Required for US persons. If SSN is omitted, passport is required.
passport	conditional	object	An optional passport JSON object. Required for non-US persons. Includes Passport Identification Number and Country. If passport is omitted, SSN is required.

Controller `address` JSON object

Parameter	Required	Type	Description
address1	yes	string	Street number, street name of controller’s physical address. Note: PO Boxes are not allowed.
address2	no	string	Apartment, floor, suite, bldg. # of controller’s physical address. Note: PO Boxes are not allowed.
address3	no	string	Third line of the street address of the controller's physical address. Note: PO Boxes are not allowed.
city	yes	string	City of controller’s physical address.
stateProvinceRegion	yes	string	US persons - Two-letter US state abbreviation code of controller’s physical address. For two-letter US state abbreviation reference, check out the US Postal Service guide. Non-US persons - Two-letter state, province, or region ISO abbreviation code of controller's physical address. For two-letter ISO abbreviation reference, check out the ISO guide.
postalCode	conditional	string	Controller’s’ US five-digit ZIP or ZIP + 4 code. Optional if controller is a non-US person.
country	yes	string	Country of controller’s physical address. Two digit ISO code, e.g. `US`.

Controller `passport` JSON object

A controller will only need to input passport information if they are non-US persons and do not have a Social Security Number.

Parameter	Required	Type	Description
number	conditional	string	Required if controller is a non-US person and has no Social Security Number.
country	conditional	string	Country of issued passport.

HTTP status and error codes

HTTP Status	Code	Message	Description
201	Created	Success	A Client account was created.
400	BadRequest	A client with the specified email has already been registered.	There exists a Client account with the specified email. Check email.
400	BadRequest	Validation error(s) present. See embedded errors list for more details.	An error exists with the request. Check the embedded list of errors for more detailed error messages. Also check Validation Errors section in the API reference.
403	Forbidden	The supplied credentials are not authorized for this resource.	The scopes for creating a Client account are not enabled for this application. Reach out to Dwolla for more information.

Request Body

{"email"=>"xyz@email.com", "firstName"=>"Mickey", "lastName"=>"Mantle", "title"=>"CEO", "businessName"=>"Mickey's Inc.", "preferredOrganizationName"=>"Mickey's Mantles", "accountType"=>"commercial", "ein"=>"000000000", "businessAddress"=>{"address1"=>"123 Mickey St", "city"=>"Riverside", "stateProvinceRegion"=>"IA", "country"=>"US", "postalCode"=>"52327"}, "businessType"=>"Corporation", "businessClassification"=>"9ed3f670-7d6f-11e3-b1ce-5404a6144203", "ownershipType"=>"Public", "ownersOverThreshold"=>"OneOrMore", "website"=>"https://www.mickeysmantles.com", "registeredState"=>"IA", "businessDescription"=>"We sell mantles", "controller"=>{"firstName"=>"Mickey", "lastName"=>"Mantle", "title"=>"Treasurer", "dateOfBirth"=>"1990-01-01", "address"=>{"address1"=>"123 Mickey St", "city"=>"Riverside", "stateProvinceRegion"=>"IA", "country"=>"US", "postalCode"=>"52327"}, "ssn"=>"123456789"}}

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`Accept`	string
`Authorization`	string

Update a Client account (Upgrade partial account or retry verification on full account))

Request parameters

Account Opening businessAddress JSON object

Account Opening controller JSON object

Controller address JSON object

Controller passport JSON object