Finxera

Back to documentation index

verifyClient

Use the verifyClient API to perform KYC Validation on an existing client. It is important to note, the CIP status of the client must be "VERIFIED" before you can use OpenAccount to create an account under the client. verifyClient uses the information from the client to identify them uniquely. It relies on the following fields to be submitted correctly during the createClient call:
            1. First Name
            2. Last Name
            3. DOB
            4. SSN (NNN-NN-NNNN or last 4 NNNN)
If verifyClient results in a validation error, please make sure these four fields were submitted with the correct information. If incorrect information was passed in the original createClient call, please use the updateClient API to correct the information for a client before calling verifyClient API again. If your account is enabled for out of wallet questions (optional for some subscribers) and the client cannot be uniquely identified, the system will return challenge questions to try and confirm the user's identity.

Request Parameters

  Parameter Required Type Description
subscriberId Y long Specify subscriber ID issued when Finxera account is created.
+ clientId Y Object Define either bancBoxId or subscriberReferenceId parameter
generateQuestions N boolean generate Questions

Response Parameters

  Parameter   Type Description
requestId   long 13 digit ID for the API request being made.
status   int Status
+ errors   Object Request failed, error response.
+ warnings   Object A Warning object containing a code and description.
idNumber   string Id Number
+ questions   Object Questions
cipStatus   string Responds with one of the following cipStatuses for the newly created client { 'VERIFIED', 'REJECTED', 'IGNORED', 'UNVERIFIED'}

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:verifyClient>
         <verifyClient>
            <subscriberId>?</subscriberId>
            <!--Optional:-->
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
                <!--Optional:-->
                <subscriberReferenceId>?</subscriberReferenceId>
            </clientId>
	    <!--Optional:-->
            <generateQuestions>?</generateQuestions>
         </verifyClient>
      </sch:verifyClient>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:verifyClientResponse>
    <return>
        <requestId>?</requestId>
        <status>?</status>
        <errors> <code>?</code>
            <message>?</message>
        </errors>
        <warnings> <code>?</code>
            <message>?</message>
        </warnings>
        <idNumber>?</idNumber>
        <questions>
            <prompt>?</prompt>
            <type>?</type>
            <answers>?</answers>
            <answers>?</answers>
            <answers>?</answers>
            <answers>?</answers>
        </questions>
        <cipStatus>?</cipStatus>
    </return>
</sch:verifyClientResponse>

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

Sample Request

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

Sample Response

{
   "idNumber": "?",
   "questions":    [
            {
         "prompt": "?",
         "type": "?",
         "answers":          [
            "?",
            "?",
            "?",
            "?"
         ]
      },
        
   ],
   "cipStatus" : "?",
   "requestId": ?,
   "status": ?,
    "warnings" : [ {
    "code" : "?",
    "message" : "?"
	} ],
    "errors" : [ {
    "code" : "?",
    "message" : "?"
	} ]
}

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