Qodex.ai

Create a full Client account

POST https://api-sandbox.dwolla.com/clients

Submit full details on the client's business to initialize and start the verification process for the account.

Request parameters

ParameterRequiredTypeDescription
emailyesstringThe email of the account admin.
firstNameyesstringThe legal first name of the account admin.
lastNameyesstringThe legal last name of the account admin.
titleyesstringThe job title of the account admin.
businessNameyesstringRegistered business name.
einyesstringEmployer Identification Number.
businessAddressyesobjectbusinessAddress object for the client account’s business.
accountTypeyesstringAccount Type. Possible values are: commercial, government, nonprofit.
businessTypeyesstringBusiness structure. Possible values are: corporation, llc, partnership.
businessClassificationyesstringThe industry classification Id that corresponds to account's business. Reference the Business Classifications section to learn how to generate this Id.
ownershipTypeyesstringPossible values are: Public, Private, Unknown.
ownersOverThresholdyesstringPossible values are: None, OneOrMore, Unknown.
websiteyesstringBusiness’ website. e.g. https://www.domain.com
registeredStateyesstringTwo-letter US state or territory abbreviation code of where business was registered.
businessDescriptionyesstringDescription of the business.
controlleryesobjectA controller object.
correlationIdnostringA unique string value attached to a Client Account which can be used for traceability between Dwolla and your application.
preferredOrganizationNamenostringPreferred business name – also known as fictitious name, or assumed name.

Account Opening businessAddress JSON object

ParameterRequiredTypeDescription
address1yesstringStreet number, street name of business’ physical address.
address2nostringApartment, floor, suite, bldg. # of business’ physical address.
citynostringCity of business’ physical address.
statenostringTwo-letter US state or territory abbreviation code of business’ physical address.
postalCodenostringBusiness’ US five-digit ZIP or ZIP + 4 code.

Account Opening controller JSON object

ParameterRequiredTypeDescription
firstNameyesStringThe legal first name of the controller.
lastNameyesStringThe legal last name of the controller.
titleyesStringJob title of the controller. IE - Chief Financial Officer
dateOfBirthyesStringThe date of birth of the controller. Formatted in YYYY-MM-DD format. Must be between 18 to 125 years of age.
addressyesobjectAn address JSON object. Full address of the controller's physical address.
ssnconditionalStringLast four or full 9 digits of controller’s Social Security Number. Required for US persons. If SSN is omitted, passport is required.
passportconditionalobjectAn 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

ParameterRequiredTypeDescription
address1yesstringStreet number, street name of controller’s physical address. Note: PO Boxes are not allowed.
address2nostringApartment, floor, suite, bldg. # of controller’s physical address. Note: PO Boxes are not allowed.
address3nostringThird line of the street address of the controller's physical address. Note: PO Boxes are not allowed.
cityyesstringCity of controller’s physical address.
stateProvinceRegionyesstringUS 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.
postalCodeconditionalstringController’s’ US five-digit ZIP or ZIP + 4 code. Optional if controller is a non-US person.
countryyesstringCountry 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.

ParameterRequiredTypeDescription
numberconditionalstringRequired if controller is a non-US person and has no Social Security Number.
countryconditionalstringCountry of issued passport.

HTTP status and error codes

HTTP StatusCodeMessageDescription
201CreatedSuccessA Client account was created.
400BadRequestA client with the specified email has already been registered.There exists a Client account with the specified email. Check email.
400BadRequestValidation 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.
403ForbiddenThe 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", "type"=>"full", "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"=>"1234"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring
Authorizationstring