Client Control

Properties   Methods   Events   Config Settings   Errors  

The Client control is designed for use on mobile devices and facilitates EMV® 3-D Secure authentication.

Syntax

Client

Remarks

The Client control is a counterpart to the 3DS Server control. It is designed for use on mobile devices and supports operations that facilitate EMV® 3-D Secure authentication in both frictionless and challenge flows.

Preparing the Authentication Request

To begin, device specific information must be collected and prepared for transmission to the directory server. This can be done by calling the AddDeviceParam method. Consult the EMV® 3-D Secure Specifications for more details about applicable device parameters for each particular operating system.

The GetAuthRequest method is used to obtain the request message to be send to the directory server. GetAuthRequest encrypts the device info and prepares all the data necessary to be sent by the 3DS Server control in the SendAuthRequest method.

After calling this method, the returned data must be transmitted via a separate secure channel to the server where 3DS Server is being used.

The following properties are required before calling the method:

Calling this method returns required information used by 3DS Server to send the authentication request. Transmit the value returned by this method to the system where 3DS Server is used. The method used to transmit this value is outside the scope of the control.

See SendAuthRequest for details on sending the authentication request after transmitting the data to the 3DS Server.

Calling this method also populates SDKTransactionId which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as SendChallengeRequest.

Interaction With the 3DS Server Control

As mentioned above, the request to the Directory Server must be made by the 3DS Server control which resides on a server under control of the merchant. A web server is required even for app-based authentication both to send the authentication request and to be notified of authentication results later in the flow.

It is expected that a secure channel can be established between the app using the Client control and the server where the 3DS Server control resides in order to transfer information freely.

Sending the Authentication Request

The act of sending the authentication request takes place with the 3DS Server control.

SendAuthRequest begins the 3-D Secure transaction flow by sending an authentication request to the DirectoryServerURL.

After calling this method, check TransactionStatus to determine if the cardholder is authenticated (frictionless flow) or further cardholder interaction is required to complete the authentication (challenge flow).

Prior to calling SendAuthRequest, data must to be collected to facilitate fraud checks by the ACS. The following properties are applicable for both app-based and browser-based flows:

• AcquirerBIN (required)
• AcquirerMerchantId (required)
• CardholderName (required)
• CardNumber (required)
• DirectoryServerURL (required)
• MerchantCategoryCode (required)
• MerchantCountryCode (required)
• MerchantName (required)
• MessageVersion (required)
• PurchaseAmount (required)
• PurchaseDate (required)
• RequestorId (required)
• RequestorName (required)
• RequestorURL (required)
• ResultsURL (required)
• AccountType
• AuthenticationIndicator
• BillingAddress*
• CardholderEmail
• CardholderHomePhone
• CardholderMobilePhone
• CardholderWorkPhone
• DecoupledMaxTimeout
• DecoupledRequestIndicator
• DeviceChannel
• MessageCategory
• PurchaseCurrency
• PurchaseExponent
• ServerOperatorId
• ServerTransactionId
• ShippingAddress*
• ThreeRIIndicator

App-Based Flow

In the app-based flow, device specific information is prepared by the 3DS SDK on the customer's device. This is transmitted to the 3DS Server control via a secure channel, the specifics of which are outside the scope of the controls. Set ClientAuthRequest to this data prepared by the 3DS SDK.

Browser-Based Flow

Before calling this method, first check the cached card-range data to determine if a CardRangeMethodURL has been set by the ACS. Card range data may be retrieved by calling RequestCardRanges.

If no CardRangeMethodURL is present for the given card, set MethodCompletionIndicator to U.

If a CardRangeMethodURL has been specified by the ACS for the card number, the URL must be loaded in the cardholder's browser to allow the ACS to collect additional browser information for risk-based decision making. See the GetMethodData for further details.

Once the method URL invocation is complete, the authentication request may be sent. If the method URL invocation failed, set MethodCompletionIndicator to N before calling SendAuthRequest.

The following additional properties are applicable in browser-based flow:

• NotificationURL (required)
• BrowserAcceptHeader (required)
• BrowserLanguage (required)
• BrowserScreenHeight (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserScreenWidth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserTimeZone (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserUserAgent (required)
• BrowserIPAddress (conditional)
• BrowserJavaEnabledVal (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• BrowserJavaScriptEnabledVal (not valid in 2.1.0, required in 2.2.0 and 2.3.1)
• BrowserScreenColorDepth (required in 2.1.0, required in 2.2.0 and 2.3.1 if BrowserJavaScriptEnabled is true)
• AcceptLanguage (2.3.1 only)
• AcquirerCountryCode (2.3.1 only)

Response Handling

After calling this method the TransactionStatus property holds the result. Possible values are:

If the transaction is authenticated (Y or A), no further steps are required. The flow is considered frictionless and the 3-D Secure processing is complete. If processing a payment, the AuthenticationValue and AuthenticationECI values can be included as proof of 3-D Secure authentication.

If the transaction requires a cardholder challenge (C, D or S), further steps are required.

If the transaction is not authenticated, TransactionStatusReason may contain details about the reason.

The following properties are applicable after calling this method:

• AuthenticationECI
• AuthenticationValue
• TransactionStatus
• TransactionStatusReason
• CardholderInformation
• ACSURL (if challenge required)
• ACSChallengeMandatedIndicator (if challenge required)
• AuthenticationType (if challenge required)
• DecoupledConfirmationIndicator

Response Handling - App-Based Flow

After calling this method, ClientAuthResponse is populated with data to be transmitted back to the 3DS SDK. If a challenge is required, the ClientAuthResponse data is used by the 3DS SDK to start when initiating the challenge process.

The 3DS Server is responsible for indicating to the 3DS SDK the results of the SendAuthRequest process, and whether or not a challenge is required. Exactly how this is done is outside the scope of the controls themselves. The response to the 3DS SDK over the secure channel should include information on what to do next.

Note: The TransactionStatus is also populated in the 3DS Server control and may be inspected prior to transmitting ClientAuthResponse back to the 3DS SDK.

Response Handling - Browser-Based Flow

If TransactionStatus is C, then additional steps are required to complete the authentication. The GetChallengeRequest method should be called next to obtain data to be sent to the ACSURL in an authentication window in the customer's browser. Once authentication is complete, the ACS will post the results to the ResultsURL value that was specified when calling SendAuthRequest.

See the GetChallengeRequest method for more details.

If TransactionStatus is D, then decoupled authentication has been accepted by the ACS. DecoupledConfirmationIndicator will have a value of Y as well. Authentication will happen outside of the 3-D Secure flow and, when complete, the ACS will post the results to the ResultsURL that was specified when calling SendAuthRequest.

The DecoupledTimeRemaining value, which is calculated based on the DecoupledMaxTimeout value sent in the initial authentication request, can be checked to see the amount of time remaining before decoupled authentication must be completed. If the ACS does not post the results before this value runs out, it can be assumed that decoupled authentication was not successful.

SPC-Based Authentication

SPC (Secure Payment Confirmation) provides a method to perform a challenge using preestablished FIDO credentials when using a Browser. The SPC authentication can be initiated by the 3DS Requestor via an extra AReq/ARes message pair or by the ACS via a standard Browser Challenge Flow.

For an SPC authentication to execute correctly, the following prerequisites apply:

1. The ACS has an enrolled FIDO authenticator on the device for this Cardholder.
2. The 3DS Requestor and/or the ACS have detected that the Cardholder Browser supports the related SPC APIs (allow="payment *; publickey-credentialsget *"). For the ACS, this information can be obtained via the Browser User Agent data element or via data obtained via the 3DS Method.

SPC-based authentication can be enabled with the following additions:

Prior to sending the initial authentication request packet (AReq) using the SendAuthRequest method, the ThreeDSRequestorSpcSupport configuration setting should be set to True to indicate that SPC is supported by the 3DS Requestor.

If SPC is accepted by the ACS, the resulting TransactionStatus should be S. The response will also contain a list of enrolled FIDO (WebAuthn) credentials associated with the cardholder, and SPC transaction data. This data is available in the following configuration settings:

• WebAuthnCredentialListCount
• WebAuthnCredentialListWebAuthnCredential
• WebAuthnCredentialListRelyingPartyId
• SPCTransactionAdditionalData
• SPCTransactionChallenge
• SPCTransactionChallengeInfoText
• SPCTransactionCurrency
• SPCTransactionDisplayName
• SPCTransactionIcon
• SPCTransactionIssuerImage
• SPCTransactionIssuerImageDark
• SPCTransactionIssuerImageMonochrome
• SPCTransactionPayeeName
• SPCTransactionPayeeOrigin
• SPCTransactionPSImage
• SPCTransactionPSImageDark
• SPCTransactionPSImageMonochrome
• SPCTransactionTimeout
• SPCTransactionValue

This information is relayed to the 3DS Requestor implementation, and the 3DS Requestor invokes the SPC authentication (SPC API) against the WebAuthn Credential list. The cardholder authenticates using the FIDO authenticator on their device, and the 3DS Requestor retrieves the Assertion Data from the SPC API call.

The 3DS Server is then configured to includes this FIDO Assertion Data is then included in a new authentication request by setting the ReqAuthData[Index] and a ReqAuthMethod[Index] of 09. If the AuthenticationInformation value was saved earlier, it can be set via the same configuration setting. If the 3DS Requestor encounters an error during SPC API invokation, this can be indicated using the SPCIncompletionIndicator.

The SendAuthRequest method should then be called again to transmit this data to the ACS (by way of the DS) in a second AReq.

When SendAuthRequest returns, the 3DS Server proceed the same as the regular browser-based flow when the ARes is returned.

When SPC authentication is to be performed, the authenticaton must be completed within 9 minutes. The component will automatically start an internal timer that can be checked using the CheckSPCTimeout configuration setting. This will return the number of seconds left for SPC authentication to complete. If the time has expired before receiving the Assertion Data from the 3DS Requestor, checking this configuration setting will cause the component to automatically send the second AReq message with an SPCIncompletionIndicator value of 03, indicating that SPC authentication timed out.

Note that SPC-based authentication is only available when a MessageVersion of 2.3.1 is used.

Processing the Authentication Response

After the response to the authentication request is received from the 3DS Server control, call CheckAuthResponse to verify and parse the response. See the 3DS Server's SendAuthRequest method for details about obtaining the response.

Before calling this method, ACSRootCerts must be populated with the root certificates used by the ACS to sign the response. This method will validate the signature of the signed content if present.

After calling this method, inspect TransactionStatus to determine if the transaction requires a challenge. If TransactionStatus is C, a challenge is required and SendChallengeRequest should be called to proceed with the challenge flow. If TransactionStatus is D, decoupled authentication will take place outside of the 3-D Secure flow and the results will be posted to the 3DS Server.

If TransactionStatus is Y or A, the transaction is complete.

Challenge Interaction

If TransactionStatus is C, a challenge is required. The challenge takes place between the cardholder and the ACS. During this interaction the control will communicate directly with the ACS from the app where it is used to exchange information.

SendChallengeRequest begins the challenge flow. SendChallengeRequest sends the Challenge Request to the ACS when a challenge is required.

When the TransactionStatus is C after calling CheckAuthResponse, a challenge to the cardholder is required. This method sends the challenge request and parses the response. The ACS may provide multiple challenges to the cardholder during this process. As a result this method may need to be called multiple times throughout the authentication process.

After this method is called, check ChallengeComplete to determine if the challenge process is complete. If it is complete (True), check TransactionStatus to determine the outcome. If ChallengeComplete is False, additional challenge interaction is required.

First Request

The first time this method is called, information about the required challenge is obtained from the ACS. The ACS connection information is automatically set when CheckAuthResponse is called; there is no need to specify any ACS connection information.

All required properties for the first call to this method are automatically set after CheckAuthResponse is called. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS.

After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The ACSUIType property indicates the way the ACS will interact with the cardholder. The ChallengeComplete property will be False after the first call to this method since the challenge interaction is not yet complete.

The following properties are applicable when ACSUIType is Text (01), Single-Select (02), or Multi-Select (03):

• ChallengeSelectInfo
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• SubmitAuthenticationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is Out-of-Band (04):

• ChallengeAdditionalInformation
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• OOBContinueLabel
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is HTML (05):

• ACSHTML
• ACSHTMLRefresh

In the case of an HTML interaction, the app should create a webview and populate this with the HTML in ACSHTML.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

Second Request

The second time this method is called, the purpose is to provide a response to the ACS. At this point the customer should have responded to the challenge provided by the ACS in the response to the first call. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS. The following properties are applicable when calling this method the second time:

• ChallengeDataEntry
• OOBContinuationIndicator

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

When ACSUIType is OOB (04), set OOBContinuationIndicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.

Completing the Challenge

After calling SendChallengeRequest a second time with the cardholder's responses, the ACS may require additional challenges. Check the ChallengeComplete property to determine if the challenge is complete. If False, more challenges are required by the ACS and the same process of displaying the challenge info, collecting the response, and submitting it to the ACS should be performed again.

If ChallengeComplete is True, the challenge interaction is complete and TransactionStatus can be inspected to determine whether the transaction was successful.

Note: As part of the challenge completion the ACS also notifies the 3DS Server of the results. This is done by posting the results to the URL defined by the ResultsURL property of the 3DS Server control.

Logging Notes

Logging in the component is handled through the Log event. This will fire anytime a message is built or a response is parsed, including error messages.

When the Log event is fired, the message in question is made available via the Message event parameter. Properties such as EphemeralKey and DeviceParams are also available when they are gathered by the Client. The other event arguments are LogType and LogLevel:

The LogType parameter indicates the type of the log entry. Possible values are:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"
• "AReq"
• "ARes"
• "CReq"
• "CRes"
• "RReq"
• "RRes"
• "PReq"
• "PRes"
• "Erro"
• "EphemeralKey"
• "DeviceParams"

It is recommended to output all messages raised in this event to a file for record keeping purposes, or for later debugging issues that may have come up.

The Server and Client components also have DataPacketIn and DataPacketOut events that fire anytime a data packet is received or sent, respectively. The entire data packet is then accessible in the DataPacket event parameter. For encrypted packets, this would contain the full encrypted data. This parameter may be inspected for advanced troubleshooting.

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

ACSHTML Property (Client Control)

HTML provided by the ACS.

Syntax

clientcontrol.ACSHTML

Default Value

""

Remarks

This field contains HTML provided by the ACS in the Challenge Response Message (CRes). This will be populated when the ACSUIType is HTML.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

This property is read-only.

Data Type

String

ACSHTMLRefresh Property (Client Control)

ACS HTML refresh.

Syntax

clientcontrol.ACSHTMLRefresh

Default Value

""

Remarks

Optional HTML provided by the ACS in response to SendChallengeRequest when ACSUIType is HTML (05).

If the ACS HTML Refresh is present in the CRes message, the app should display this in the web view when the app is moved to the foreground.

This property is read-only.

Data Type

String

ACSRootCertCount Property (Client Control)

The number of records in the ACSRootCert arrays.

Syntax

clientcontrol.ACSRootCertCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ACSRootCertEncoded
• ACSRootCertStore
• ACSRootCertStorePassword
• ACSRootCertStoreType
• ACSRootCertSubject

The array indices start at 0 and end at ACSRootCertCount - 1.

This property is not available at design time.

Data Type

Integer

ACSRootCertStore Property (Client Control)

The name of the certificate store for the client certificate.

Syntax

clientcontrol.ACSRootCertStore(ACSRootCertIndex)[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ACSRootCertStoreType property denotes the type of the certificate store specified by ACSRootCertStore. If the store is password-protected, specify the password in ACSRootCertStorePassword.

ACSRootCertStore is used in conjunction with the ACSRootCertSubject property to specify client certificates. If ACSRootCertStore has a value, and ACSRootCertSubject or ACSRootCertEncoded is set, a search for a certificate is initiated. Please see the ACSRootCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .ACSRootCertStoreB.

This property is not available at design time.

Data Type

Binary String

ACSRootCertStorePassword Property (Client Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

clientcontrol.ACSRootCertStorePassword(ACSRootCertIndex)[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

String

ACSRootCertStoreType Property (Client Control)

The type of certificate store for this certificate.

Syntax

clientcontrol.ACSRootCertStoreType(ACSRootCertIndex)[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

Integer

ACSRootCertSubject Property (Client Control)

The subject of the certificate used for client authentication.

Syntax

clientcontrol.ACSRootCertSubject(ACSRootCertIndex)[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

This property is not available at design time.

Data Type

String

ACSRootCertEncoded Property (Client Control)

The certificate (PEM/Base64 encoded).

Syntax

clientcontrol.ACSRootCertEncoded(ACSRootCertIndex)[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ACSRootCertStore and ACSRootCertSubject properties also may be used to specify a certificate.

When ACSRootCertEncoded is set, a search is initiated in the current ACSRootCertStore for the private key of the certificate. If the key is found, ACSRootCertSubject is updated to reflect the full subject of the selected certificate; otherwise, ACSRootCertSubject is set to an empty string.

The ACSRootCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ACSRootCertCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .ACSRootCertEncodedB.

This property is not available at design time.

Data Type

Binary String

ACSUIType Property (Client Control)

UI type rendered by the 3DS SDK.

Syntax

clientcontrol.ACSUIType

Default Value

0

Remarks

This field is returned in the Challenge Response Message (CRes) from the ACS and contains the User Interface type that the 3DS SDK will render. 1 = Text 2 = Single Select 3 = Multi Select 4 = OOB 5 = HTML 6 = HTML OOB 7 = Information

This property is read-only.

Data Type

Integer

ChallengeAdditionalInformation Property (Client Control)

Challenge additional information text.

Syntax

clientcontrol.ChallengeAdditionalInformation

Default Value

""

Remarks

Text provided by the ACS/Issuer to the cardholder during OOB authentication to replace challenge information text and challenge information text indicator in the OOB template.

This property is read-only.

Data Type

String

ChallengeAdditionalLabel Property (Client Control)

Challenge Additional Label.

Syntax

clientcontrol.ChallengeAdditionalLabel

Default Value

""

Remarks

UI label for the additional choice button provided by the ACS.

This property is read-only.

Data Type

String

ChallengeCancellationIndicator Property (Client Control)

Challenge Cancellation Indicator.

Syntax

clientcontrol.ChallengeCancellationIndicator[=string]

Default Value

""

Remarks

This field is an indicator informing the ACS and the DS that the authentication has been canceled. This is required to be set if the authentication transaction was canceled by the user. This may also be received in the Results Request from the directory server if the ACS identifies that the authentication transaction was canceled for reasons as indicated.

Possible values include:

Data Type

String

ChallengeComplete Property (Client Control)

Whether or not the challenge cycle is complete.

Syntax

clientcontrol.ChallengeComplete

Default Value

False

Remarks

Present in the Challenge Response Message (CRes) and indicates whether the challenge cycle is complete or will require additional messages. If true, the TransactionStatus will be populated as well.

This property is read-only.

Data Type

Boolean

ChallengeDataEntry Property (Client Control)

Cardholder entered data.

Syntax

clientcontrol.ChallengeDataEntry[=string]

Default Value

""

Remarks

This field contains the data that the cardholder entered into the UI.

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

Data Type

String

ChallengeDataEntryTwo Property (Client Control)

Cardholder entered data.

Syntax

clientcontrol.ChallengeDataEntryTwo[=string]

Default Value

""

Remarks

This field contains the data that the cardholder entered into the UI.

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

Data Type

String

ChallengeEntryBoxAutofill Property (Client Control)

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.

Syntax

clientcontrol.ChallengeEntryBoxAutofill

Default Value

False

Remarks

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. When enabled, the 3DS SDK/OS automatically copies the received or saved code or password in the Challenge Data Entry.

This property is read-only and not available at design time.

Data Type

Boolean

ChallengeEntryBoxAutofillType Property (Client Control)

Indicates the type of data expected when the Challenge Data Entry Autofill is active.

Syntax

clientcontrol.ChallengeEntryBoxAutofillType

Default Value

0

Remarks

Indicates the type of data expected when the Challenge Data Entry Autofill is active. 01 = SMS OTP 02 = Password

This property is read-only and not available at design time.

Data Type

Integer

ChallengeEntryBoxKeyboardType Property (Client Control)

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.

Syntax

clientcontrol.ChallengeEntryBoxKeyboardType

Default Value

0

Remarks

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. 0 - Undefined 1 - Numeric keyboard 2 - Alphanumeric keyboard

This property is read-only and not available at design time.

Data Type

Integer

ChallengeEntryBoxLabel Property (Client Control)

Label to specify the expected data entry provided by the ACS.

Syntax

clientcontrol.ChallengeEntryBoxLabel

Default Value

""

Remarks

Label to specify the expected data entry provided by the ACS.

This property is read-only and not available at design time.

Data Type

String

ChallengeEntryBoxLengthMax Property (Client Control)

Indicates to the 3DS SDK the maximum length of the challenge data entry.

Syntax

clientcontrol.ChallengeEntryBoxLengthMax

Default Value

0

Remarks

Indicates to the 3DS SDK the maximum length of the challenge data entry.

This property is read-only and not available at design time.

Data Type

Integer

ChallengeEntryBoxMasking Property (Client Control)

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

Syntax

clientcontrol.ChallengeEntryBoxMasking

Default Value

False

Remarks

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

This property is read-only and not available at design time.

Data Type

Boolean

ChallengeEntryBoxMaskingToggle Property (Client Control)

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

Syntax

clientcontrol.ChallengeEntryBoxMaskingToggle

Default Value

False

Remarks

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

This property is read-only and not available at design time.

Data Type

Boolean

ChallengeEntryBoxTwoAutofill Property (Client Control)

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry.

Syntax

clientcontrol.ChallengeEntryBoxTwoAutofill

Default Value

False

Remarks

Indicates if the 3DS SDK enables the autofill option for the Challenge Data Entry. When enabled, the 3DS SDK/OS automatically copies the received or saved code or password in the Challenge Data Entry.

This property is read-only and not available at design time.

Data Type

Boolean

ChallengeEntryBoxTwoAutofillType Property (Client Control)

Indicates the type of data expected when the Challenge Data Entry Autofill is active.

Syntax

clientcontrol.ChallengeEntryBoxTwoAutofillType

Default Value

0

Remarks

Indicates the type of data expected when the Challenge Data Entry Autofill is active. 01 = SMS OTP 02 = Password

This property is read-only and not available at design time.

Data Type

Integer

ChallengeEntryBoxTwoKeyboardType Property (Client Control)

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard.

Syntax

clientcontrol.ChallengeEntryBoxTwoKeyboardType

Default Value

0

Remarks

Indicates if the 3DS SDK shall display a numeric or alphanumeric keyboard. 0 - Undefined 1 - Numeric keyboard 2 - Alphanumeric keyboard

This property is read-only and not available at design time.

Data Type

Integer

ChallengeEntryBoxTwoLabel Property (Client Control)

Label to specify the expected data entry provided by the ACS.

Syntax

clientcontrol.ChallengeEntryBoxTwoLabel

Default Value

""

Remarks

Label to specify the expected data entry provided by the ACS.

This property is read-only and not available at design time.

Data Type

String

ChallengeEntryBoxTwoLengthMax Property (Client Control)

Indicates to the 3DS SDK the maximum length of the challenge data entry.

Syntax

clientcontrol.ChallengeEntryBoxTwoLengthMax

Default Value

0

Remarks

Indicates to the 3DS SDK the maximum length of the challenge data entry.

This property is read-only and not available at design time.

Data Type

Integer

ChallengeEntryBoxTwoMasking Property (Client Control)

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

Syntax

clientcontrol.ChallengeEntryBoxTwoMasking

Default Value

False

Remarks

Indicates that the 3DS SDK shall mask the data entered by the Cardholder.

This property is read-only and not available at design time.

Data Type

Boolean

ChallengeEntryBoxTwoMaskingToggle Property (Client Control)

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

Syntax

clientcontrol.ChallengeEntryBoxTwoMaskingToggle

Default Value

False

Remarks

Indicates that the 3DS SDK shall display a toggle icon, and display the data entered, if selected by the Cardholder.

This property is read-only and not available at design time.

Data Type

Boolean

ChallengeInfoHeader Property (Client Control)

Challenge information screen header.

Syntax

clientcontrol.ChallengeInfoHeader

Default Value

""

Remarks

This field contains the header text for the challenge information screen that is being presented.

This property is read-only.

Data Type

String

ChallengeInfoLabel Property (Client Control)

Challenge information label.

Syntax

clientcontrol.ChallengeInfoLabel

Default Value

""

Remarks

This field contains the label to modify the challenge data entry field provided by the issuer. If this field is populated, it should be displayed to the cardholder.

This property is read-only.

Data Type

String

ChallengeInfoText Property (Client Control)

Challenge information text.

Syntax

clientcontrol.ChallengeInfoText

Default Value

""

Remarks

This field contains text provided by the ACS/Issuer to the cardholder during the challenge message exchange. If this field is populated, it should be displayed to the cardholder.

This property is read-only.

Data Type

String

ChallengeSelectInfoCount Property (Client Control)

The number of records in the ChallengeSelectInfo arrays.

Syntax

clientcontrol.ChallengeSelectInfoCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChallengeSelectInfoName
• ChallengeSelectInfoValue

The array indices start at 0 and end at ChallengeSelectInfoCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ChallengeSelectInfoName Property (Client Control)

The name of the selection option.

Syntax

clientcontrol.ChallengeSelectInfoName(ChallengeSelectInfoIndex)

Default Value

""

Remarks

The name of the selection option.

The ChallengeSelectInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeSelectInfoCount property.

This property is read-only and not available at design time.

Data Type

String

ChallengeSelectInfoValue Property (Client Control)

The value of the selection option.

Syntax

clientcontrol.ChallengeSelectInfoValue(ChallengeSelectInfoIndex)

Default Value

""

Remarks

The value of the selection option.

The ChallengeSelectInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeSelectInfoCount property.

This property is read-only and not available at design time.

Data Type

String

DataPacketOut Property (Client Control)

Contains the data packet sent to the server.

Syntax

clientcontrol.DataPacketOut

Default Value

""

Remarks

After calling either the RequestCardRanges, or SendAuthRequest methods, this property will contain the entire data packet that was sent. Also, after calling the GetChallengeRequest or GetResultsResponse method, this property will contain the constructed messages. The contents of this property should be logged for each transaction.

This property is read-only and not available at design time.

Data Type

String

DeviceBindingDataEntry Property (Client Control)

Device Binding Data Entry.

Syntax

clientcontrol.DeviceBindingDataEntry[=boolean]

Default Value

False

Remarks

Indicator provided by the 3DS SDK to the ACS to confirm whether the Cardholder gives consent to bind the device.

Data Type

Boolean

DeviceBindingInformationText Property (Client Control)

Device binding information text.

Syntax

clientcontrol.DeviceBindingInformationText

Default Value

""

Remarks

Text provided by the ACS to the Cardholder during the Device Binding process.

This property is read-only.

Data Type

String

DeviceParamCount Property (Client Control)

The number of records in the DeviceParam arrays.

Syntax

clientcontrol.DeviceParamCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• DeviceParamCategory
• DeviceParamFieldName
• DeviceParamValue
• DeviceParamValueType

The array indices start at 0 and end at DeviceParamCount - 1.

This property is not available at design time.

Data Type

Integer

DeviceParamCategory Property (Client Control)

The category of the parameter.

Syntax

clientcontrol.DeviceParamCategory(DeviceParamIndex)[=integer]

Default Value

0

Remarks

The category of the parameter. Possible values include:

The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

Integer

DeviceParamFieldName Property (Client Control)

The name of the parameter.

Syntax

clientcontrol.DeviceParamFieldName(DeviceParamIndex)[=string]

Default Value

""

Remarks

The name of the parameter.

The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

String

DeviceParamValue Property (Client Control)

The value of the parameter.

Syntax

clientcontrol.DeviceParamValue(DeviceParamIndex)[=string]

Default Value

""

Remarks

The value of the parameter.

The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

String

DeviceParamValueType Property (Client Control)

The type of the value.

Syntax

clientcontrol.DeviceParamValueType(DeviceParamIndex)[=integer]

Possible Values

vtObject(0), 
vtArray(1), 
vtString(2), 
vtNumber(3), 
vtBool(4), 
vtNull(5), 
vtRaw(6)

Default Value

2

Remarks

The type of the value. Possible values are:

The DeviceParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DeviceParamCount property.

This property is not available at design time.

Data Type

Integer

DirectoryServerCertStore Property (Client Control)

The name of the certificate store for the client certificate.

Syntax

clientcontrol.DirectoryServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The DirectoryServerCertStoreType property denotes the type of the certificate store specified by DirectoryServerCertStore. If the store is password-protected, specify the password in DirectoryServerCertStorePassword.

DirectoryServerCertStore is used in conjunction with the DirectoryServerCertSubject property to specify client certificates. If DirectoryServerCertStore has a value, and DirectoryServerCertSubject or DirectoryServerCertEncoded is set, a search for a certificate is initiated. Please see the DirectoryServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DirectoryServerCertStoreB.

Data Type

Binary String

DirectoryServerCertStorePassword Property (Client Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

clientcontrol.DirectoryServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

DirectoryServerCertStoreType Property (Client Control)

The type of certificate store for this certificate.

Syntax

clientcontrol.DirectoryServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

DirectoryServerCertSubject Property (Client Control)

The subject of the certificate used for client authentication.

Syntax

clientcontrol.DirectoryServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

DirectoryServerCertEncoded Property (Client Control)

The certificate (PEM/Base64 encoded).

Syntax

clientcontrol.DirectoryServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The DirectoryServerCertStore and DirectoryServerCertSubject properties also may be used to specify a certificate.

When DirectoryServerCertEncoded is set, a search is initiated in the current DirectoryServerCertStore for the private key of the certificate. If the key is found, DirectoryServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, DirectoryServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .DirectoryServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

DirectoryServerId Property (Client Control)

Value of the Registered Application Provider Identifier (RID) unique to the payment system.

Syntax

clientcontrol.DirectoryServerId[=string]

Default Value

""

Remarks

Registered Application Provider Identifier (RID) value defined by the ISO 7816-5 standard for uniquely registering such providers. This value is unique to the Payment System involved and must be known by the 3DS Requestor App so that it may be passed to the SDK on when it invokes the createTransaction method within the SDK. Used to identify the DirectoryServerCert for the given DS which is used by the SDK to encrypt the Device Information. Required when DirectoryServerCert is an EC key.

Data Type

String

DirectoryServerKeyId Property (Client Control)

Directory Server Key Identifier (kid).

Syntax

clientcontrol.DirectoryServerKeyId[=string]

Default Value

""

Remarks

Used to specify the Directory Server Key Identifier. There may be multiple keys for each DS, with each key having a unique identifier.

Data Type

String

EnableChallengeInfoTextIndicator Property (Client Control)

Challenge information text indicator.

Syntax

clientcontrol.EnableChallengeInfoTextIndicator

Default Value

False

Remarks

This field indicates when the ACS/Issuer would like a warning icon or similar visual indicator to draw attention to the ChallengeInfoText that is being displayed. If this field is populated, it should affect the information being displayed to the cardholder.

This property is read-only.

Data Type

Boolean

ErrorPacket Property (Client Control)

The error packet.

Syntax

clientcontrol.ErrorPacket

Default Value

""

Remarks

If an error is encountered while parsing a received packet using the CheckResponse method, this field will be populated with an error packet to be sent back to the server.

If the message being parsed is an error, this field will be populated with the received error packet itself.

This property is read-only.

Data Type

String

ExpandableInformationLabel Property (Client Control)

Expandable information label.

Syntax

clientcontrol.ExpandableInformationLabel

Default Value

""

Remarks

Label displayed to the cardholder for the content in ExpandableInformationText.

This property is read-only.

Data Type

String

ExpandableInformationText Property (Client Control)

Expandable information text.

Syntax

clientcontrol.ExpandableInformationText

Default Value

""

Remarks

This field contains text provided by the Issuer from the ACS to be displayed to the cardholder for additional information. The format should be an expandable text field.

This property is read-only.

Data Type

String

ExtensionCount Property (Client Control)

The number of records in the Extension arrays.

Syntax

clientcontrol.ExtensionCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ExtensionCritical
• ExtensionData
• ExtensionId
• ExtensionName

The array indices start at 0 and end at ExtensionCount - 1.

This property is not available at design time.

Data Type

Integer

ExtensionCritical Property (Client Control)

Whether the extension is critical.

Syntax

clientcontrol.ExtensionCritical(ExtensionIndex)[=boolean]

Default Value

False

Remarks

Whether the extension is critical.

This setting specifies whether the recipient must understand the contents of the extension to interpret the entire message.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

Boolean

ExtensionData Property (Client Control)

The extension data as JSON.

Syntax

clientcontrol.ExtensionData(ExtensionIndex)[=string]

Default Value

""

Remarks

The extension data as JSON.

This setting specifies the JSON formatted extension data.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

String

ExtensionId Property (Client Control)

The id of the specified extension.

Syntax

clientcontrol.ExtensionId(ExtensionIndex)[=string]

Default Value

""

Remarks

The id of the specified extension.

This setting specifies a unique identifier for the extension.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

String

ExtensionName Property (Client Control)

The extension name.

Syntax

clientcontrol.ExtensionName(ExtensionIndex)[=string]

Default Value

""

Remarks

The extension name.

This setting specifies the name of the extension as defined by the extension owner.

The ExtensionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExtensionCount property.

This property is not available at design time.

Data Type

String

IssuerImage1 Property (Client Control)

Issuer image URL 1.

Syntax

clientcontrol.IssuerImage1

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: Medium Density Image in 2.3.1: Default Image

This property is read-only and not available at design time.

Data Type

String

IssuerImage2 Property (Client Control)

Issuer image URL 2.

Syntax

clientcontrol.IssuerImage2

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: High Density Image in 2.3.1: Dark Mode Image

This property is read-only and not available at design time.

Data Type

String

IssuerImage3 Property (Client Control)

Issuer image URL 3.

Syntax

clientcontrol.IssuerImage3

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the issuer logo or image to be used in the Native UI. before 2.3.1: Extra High-Density Image in 2.3.1: Monochrome Image

This property is read-only and not available at design time.

Data Type

String

MessageVersion Property (Client Control)

Message version.

Syntax

clientcontrol.MessageVersion[=string]

Default Value

"2.1.0"

Remarks

This field indicates the protocol version. This should be the protocol version number of the specification utilized by the system creating this message.

Possible values are:

Data Type

String

OOBAppLabel Property (Client Control)

OOB App label.

Syntax

clientcontrol.OOBAppLabel

Default Value

""

Remarks

Label to be displayed for the link to the OOB App URL. For example: "Click here to open Your Bank App."

This property is read-only.

Data Type

String

OOBAppStatus Property (Client Control)

OOB App status.

Syntax

clientcontrol.OOBAppStatus[=integer]

Default Value

0

Remarks

Status code indicating the problem type encountered when using the OOB App URL. 1 = Open OOB App URL failed

Data Type

Integer

OOBAppURL Property (Client Control)

OOB App label.

Syntax

clientcontrol.OOBAppURL

Default Value

""

Remarks

Universal App Link to an authentication app used in the OOB authentication. The OOB App URL will open the appropriate location within the OOB Authentication App.

This property is read-only.

Data Type

String

OOBAppURLIndicator Property (Client Control)

OOB App URL Indicator.

Syntax

clientcontrol.OOBAppURLIndicator[=integer]

Default Value

1

Remarks

Indicates if the 3DS SDK supports the OOB App URL. 01 = Supported 02 = Not supported by the device 03 = Not supported by the 3DS Requestor

Data Type

Integer

OOBContinuationIndicator Property (Client Control)

OOB continuation indicator.

Syntax

clientcontrol.OOBContinuationIndicator[=integer]

Default Value

0

Remarks

An indicator notifying the ACS that the cardholder has completed the authentication as requested by selecting the continue button in an out-of-band (OOB) authentication method. This is exclusive to the app flow and required when the ACSUIType is set to OOB when the user has selected the continue option on the device.

Data Type

Integer

OOBContinueLabel Property (Client Control)

OOB continuation label.

Syntax

clientcontrol.OOBContinueLabel

Default Value

""

Remarks

Label to be used in the UI for the button that the user selects when they have completed the OOB authentication.

This property is read-only.

Data Type

String

PaymentSystemImage1 Property (Client Control)

Payment system image URL 1.

Syntax

clientcontrol.PaymentSystemImage1

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: Medium Density Image in 2.3.1: Default Image

This property is read-only and not available at design time.

Data Type

String

PaymentSystemImage2 Property (Client Control)

Payment system image URL 2.

Syntax

clientcontrol.PaymentSystemImage2

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: High Density Image in 2.3.1: Dark Mode Image

This property is read-only and not available at design time.

Data Type

String

PaymentSystemImage3 Property (Client Control)

Payment system image URL 3.

Syntax

clientcontrol.PaymentSystemImage3

Default Value

""

Remarks

Sent in the initial CRes message from the ACS to the 3DS SDK to provide the URL(s) of the directory server or payment system logo or image to be used in the Native UI. before 2.3.1: Extra High-Density Image in 2.3.1: Monochrome Image

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (Client Control)

The type of authorization to perform when connecting to the proxy.

Syntax

clientcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (Client Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

clientcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (Client Control)

A password if authentication is to be used for the proxy.

Syntax

clientcontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (Client Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

clientcontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (Client Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

clientcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (Client Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

clientcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (Client Control)

A username if authentication is to be used for the proxy.

Syntax

clientcontrol.ProxyUser[=string]

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RequestorAppURL Property (Client Control)

3DS Requestor App URL.

Syntax

clientcontrol.RequestorAppURL[=string]

Default Value

""

Remarks

3DS Requestor App declaring its URL within the CReq message so that the Authentication app can call the 3DS Requestor App after OOB authentication has occurred. Note: When providing the 3DS Requestor App URL, the 3DS Requestor needs to properly register the URL with the Operating System.

Data Type

String

ResendInformationLabel Property (Client Control)

Label for UI button allowing users to request that authentication information be resent.

Syntax

clientcontrol.ResendInformationLabel

Default Value

""

Remarks

Value of text to be displayed on the UI label on the button users click for authentication information to be resent. Sent in CRes if the ACS allows the Cardholder to request such information to be resent. App-based only.

This property is read-only.

Data Type

String

SDKAppId Property (Client Control)

The unique SDK App Id.

Syntax

clientcontrol.SDKAppId[=string]

Default Value

""

Remarks

This property must be set to a universally unique Id created for a specific installation of the app on a consumer device. The app is responsible for generating and storing the SDKAppId for each installation or update. This property must be set before calling GetAuthRequest.

The value assigned here must be 36 characters and be in the format defined in IETF RFC 4122. For example: 8a880dc0-d2d2-4067-bcb1-b08d1690b26e.

Data Type

String

SDKTransactionId Property (Client Control)

SDK Transaction ID.

Syntax

clientcontrol.SDKTransactionId[=string]

Default Value

""

Remarks

This field contains the universally unique transaction identifier assigned by the 3DS SDK to identify a single transaction. This is generated by the control when calling the GetAuthRequest method. Shall be provided to the 3DS Server for the purpose of uniquely identifying this transaction within all messages of the authentication process, beginning with the AReq sent by the Server.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (Client Control)

The date on which this certificate becomes valid.

Syntax

clientcontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (Client Control)

The date on which the certificate expires.

Syntax

clientcontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (Client Control)

A comma-delimited list of extended key usage identifiers.

Syntax

clientcontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (Client Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (Client Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (Client Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (Client Control)

The issuer of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (Client Control)

The private key of the certificate (if available).

Syntax

clientcontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (Client Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

clientcontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (Client Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

clientcontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (Client Control)

The public key of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (Client Control)

The textual description of the certificate's public key algorithm.

Syntax

clientcontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (Client Control)

The length of the certificate's public key (in bits).

Syntax

clientcontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (Client Control)

The serial number of the certificate encoded as a string.

Syntax

clientcontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (Client Control)

The text description of the certificate's signature algorithm.

Syntax

clientcontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (Client Control)

The name of the certificate store for the client certificate.

Syntax

clientcontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (Client Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

clientcontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (Client Control)

The type of certificate store for this certificate.

Syntax

clientcontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (Client Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

clientcontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (Client Control)

The MD5 hash of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (Client Control)

The SHA-1 hash of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (Client Control)

The SHA-256 hash of the certificate.

Syntax

clientcontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (Client Control)

The text description of UsageFlags .

Syntax

clientcontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (Client Control)

The flags that show intended use for the certificate.

Syntax

clientcontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (Client Control)

The certificate's version number.

Syntax

clientcontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (Client Control)

The subject of the certificate used for client authentication.

Syntax

clientcontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (Client Control)

The certificate (PEM/Base64 encoded).

Syntax

clientcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (Client Control)

The date on which this certificate becomes valid.

Syntax

clientcontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (Client Control)

The date on which the certificate expires.

Syntax

clientcontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (Client Control)

A comma-delimited list of extended key usage identifiers.

Syntax

clientcontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (Client Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

clientcontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (Client Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

clientcontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (Client Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

clientcontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (Client Control)

The issuer of the certificate.

Syntax

clientcontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (Client Control)

The private key of the certificate (if available).

Syntax

clientcontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (Client Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

clientcontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (Client Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

clientcontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (Client Control)

The public key of the certificate.

Syntax

clientcontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (Client Control)

The textual description of the certificate's public key algorithm.

Syntax

clientcontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (Client Control)

The length of the certificate's public key (in bits).

Syntax

clientcontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (Client Control)

The serial number of the certificate encoded as a string.

Syntax

clientcontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (Client Control)

The text description of the certificate's signature algorithm.

Syntax

clientcontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (Client Control)

The name of the certificate store for the client certificate.

Syntax

clientcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (Client Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

clientcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (Client Control)

The type of certificate store for this certificate.

Syntax

clientcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (Client Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

clientcontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (Client Control)

The MD5 hash of the certificate.

Syntax

clientcontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (Client Control)

The SHA-1 hash of the certificate.

Syntax

clientcontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (Client Control)

The SHA-256 hash of the certificate.

Syntax

clientcontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (Client Control)

The text description of UsageFlags .

Syntax

clientcontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (Client Control)

The flags that show intended use for the certificate.

Syntax

clientcontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (Client Control)

The certificate's version number.

Syntax

clientcontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (Client Control)

The subject of the certificate used for client authentication.

Syntax

clientcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (Client Control)

The certificate (PEM/Base64 encoded).

Syntax

clientcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLServerCertEffectiveDate Property (Client Control)

The date on which this certificate becomes valid.

Syntax

clientcontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (Client Control)

The date on which the certificate expires.

Syntax

clientcontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (Client Control)

A comma-delimited list of extended key usage identifiers.

Syntax

clientcontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (Client Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

clientcontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (Client Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

clientcontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (Client Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

clientcontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (Client Control)

The issuer of the certificate.

Syntax

clientcontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (Client Control)

The private key of the certificate (if available).

Syntax

clientcontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (Client Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

clientcontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (Client Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

clientcontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (Client Control)

The public key of the certificate.

Syntax

clientcontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (Client Control)

The textual description of the certificate's public key algorithm.

Syntax

clientcontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (Client Control)

The length of the certificate's public key (in bits).

Syntax

clientcontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (Client Control)

The serial number of the certificate encoded as a string.

Syntax

clientcontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (Client Control)

The text description of the certificate's signature algorithm.

Syntax

clientcontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (Client Control)

The name of the certificate store for the client certificate.

Syntax

clientcontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (Client Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

clientcontrol.SSLServerCertStorePassword

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (Client Control)

The type of certificate store for this certificate.

Syntax

clientcontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (Client Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

clientcontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (Client Control)

The MD5 hash of the certificate.

Syntax

clientcontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (Client Control)

The SHA-1 hash of the certificate.

Syntax

clientcontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (Client Control)

The SHA-256 hash of the certificate.

Syntax

clientcontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (Client Control)

The text description of UsageFlags .

Syntax

clientcontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (Client Control)

The flags that show intended use for the certificate.

Syntax

clientcontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (Client Control)

The certificate's version number.

Syntax

clientcontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (Client Control)

The subject of the certificate used for client authentication.

Syntax

clientcontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (Client Control)

The certificate (PEM/Base64 encoded).

Syntax

clientcontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

SubmitAuthenticationLabel Property (Client Control)

Label for UI button users select to submit authentication.

Syntax

clientcontrol.SubmitAuthenticationLabel

Default Value

""

Remarks

Value of text to be displayed on the UI label on the button users click to submit the authentication information they have entered. Sent in CRes if ACSUIType is 01 (Text), 02 (Single Select) or 02 (Multi Select). App-based only.

This property is read-only.

Data Type

String

Timeout Property (Client Control)

A timeout for the control.

Syntax

clientcontrol.Timeout[=integer]

Default Value

30

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 30 seconds.

Data Type

Integer

TogglePositionIndicator Property (Client Control)

Toggle Position Indicator.

Syntax

clientcontrol.TogglePositionIndicator

Default Value

0

Remarks

Indicates if the Trust List and/or Device Binding prompt should be presented below or above the action buttons.

This property is read-only.

Data Type

Integer

TransactionStatus Property (Client Control)

The transaction status from the last parsed message (ARes, RReq, or CRes).

Syntax

clientcontrol.TransactionStatus

Default Value

""

Remarks

Indicates whether a transaction qualifies as an authenticated transaction or account verification. Possible values are:

Note: The CRes message can contain only a value of Y or N. Values of D and I are only applicable for 3DS version 2.2.0.

This property is read-only.

Data Type

String

UseAdditionalChallenge Property (Client Control)

Whether or not the additional choice button is selected.

Syntax

clientcontrol.UseAdditionalChallenge[=boolean]

Default Value

False

Remarks

Indicates to the ACS that the Cardholder selected the additional choice.

Data Type

Boolean

UseInformationContinuation Property (Client Control)

Whether or not the Information Continue button is selected.

Syntax

clientcontrol.UseInformationContinuation[=boolean]

Default Value

False

Remarks

Indicator notifying the ACS that the Cardholder selected the Information Continue button in the Information UI template.

Data Type

Boolean

WhitelistingDataEntry Property (Client Control)

Whitelisting Data Entry.

Syntax

clientcontrol.WhitelistingDataEntry[=boolean]

Default Value

False

Remarks

An indicator provided by the SDK to the ACS to confirm whether whitelisting was opted by the cardholder (true or false). This is required to be sent after a challenge response is received containing WhitelistingInformationText.

Data Type

Boolean

WhitelistingInformationText Property (Client Control)

Whitelisting information text.

Syntax

clientcontrol.WhitelistingInformationText

Default Value

""

Remarks

Text provided by the ACS/Issuer to Cardholder during a Whitelisting transaction. For example: "Would you like to add this Merchant to your whitelist?"

If present in the challenge response, this must be displayed by the SDK.

This property is read-only.

Data Type

String

WhyInformationLabel Property (Client Control)

Label for why information section.

Syntax

clientcontrol.WhyInformationLabel

Default Value

""

Remarks

Label provided by the Issuer for the UI "why" information section. Can be sent in CRes. App-based only.

This property is read-only.

Data Type

String

WhyInformationText Property (Client Control)

Text to explain the authentication task to the user.

Syntax

clientcontrol.WhyInformationText

Default Value

""

Remarks

Text provided by the Issuer for UI to explain the authentication task to the user in the "why" information section. Can be sent in CRes. App-based only.

This property is read-only.

Data Type

String

AddDeviceParam Method (Client Control)

Adds a device parameter to the collection.

Syntax

clientcontrol.AddDeviceParam field, value, valueType, category

Remarks

AddDeviceParam adds a new device parameter to the DeviceParams collection. These parameters should be obtained from the consumer device and a full list of available parameters can be found in the EMV® 3-D Secure SDK-Device Information document provided by EMVCo.

The ValueType parameter specifies the type of the value. Possible values are:

• 1 (Array)
• 2 (String)

Most parameters will have a value type of 2 (String), which will contain a single, string value. Some parameters, however, may require an array of strings. For example, the A040 parameter is defined as containing a set of paired Bluetooth devices. All of these devices can be specified via an array like so: client.addDeviceParam("A040", "[\"firstDevice\", \"secondDevice\", \"thirdDevice\"]", 1, 1);

There are four categories of device information parameters:

DV - Data Version

This is the version of the data being specified. This is 1.0 by default, but can be set to a different value as shown below. When setting the data version, only the value of the parameter needs to be specified. client1.AddDeviceParam("", "1.1", 2, 0);

DD - Device Data

This category is used to specify the device parameters collected from the mobile platform. // the device platform is Android client1.AddDeviceParam("C001", "Android", 2, 1); // the device model is an HTC One (M8) client1.AddDeviceParam("C002", "HTCOne_M8", 2, 1);

DPNA - Device Parameter Not Available

This category is used to specify reasons for unavailable device parameters. // IP Address couldn't be specified because of a "market or regional restriction on the parameter." client1.AddDeviceParam("C010", "RE01", 2, 2);

SW - Security Warning

This category of parameter is used to specify security warnings. These are used to let the directory server know of the result of checks made by the application upon initialization. When setting security warning parameters, only the name of the parameter needs to be specified. // the device is jailbroken client1.AddDeviceParam("SW01", "", 2, 3); // A debugger is attached to the app client1.AddDeviceParam("SW04", "", 2, 3);

AddExtension Method (Client Control)

Adds an extension to the collection.

Syntax

clientcontrol.AddExtension Id, Name, Critical, Data

Remarks

Data necessary to support requirements not otherwise defined in the 3-D Secure message are carried in Message Extensions. AddExtension adds a new extension to the Extensions collection.

Note: The maximum number of extensions is 10.

AddRequestField Method (Client Control)

Adds a field to the data in the request.

Syntax

clientcontrol.AddRequestField Name, Value, ValueType

Remarks

This method can be used to extend the requests constructed by the control. When this method is called, the component will add the specified field to the end of the request.

CheckAuthResponse Method (Client Control)

Checks the received packet.

Syntax

clientcontrol.CheckAuthResponse authResponse

Remarks

After the response to the authentication request is received from the 3DS Server control, call CheckAuthResponse to verify and parse the response. See the 3DS Server's SendAuthRequest method for details about obtaining the response.

Before calling this method, ACSRootCerts must be populated with the root certificates used by the ACS to sign the response. This method will validate the signature of the signed content if present.

After calling this method, inspect TransactionStatus to determine if the transaction requires a challenge. If TransactionStatus is C, a challenge is required and SendChallengeRequest should be called to proceed with the challenge flow. If TransactionStatus is D, decoupled authentication will take place outside of the 3-D Secure flow and the results will be posted to the 3DS Server.

If TransactionStatus is Y or A, the transaction is complete.

Config Method (Client Control)

Sets or retrieves a configuration setting.

Syntax

clientcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetAuthRequest Method (Client Control)

Prepares data to be sent by the 3DS Server.

Syntax

clientcontrol.GetAuthRequest 

Remarks

GetAuthRequest encrypts the device info and prepares all the data necessary to be sent by the 3DS Server control in the SendAuthRequest method.

After calling this method, the returned data must be transmitted via a separate secure channel to the server where 3DS Server is being used.

The following properties are required before calling the method:

Calling this method returns required information used by 3DS Server to send the authentication request. Transmit the value returned by this method to the system where 3DS Server is used. The method used to transmit this value is outside the scope of the control.

See SendAuthRequest for details on sending the authentication request after transmitting the data to the 3DS Server.

Calling this method also populates SDKTransactionId which uniquely identifies this transaction and must be used in subsequent calls relating to this transaction, such as SendChallengeRequest.

Interrupt Method (Client Control)

Interrupts the current action.

Syntax

clientcontrol.Interrupt 

Remarks

This method interrupts any processing that the control is currently executing.

Reset Method (Client Control)

Clears all properties to their default values.

Syntax

clientcontrol.Reset 

Remarks

This method clears all properties to their default values.

ResetTransactionInfo Method (Client Control)

Resets transaction specific information.

Syntax

clientcontrol.ResetTransactionInfo 

Remarks

This method must be called between transactions when using the same control instance.

Each transaction that is attempted uses transaction specific values that should not be re-used in subsequent transactions. Call this method to make sure that any transaction specific information is cleared between transactions.

This method resets only the transaction specific information without resetting any other values which have been configured. This allows re-use of the same component instance.

In an App-Based flow the following are reset:

• Internal ephemeral encryption keys
• Values added by AddRequestField
• ACSHTML
• ACSHTMLRefresh
• ACSUIType
• ChallengeAdditionalInformation
• ChallengeComplete
• ChallengeDataEntry
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ChallengeSelectInfo
• DataPacketOut
• DeviceParams
• ErrorPacket
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• OOBContinuationIndicator
• OOBContinueLabel
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• SDKTransactionId
• SubmitAuthenticationLabel
• TransactionStatus
• WhyInformationLabel
• WhyInformationText
• WhitelistingDataEntry
• WhitelistingInformationText
• ACSSignedContent
• ACSTransactionId
• ACSURL
• ChallengeCancellationIndicator
• DSTransactionId
• DecoupledRequestIndicator
• IncomingRawExtensions
• OutgoingRawExtensions
• Extensions
• IncomingExtensionCount
• IncomingExtensionId
• IncomingExtensionName
• IncomingExtensionCritical
• IncomingExtensionData
• OOBAppLabel
• OOBAppURL
• ResendChallengeInfo
• TransactionStatusReason
• MerchantAppURL

SendChallengeRequest Method (Client Control)

Builds and sends the Challenge Request in an app-based challenge flow.

Syntax

clientcontrol.SendChallengeRequest 

Remarks

SendChallengeRequest sends the Challenge Request to the ACS when a challenge is required.

When the TransactionStatus is C after calling CheckAuthResponse, a challenge to the cardholder is required. This method sends the challenge request and parses the response. The ACS may provide multiple challenges to the cardholder during this process. As a result this method may need to be called multiple times throughout the authentication process.

After this method is called, check ChallengeComplete to determine if the challenge process is complete. If it is complete (True), check TransactionStatus to determine the outcome. If ChallengeComplete is False, additional challenge interaction is required.

First Request

The first time this method is called, information about the required challenge is obtained from the ACS. The ACS connection information is automatically set when CheckAuthResponse is called; there is no need to specify any ACS connection information.

All required properties for the first call to this method are automatically set after CheckAuthResponse is called. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS.

After calling this method, the ACS will respond with details about the challenge to be presented to the cardholder. The ACSUIType property indicates the way the ACS will interact with the cardholder. The ChallengeComplete property will be False after the first call to this method since the challenge interaction is not yet complete.

The following properties are applicable when ACSUIType is Text (01), Single-Select (02), or Multi-Select (03):

• ChallengeSelectInfo
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• SubmitAuthenticationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is Out-of-Band (04):

• ChallengeAdditionalInformation
• ChallengeInfoHeader
• ChallengeInfoLabel
• ChallengeInfoText
• EnableChallengeInfoTextIndicator
• ExpandableInformationLabel
• ExpandableInformationText
• IssuerImage1
• IssuerImage2
• IssuerImage3
• OOBContinueLabel
• PaymentSystemImage1
• PaymentSystemImage2
• PaymentSystemImage3
• ResendInformationLabel
• WhyInformationLabel
• WhyInformationText

Use the values in the above properties to populate values in the native UI in the app. The UI must follow the guidelines defined in the EMV® 3-D Secure specification.

The following properties are applicable when ACSUIType is HTML (05):

• ACSHTML
• ACSHTMLRefresh

In the case of an HTML interaction, the app should create a webview and populate this with the HTML in ACSHTML.

As per the EMV® 3-D Secure specification, the HTML UI is presented to the cardholder via a web view which remains in control of the app. The app must intercept any remote URL requests made from within the web view, and instead handle them within the app. Preventing the cardholder from making requests in the web view to another server is critical to the security of the environment. According to the EMVCo specification, intercepting these requests has two effects:

• Prevents malicious HTML from redirecting a user to a phishing site.
• Conceptually puts the web view form under the control of the ACS, rather than the app.

• Navigation attempts from within the web view must be captured by the app and handled internally. This includes all requests including images, javascript files, css, etc.
• The web view element is not utilized as a browser, but as a UI element whose content is provided by the ACS.

Second Request

The second time this method is called, the purpose is to provide a response to the ACS. At this point the customer should have responded to the challenge provided by the ACS in the response to the first call. If the transaction has been canceled, set ChallengeCancellationIndicator to inform the ACS. The following properties are applicable when calling this method the second time:

• ChallengeDataEntry
• OOBContinuationIndicator

When ACSUIType is Text (01) or HTML (05), set ChallengeDataEntry to the data exactly as it was specified by the cardholder. Do not format or otherwise change the data.

When ACSUIType is Single-Select (02), set ChallengeDataEntry to the name of the selected option. For instance the ACS may provide the user with a selection like:

mobile: **** **** 329
email: s******k**@g***.com

When ACSUIType is Multi-Select (03), set ChallengeDataEntry to a comma-separated list of names of the selected options. For instance if ChallengeSelectInfo contains elements with names like chicago_illinois, st_louis_missouri, and portland_oregon, and the user chose two options, the value specified in ChallengeDataEntry would be chicago_illinois,portland_oregon.

When ACSUIType is OOB (04), set OOBContinuationIndicator to True to indicate the cardholder has pressed the button signaling their completing of the OOB process.

Completing the Challenge

After calling SendChallengeRequest a second time with the cardholder's responses, the ACS may require additional challenges. Check the ChallengeComplete property to determine if the challenge is complete. If False, more challenges are required by the ACS and the same process of displaying the challenge info, collecting the response, and submitting it to the ACS should be performed again.

If ChallengeComplete is True, the challenge interaction is complete and TransactionStatus can be inspected to determine whether the transaction was successful.

Note: As part of the challenge completion the ACS also notifies the 3DS Server of the results. This is done by posting the results to the URL defined by the ResultsURL property of the 3DS Server control.

DataPacketIn Event (Client Control)

Fired when receiving a data packet from the server.

Syntax

Sub clientcontrol_DataPacketIn(DataPacket As String)

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the DataPacket parameter. This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this component.

DataPacketOut Event (Client Control)

Fired when sending a data packet to the server.

Syntax

Sub clientcontrol_DataPacketOut(DataPacket As String)

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the DataPacket parameter. This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this component.

Error Event (Client Control)

Information about errors during data delivery.

Syntax

Sub clientcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (Client Control)

Fires once for each log message.

Syntax

Sub clientcontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

Logging in the component is handled through the Log event. This will fire anytime a message is built or a response is parsed, including error messages.

When the Log event is fired, the message in question is made available via the Message event parameter. Properties such as EphemeralKey and DeviceParams are also available when they are gathered by the Client. The other event arguments are LogType and LogLevel:

The LogType parameter indicates the type of the log entry. Possible values are:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"
• "AReq"
• "ARes"
• "CReq"
• "CRes"
• "RReq"
• "RRes"
• "PReq"
• "PRes"
• "Erro"
• "EphemeralKey"
• "DeviceParams"

It is recommended to output all messages raised in this event to a file for record keeping purposes, or for later debugging issues that may have come up.

The Server and Client components also have DataPacketIn and DataPacketOut events that fire anytime a data packet is received or sent, respectively. The entire data packet is then accessible in the DataPacket event parameter. For encrypted packets, this would contain the full encrypted data. This parameter may be inspected for advanced troubleshooting.

SSLServerAuthentication Event (Client Control)

Fired after the server presents its certificate to the client.

Syntax

Sub clientcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Client Control)

Fired when secure connection progress messages are available.

Syntax

Sub clientcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (Client Control)

Client Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Trappable Errors (Client Control)

Client Errors

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors