Finxera

Back to documentation index

getClient

Use getClient to get information on one specific client

Request Parameters

  Parameter Required Type Description
subscriberId Y long Subscriber Id
+ clientId Y Object Define either bancBoxId or subscriberReferenceId parameter

Response Parameters

  Parameter   Type Description
requestId   Long 13 digit ID for the API request being made
cipStatus   String Responds with one of the following cipStatuses for the newly client { 'VERIFIRD', 'REJECTED', 'IGNORED', 'UNVERIFIED'}
clientStatus   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.
+ client   Object Client details

WSDL URL (Production) :  https://api.bancbox.com/v3/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v3/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:getClient>
         <getClientRequest>
           <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
         </getClientRequest>
      </sch:getClient>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:getClientResponse>
          <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:-->
            <client>
               <!--Optional:-->
               <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>
               <!--Optional:-->
               <status>?</status>
	       <createdBy>?</createdBy>
	       <modifiedBy>?</modifiedBy>		
            </client>
         </return>
</sch:getClientResponse>

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

Sample Request

{ 
    "authentication": 
    { 
        "apiKey":"YOUR_API_KEY_HERE", 
        "secret":"SECRET_PASSPHRASE" 
    }, 
    "subscriberId":?, 
    "clientId": 
     { 
        "bancBoxId":?, 
        "subscriberReferenceId":"?" 
     } 
} 

Sample Response

{ 
  "client" : { 
    "clientId" : { 
      "bancBoxId" : ?, 
      "subscriberReferenceId" : "?" 
    }, 
    "firstName" : "?", 
    "lastName" : "?", 
    "middleInitial" : "?", 
    "ssn" : "?", 
    "dob": "?",
    "address" : { 
      "line1" : "?", 
      "line2" : "?", 
      "city" : "?", 
      "state" : "?", 
      "zipcode" : "?" 
    }, 
    "homePhone" : "?", 
    "mobilePhone" : "?", 
    "workPhone" : "?", 
    "email" : "?", 
    "username" : "?", 
    "status" : "?", 
    "modifiedBy" : ?, 
    "createdBy" : ? 
  }, 
  "requestId" : ?, 
  "status" : ?, 
   "warnings" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ], 
  "errors" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ] 
} 

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