Finxera

Back to documentation index

updateClient

Use the updateClient API to change the details of an already existing client.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ clientId Y Object Specify either the bancBoxId or subscriberReferenceId parameter.
firstName N String First Name
lastName N String Last Name
middleInitial N String Middle Initial
ssn N String SSN
dob N Date Date of birth[YYYY-MM-DD]
+ address N Object Address
homePhone N String Home Phone
mobilePhone N String Mobile Phone
workPhone N String Work Phone
email N String Email
username N String User Name

Response Parameters

  Parameter   Type Description
requestId   long 13 digit ID for the API request being made.
status   Int Status of completed request, either 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) :  https://api.bancbox.com/v1/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v1/BBXPort?wsdl

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
<soapenv:Header>
<wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="XWSSGID-1261544568770-474929336" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>sample@email.com</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">sample</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
   <soapenv:Body>
      <sch:updateClient>
         <updateClientRequest>
           <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <firstName>?</firstName>
            <!--Optional:-->
            <lastName>?</lastName>
            <!--Optional:-->
            <middleInitial>?</middleInitial>
            <!--Optional:-->
            <ssn>?</ssn>
            <!--Optional:-->
            <dob>?</dob>
            <!--Optional:-->
            <address>
               <line1>?</line1>
               <!--Optional:-->
               <line2>?</line2>
               <city>?</city>
               <state>?</state>
               <zipcode>?</zipcode>
            </address>
            <!--Optional:-->
            <homePhone>?</homePhone>
            <!--Optional:-->
            <mobilePhone>?</mobilePhone>
            <!--Optional:-->
            <workPhone>?</workPhone>
            <!--Optional:-->
            <email>?</email>
            <!--Optional:-->
            <username>?</username>
         </updateClientRequest>
      </sch:updateClient>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:updateClientResponse>
       <return>
            <!--Optional:-->
            <requestId>?</requestId>
            <status>?</status>
            <!--Zero or more repetitions:-->
            <warnings>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </warnings>
            <!--Zero or more repetitions:-->
            <errors>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </errors>
            <!--Optional:-->
            <clientStatus>?</clientStatus>
            <!--Optional:-->
            <cipStatus>?</cipStatus>

         </return>
</sch:updateClientResponse>

Note:For REST, Content-type should be set to application/json
URL (Production) :  https://api.bancbox.com/v1/BBXPortRest/updateClient
URL (SandBox) :  https://sandbox-api.bancbox.com/v1/BBXPortRest/updateClient

Sample Request

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

Sample Response

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