KBA settings

KBA settings control how knowledge-based authentication is applied to a signer. Use the kbaSettings object when the signer's authenticationType is set to KBA.

kbaSettings object

The kbaSettings object supports the following properties.

Property	Type	Description	Supported values
`type`	string	Controls how often the signer must complete KBA.	`EveryAccess`, `UntilSignCompleted`, `OncePerDocument`
`maximumRetryCount`	integer	Controls the maximum number of KBA attempts for the signer.	Integer from `1` to `3`
`nameMatcher`	string	Controls how strictly BoldSign compares the signer name with the identity details provided during KBA.	`None`, `Lenient`, `Moderate`, `Strict`

Example

{
  "authenticationType": "KBA",
  "kbaSettings": {
    "type": "EveryAccess",
    "maximumRetryCount": 3,
    "nameMatcher": "Strict"
  }
}

type

The type property controls how often the signer must complete KBA.

Value	Description
`EveryAccess`	The signer must complete KBA every time they access the document.
`UntilSignCompleted`	The signer must complete KBA each time they access the document until signing is completed.
`OncePerDocument`	The signer must complete KBA only once for the document.

maximumRetryCount

The maximumRetryCount property controls how many KBA attempts are allowed for the signer.

KBA supports retry values from 1 to 3.

If the signer fails KBA and reaches the maximum number of attempts, access is restricted for that signer until the sender takes action.

nameMatcher

The nameMatcher property controls how BoldSign compares the signer name with the identity details provided during KBA.

Value	Description
`None`	Name matching is not performed.
`Lenient`	Allows more flexible matching for minor spelling or formatting differences.
`Moderate`	Allows minor variations, such as middle name, initials, or small formatting differences.
`Strict`	Requires the signer name to closely match the identity details.

We recommend keeping KBA name matching enabled by using Strict, Moderate, or Lenient. Use None only when your workflow intentionally does not require the signer's name to be compared with the identity details provided during KBA.