CA ArcotID OTP Java Library Developer's Guide › Understanding ArcotID OTP APIs › Provisioning ArcotID OTP Accounts › How a Provisioning Request Works

How a Provisioning Request Works

This section explains the sequence of events that take place when a provisioning request is sent to the server. Apply this information while using the provisionRequest() method and callback() method in your implementation.

The following events take place when a provisioning request is sent to the server:

1. When the provisionRequest() method is invoked the first time, it sends the provisioning request to the server. This request contains the following parameters:
   • URL
   • ACCOUNTID
   • ACTCODE
   • CONN_OBJECT (optional)
2. The callback() method is invoked. The parameters returned by this method depend on what happens next:

   Note: The client application must free up the parameters map after each provisionRequest() call and the corresponding callback() call.

   • If the request succeeds, then the callback() method returns the following parameter values:
     • URL
     • ACCOUNTID
     • ACTCODE
     • CONN_OBJECT (only if this parameter was sent in the initial request)
     • REQUESTTYPE=”provisioning”
     • PINTYPE=1/0
     • MINPINLENGTH=<minimum-PIN-length>
     • XML=<response>
     • DLTA=<time-difference-between-the-server-and-client-application>
     • STATE=PINREQUIRED

       The PINREQUIRED state indicates that the server is requesting the PIN.

   • If the request fails for any reason, then the callback() method returns the following parameter values:
     • URL
     • ACCOUNTID
     • ACTCODE
     • CONN_OBJECT (only if this parameter was sent in the initial request)
     • REQUESTTYPE=”provisioning”
     • ERR_CODE=<error-code>
     • ERR_MSG=<error-message>
     • PLATFORM_MSG=<error-message-returnedf-by-the-underlying-platform>
3. The provisionRequest() method is invoked again. The parameters passed by this method depend on the state returned by the callback() method. For the PINREQUIRED state of the callback() method, the following are the parameters (with some sample values) sent by the provisionRequest() method. Note that the original set of parameters are included in the request again.
   • URL
   • ACCOUNTID
   • ACTCODE
   • CONN_OBJECT (only if this parameter was sent in the initial request)
   • REQUESTTYPE=”provisioning”
   • PINTYPE
   • MINPINLENGTH
   • XML
   • DLTA
   • STATE=PINREQUIRED
   • PINVALUE
4. After the request is processed by the server, the parameters returned by the callback() method depend on whether the request has succeeded or failed:
   • If the request was successfully processed, then the callback() method returns the following parameter values:
     • URL
     • ACCOUNTID
     • ACTCODE
     • CONN_OBJECT (only if this parameter was sent in the initial request)
     • REQUESTTYPE=\xE2\x80\x9Dprovisioning”
     • ACCOUNT_KEY=<newly-created-account-key>
     • PINVALUE=<masked-newly-created-PIN>
     • STATE=DONE
   • If the request fails, then the callback() method returns the following parameter values:
     • URL
     • ACCOUNTID
     • ACTCODE
     • CONN_OBJECT (only if this parameter was sent in the initial request)
     • REQUESTTYPE=”provisioning”
     • ERR_CODE=<error-code>
     • ERR_MSG=<error-message>
     • PLATFORM_MSG=<error-message-returned-by-the-underlying-platform>