BancBox

createClient

Use the createClient method to register a user (Client) onto the Finxera platform. Creating the client is the first step to tokenizing external account information, such as a credit card number, or for opening a bank account for your user, collecting money into the account, and sending money to billers or other users. It is important to note, for the purposes of tokenizing payment information, such as external bank account for ACH collections, or credit card information, you do not need to provide DOB or SSN information. However, when creating a bank account under the client, the following four fields are required:</br>             1. First Name</br>             2. Last Name</br>             3. DOB</br>             4. SSN</br> While createClient will not fail if you do not provide the DOB and SSN, you will not be able to execute openAccount for that client until you provide correct information for these fields, and subsequently, use the <b>verifyClient</b> API to perform identity verification necessary for opening a bank account.</br>

Parameters

Request Parameters
Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
referenceId N String Create a subscriber-set reference ID for the client being created (Max length:45)
firstName Y String Client first name (Max length:45)
lastName Y String Client last name (Max length:45)
middleInitial N String Client middle name initial (Max length:45)
ssn N String Client social security number can be either in the format NNN-NN-NNNN (with hyphens) or NNNN (last four digits)
dob N date Client date of birth must be a valid date formatted as YYYY-MM-DD
address N Object Address
  printer line1 N String First line of client address (Max length:128)
  printer line2 N String Second line of client address (Max length:128)
  printer city N String Client city (Max length:45)
  printer state N String Client state
  printer zipcode N String Client zipcode
homePhone N String Client home phone number
mobilePhone N String Client mobile phone number
workPhone N String Client work phone number
email N String Client email address (Max length:45)
username N String Login username for Finxera client portal (Max length:45)
Response Parameters
Parameter   Type Description
status   int Status of completed request, either 1 for pass, or 0 for fail
warnings   Object A Warning object containing a code and description.
  printer code   string A Short code for the warning message.
  printer message   string Warning message description as string.
errors   Object Request failed, error response.
  printer code   string Code of specific error.
  printer message   string Message appears under error code, which describes the error that occurred.
clientId   Object Client Id
  printer bancBoxId   Long Client ID used by Finxera, 6 digit number.
  printer subscriberReferenceId   string Matches specified referenceId parameter, subscriber created ID for new client
clientStatus   String Responds with one of the following statuses for the client { 'ACTIVE', 'INACTIVE', 'CANCELLED', 'SUSPENDED', 'DELETED'
requestId   Long 13 digit ID for the API request being made
username   String User name
cipStatus   String Responds with one of the following cipstatuses for the newly created client { 'VERIFIED', 'REJECTED', 'IGNORED', 'UNVERIFIED'}
Related Errors
Parameter Short error messge Description
No records
XML Examples
Request XML
Response XML
© 2013 BancBox.com. All Rights Reserved.