Finxera

Back to documentation index

submitVerificationAnswers

Use the submitVerificationAnswers API in conjunction with the verifyClient API to submit the answers for the challenge questions returned in the response for the verifyClient API in case the system was unable to uniquely identify the user based on the information available in the client record.

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
idNumber Y String idNumber that was generated from verifyClient API. This is used to look up the questions.
+ answers Y Object Answer the question

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
+ errors   Object Request failed, error response.
+ warnings   Object A Warning object containing a code and description.

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:submitVerificationAnswers>
         <submitVerificationAnswers>
            <subscriberId>?</subscriberId>
            <clientId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </clientId> 
            <idNumber>?</idNumber>
            <!--Zero or more repetitions:-->
            <answers>
               <type>?</type>
               <answer>?</answer>
            </answers>
         </submitVerificationAnswers>
      </sch:submitVerificationAnswers>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:submitVerificationAnswersResponse>
    <return>
        <requestId>?</requestId>
        <status>?</status>
        <warnings> <code>?</code>
            <message>?</message>
        </warnings>
        <errors> <code>?</code>
            <message>?</message>
        </errors>
        <cipStatus>?</cipStatus>
    </return>
</sch:submitVerificationAnswersResponse>

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

Sample Request

{
	 "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
	"subscriberId":?,
	"idNumber":"?",
	"clientId":
	{
		"bancBoxId":?,
		"subscriberReferenceId" : "?"
	},
	"answers":
	[
		{
			"type":"?",
			"answer":"?"
		}
	]
}

Sample Response

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