Back to documentation index


Use the updateClient API to change the details of an already existing client.The updateClient API also helps in linking a client to multiple merchants. The Merchant ID (optional parameter) field is available and if a valid merchant Id is used, the Client to Merchant link gets established.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify the Subscriber ID issued, when Finxera account was created
+ clientId Y Object Specify either the bancBoxId or subscriberReferenceId parameter.
merchantId N Int Merchant ID of the Merchant with whom linking has to be done
firstName N String Client first name (Max length:45)
lastName N 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
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
requestId   Long 13 digit ID for the API request being made.
status   Int It is the Status of completed request, (1 for pass or 0 for fail)
+ warnings   Object A Warning object containing a code and description
+ errors   Object Request failed, error response.
clientStatus   String Responds with one of the following statuses for the client { 'ACTIVE', 'INACTIVE', 'CANCELLED', 'SUSPENDED', 'DELETED' }
cipStatus   String Responds with one of the following statuses for the client { 'VERIFIED', 'REJECTED', 'IGNORED', 'UNVERIFIED'}

WSDL URL (Production) :
WSDL URL (SandBox) :

Sample Request

<soapenv:Envelope xmlns:soapenv="" xmlns:sch="">

Sample Response

            <!--Zero or more repetitions:-->
            <!--Zero or more repetitions:-->


Note:For REST, Content-type should be set to application/json
URL (Production) :
URL (SandBox) :

Sample Request

    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    "subscriberId": ? ,
    "clientId" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
"merchantId": "?",   
 "firstName": "?",
    "lastName": "?",
    "middleInitial": "?",
    "ssn": "?",
    "dob": "?",
    "address": {
        "line1": "?",
        "line2": "?",
        "city": "?",
        "state": "?",
        "zipcode": "?"
    "homePhone": "?",
    "mobilePhone": "?",
    "workPhone": "?",
    "email": "?",
    "username": "?"

Sample Response

    "clientStatus": "?",
    "requestId": ? ,
    "status" : ? ,
    "cipStatus": "?",
    "warnings" : [{
        "code": "?",
        "message": "?"
    "errors": [{
        "code": "?",
        "message": "?"

Note: This is a beta version. The api listed here are likely to change.