Finxera

Back to documentation index

searchClients

Use searchClients to lookup clients registered in Finxera. You can use a Finxera issued ID, your own reference identifier, or even date range on when the client was created or updated. Search by status is also available, so you can lookup all clients, for example, that have a status of "INACTIVE".The searchClient API supports pagination

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created
+ clientId N Object Define either bancBoxId or subscriberReferenceId parameter
createdOnFromDate N dateTime created On From Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T"
createdOnToDate N dateTime created On To Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T"
modifiedOnFromDate N dateTime modified On From Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T
modifiedOnToDate N dateTime modified On To Date[YYYY-MM-DDTHH:MM:S] "T" is not a number value, it is the letter "T"
clientStatus N String Specify one of the following statuses for the client { 'ACTIVE', 'INACTIVE', 'CANCELLED', 'SUSPENDED', 'DELETED' }
cipStatus N String Specify one of the following cipStatuses for the client { 'VERIFIED', 'REJECTED', 'IGNORED', 'UNVERIFIED'}
ascending N Boolean Results listed in ascending order {true} or descending order {false}
pageNo N Int Page number of the list, see resultsPerPage.
resultsPerPage N Int Specify how many results would be listed in a page

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 { 'VERIFIED', 'REJECTED', 'IGNORED', 'UNVERIFIED'}
clientStatus   int Status of completed request, either 1 for pass, or 0 for fail
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.
+ clients   Object Clients
modifiedOn   datetime Modified on date
modifiedBy   String Modified By
createdOn   datetime Created on Date
createdBy   String Created By
currentPage   Int Current Page Number
totalPages   Int Total pages in the response
totalRecords   Int Total no of records in the response

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/>
   <soapenv:Body>
      <sch:searchClients>
         <searchClientRequest>
            <subscriberId>?</subscriberId>
            <!--Optional:-->
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
            <!--Optional:-->
            <createdOnFromDate>?</createdOnFromDate>
            <!--Optional:-->
            <createdOnToDate>?</createdOnToDate>
            <!--Optional:-->
            <modifiedOnFromDate>?</modifiedOnFromDate>
            <!--Optional:-->
            <modifiedOnToDate>?</modifiedOnToDate>
            <!--Optional:-->
            <clientStatus>?</clientStatus>
            <!--Optional:-->
            <cipStatus>?</cipStatus>
            <!--Optional:-->
            <ascending>false</ascending>
            <!--Optional:-->
            <pageNo>?</pageNo>
            <!--Optional:-->
            <resultsPerPage>?</resultsPerPage>
         </searchClientRequest>
      </sch:searchClients>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:searchClientsResponse>
         <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:-->
            <currentPage>?</currentPage>
            <!--Optional:-->
            <totalPages>?</totalPages>
            <!--Optional:-->
            <totalRecords>?</totalRecords>
            <!--Zero or more repetitions:-->
            <clients>
               <!--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>
                  <!--Optional:-->
                  <line1>?</line1>
                  <!--Optional:-->
                  <line2>?</line2>
                  <!--Optional:-->
                  <city>?</city>
                  <!--Optional:-->
                  <state>?</state>
                  <!--Optional:-->
                  <zipcode>?</zipcode>
               </address>
               <!--Optional:-->
               <homePhone>?</homePhone>
               <!--Optional:-->
               <mobilePhone>?</mobilePhone>
               <!--Optional:-->
               <workPhone>?</workPhone>
               <!--Optional:-->
               <email>?</email>
               <!--Optional:-->
               <username>?</username>
               <!--Optional:-->
               <clientStatus>?</clientStatus>
               <!--Optional:-->
               <cipStatus>?</cipStatus>
               <!--Optional:-->
               <modifiedOn>?</modifiedOn>
               <!--Optional:-->
               <modifiedBy>?</modifiedBy>
               <!--Optional:-->
               <createdOn>?</createdOn>
               <!--Optional:-->
               <createdBy>?</createdBy>
            </clients>
         </return>
      </sch:searchClientsResponse>
   </soapenv:Body>
</soapenv:Envelope> 

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "clientId" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "createdOnFromDate": "?",
    "createdOnToDate": "?",
    "modifiedOnFromDate": "?",
    "modifiedOnToDate": "?",
    "clientStatus": "?",
    "cipStatus": "?"
    "ascending":false,
    "pageNo":,
    "resultsPerPage":
}

Sample Response

{
   "currentPage":,
   "totalPages": ,
   "totalRecords": ,
   "clients" : [ { 
    "clientId" : { 
      "bancBoxId" : ?, 
      "subscriberReferenceId" : "?" 
    }, 
    "firstName" : "?", 
    "lastName" : "?", 
    "middleInitial" : "?", 
    "ssn" : "?", 
    "address" : { 
      "line1" : "?", 
      "line2" : "?", 
      "city" : "?", 
      "state" : "?", 
      "zipcode" : "?" 
    }, 
    "homePhone" : "?", 
    "mobilePhone" : "?", 
    "workPhone" : "?", 
    "email" : "?", 
    "username" : "?", 
    "clientStatus" : "?",
    "cipStatus" : "?",
    "modifiedOn" : "?", 
    "modifiedBy" : ?, 
    "createdOn" : "?", 
    "createdBy" : ? 
  } ], 
  "requestId" : ?, 
  "status" : ?, 
   "warnings" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ], 
  "errors" : [ { 
    "code" : "?", 
    "message" : "?" 
  } ] 
}

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