To download the full code sample see our Code Share site.

To add an extra layer of security to your online transactions, OneSpan Sign offers robust and flexible recipient-authentication options. Specifically, you can select various ways of validating the identity of the recipient of an invitation to a transaction before they are permitted to access the transaction's documents.

General Authentication refers to tools built into OneSpan Sign that enable you to verify the identity of the recipient through SMS, Email, or a custom Question and Answer format.

Knowledge-Based Authentication Knowledge Based Authentication (KBA) allows you to present challenge questions to your recipient. If the recipient provides the correct answers, they are verified as the correct recipient of the transaction. (KBA) relies on a third-party KBA provider to perform the authentication. That provider is either Equifax US or Equifax Canada.

KBA questions are generated dynamically, based on information in a signer's personal credit report.

KBA authentication can be used in conjunction with any one of the General authentication methods above.

To enable Knowledge-Based Authentication, please contact our Support Team.

Using General Authentication

The code below illustrates how to edit the signer block for each general authentication method. If you need a comparison with basic document-object creation, or if this is your first time creating a package with the Java SDK, see this Creating a Transaction.

 .withSigner( newSignerWithEmail( "[email protected]" )   .withFirstName( "First" )   .withLastName( "Signer" )   .challengedWithQuestions( ChallengeBuilder.firstQuestion( "What's your favorite sport?"   )   .answer( "soccer" )   .secondQuestion( "What music instrument do you play?"   )   .answer( "drums" ) ) )   .withSigner( newSignerWithEmail( "[email protected]" )   .withFirstName( "Second" )   .withLastName( "Signer" )   .withSmsSentTo( "1234567890" ) ) 

Manually sending an SMS code

A new SMS code is generated and sent each time a signer clicks the email link. If for any reason you need to manually send a new SMS code, you can do so by using PackageService and passing the PackageId and Signer objects as parameters. The following code will do this:

 eslClient.getPackageService().sendSmsToSigner(packageId, retrievedPackage.getSigner(email1)); 

Using KBA

You can also authenticate a signer with KBA. You can also edit the signer block to implement KBA. The withTimeAtAddress field can be left empty. The following code will do this:

 .withSigner(newSignerWithEmail("[email protected]")   .withFirstName("John")   .withLastName("Doe")   .challengedWithKnowledgeBasedAuthentication(newSignerInformationForEquifaxUSA()   .withFirstName("John")   .withLastName("Doe")   .withStreetAddress("2020 Broadway Street")   .withCity("New York")   .withZip("12345")   .withState("NY")   .withSocialSecurityNumber("123456789")   .withDateOfBirth(new DateTime().minusYears(15).toDate())   .withHomePhoneNumber("1234567890")   .withDriversLicenseNumber("1234567890")   .withTimeAtAddress(32))) 

Results

After running your code, if you chose to authenticate a signer with Q&A or SMS, the signer will be redirected to the following pages:

CaptureCapture

With Knowledge Based Authentication, the signer's identity is verified by asking them a series of questions about their personal credit report.

kba

To download the full code sample see our Code Share site.

To add an extra layer of security to your online transactions, OneSpan Sign offers robust and flexible recipient-authentication options. Specifically, you can select various ways of validating the identity of the recipient of an invitation to a transaction before they are permitted to access the transaction's documents.

General Authentication refers to tools built into OneSpan Sign that enable you to verify the identity of the recipient through SMS, Email, or a custom Question and Answer format.

Knowledge-Based Authentication Knowledge Based Authentication (KBA) allows you to present challenge questions to your recipient. If the recipient provides the correct answers, they are verified as the correct recipient of the transaction. (KBA) relies on a third-party KBA provider to perform the authentication. That provider is either Equifax US or Equifax Canada.

KBA questions are generated dynamically, based on information in a signer's personal credit report.

KBA authentication can be used in conjunction with any one of the General authentication methods above.

To enable Knowledge-Based Authentication, please contact our Support Team.

Using General Authentication

The code below illustrates how to edit the signer block for each general authentication method. If you need a comparison with basic document-object creation, or if this is your first time creating a package with the Java SDK, see this Creating a Transaction.

 .WithSigner(SignerBuilder.NewSignerWithEmail("[email protected]")   .WithFirstName("First")   .WithLastName("Signer")   .ChallengedWithQuestions(ChallengeBuilder.FirstQuestion("What's your favorite sport?")   .Answer("golf")   .SecondQuestion("What music instrument do you play?")   .Answer("drums")))   .WithSigner(SignerBuilder.NewSignerWithEmail("[email protected]")   .WithFirstName("Second")   .WithLastName("Signer")   .WithSMSSentTo("1234567890")) 

Manually sending an SMS code

A new SMS code is generated and sent each time a signer clicks the email link. If for any reason you need to manually send a new SMS code, you can do so by using PackageService and passing the PackageId and Signer objects as parameters. The following code will do this:

 eslClient.PackageService.SendSmsToSigner(packageId, retrievedPackage.GetSigner(email1)); 

Using KBA

You can also authenticate a signer with KBA. You can also edit the signer block to implement KBA. The withTimeAtAddress field can be left empty. The following code will do this:

 .WithSigner(SignerBuilder.NewSignerWithEmail("[email protected]")   .WithFirstName("John")   .WithLastName("Smith")   .ChallengedWithKnowledgeBasedAuthentication(   SignerInformationForEquifaxUSABuilder.NewSignerInformationForEquifaxUSA()   .WithFirstName("John")   .WithLastName("Doe")   .WithStreetAddress("2020 Broadway Street")   .WithCity("New York")   .WithState("NY")   .WithZip("12345")   .WithSocialSecurityNumber("123456789")   .WithHomePhoneNumber("1234567890")   .WithDateOfBirth(new DateTime(2002, 2, 2))   .WithDriversLicenseNumber("1234567890")   .WithTimeAtAddress(32) 

Results

After running your code, if you chose to authenticate a signer with Q&A or SMS, the signer will be redirected to the following pages:

CaptureCapture

With Knowledge Based Authentication, the signer's identity is verified by asking them a series of questions about their personal credit report.

kba

To download the full code sample see our Code Share site.

To add an extra layer of security to your online transactions, OneSpan Sign offers robust and flexible recipient-authentication options. Specifically, you can select various ways of validating the identity of the recipient of an invitation to a transaction before they are permitted to access the transaction's documents.

General Authentication refers to tools built into OneSpan Sign that enable you to verify the identity of the recipient through SMS, Email, or a custom Question and Answer format.

Knowledge-Based Authentication Knowledge Based Authentication (KBA) allows you to present challenge questions to your recipient. If the recipient provides the correct answers, they are verified as the correct recipient of the transaction. (KBA) relies on a third-party KBA provider to perform the authentication. That provider is either Equifax US or Equifax Canada.

KBA questions are generated dynamically, based on information in a signer's personal credit report.

KBA authentication can be used in conjunction with any one of the General authentication methods above.

To enable Knowledge-Based Authentication, please contact our Support Team.

Using General Authentication

The code below illustrates how to edit the auth object for each authentication method. If you need a comparison with basic document-object creation, or if this is your first time creating a package with the Java SDK, see this Creating a Transaction.

HTTP Request

POST /api/packages

HTTP Headers

Accept: application/json
Content-Type: application/jsonAuthorization: 
Basic api_key

Request Payload

 {   "roles": [   {   "type": "SIGNER",   "index": 0,   "signers": [   {   "auth": {   "scheme": "CHALLENGE",   "challenges": [   {   "answer": "golf",   "question": "What's your favorite sport?",   "maskInput": false   }   ]   },   "email": "[email protected]",   "firstName": "Patty",   "lastName": "Galant"   }   ],   "name": "Signer1"   },   {   "type": "SIGNER",   "index": 0,   "signers": [   {   "auth": {   "scheme": "SMS",   "challenges": [   {   "answer": null,   "question": "+15515584587",   "maskInput": false   }   ]   },   "email": "[email protected]",   "firstName": "John",   "lastName": "Smith"   }   ],   "name": "Signer2"   }   ],   "status": "DRAFT",   "type": "PACKAGE",   "name": "Signer Authentication Example"   } 

For a complete description of each field, see the Request Payload section below.

Response Payload

 {   "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="   } 

Manually sending an SMS code

A new SMS code is generated and sent each time a signer clicks the email link. If for any reason you need to manually send a new SMS code, the following code will do this:

HTTP Request

POST /api/packages/{packageId}/roles/{roleId}/sms_notification

HTTP Headers

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Using KBA

You can also authenticate a signer with KBA. The sample JSON string below shows you how to edit the signer's object with KBA. The withTimeAtAddress field can be left empty. The following code will do this:

 {   "signers":[   {   "delivery":{   "email":false   },   "email":"[email protected]",   "firstName":"John",   "lastName":"Doe",   "auth":{   "scheme":"NONE",   "challenges":[   ]   },   "knowledgeBasedAuthentication":{   "signerInformationForEquifaxUSA":{   "firstName":"John",   "lastName":"Doe",   "streetAddress":"2020 Broadway Street",   "city":"New York",   "zip":"12345",   "state":"NY",   "timeAtAddress":5,   "driversLicenseNumber":"1234567890",   "dateOfBirth":"1969-12-09T00:00:00Z",   "socialSecurityNumber":"123456789",   "homePhoneNumber":"1234567890"   }   }   }   ],   "reassign":false,   "emailMessage":{   "content":""   },   "attachmentRequirements":[   ]   } 

Results

After executing your code, if you chose to authenticate a signer with Q&A or SMS, the signer will be redirected to the following pages:

CaptureCapture

With Knowledge Based Authentication, the signer's identity is verified by asking them a series of questions about their personal credit report.

kba

Request Payload Table

PropertyTypeEditableRequiredDefaultSample Values
statusstringYesNoDRAFTDRAFT / SENT / COMPLETED / ARCHIVED / DECLINED / OPTED_OUT / EXPIRED
typestringYesNoPACKAGEPACKAGE / TEMPLATE / LAYOUT
namestringYesNon/aSigner Authentication Example
roles
typestringYesNoSIGNERSIGNER / SENDER
indexindexYesNo00 / 1 / 2 ...
namestringYesNon/aSigner1
signers
emailstringYesNon/a[email protected]
firstNamestringYesNon/aPatty
lastNamestringYesNon/aGalant
auth
schemestringYesNon/aCHALLENGE / SMS
challenges
answerstringYesNon/agolf
questionstringYesNon/aWhat's your favorite sport?

/ +15515584587
maskInputbooleanYesNofalsetrue / false

To download the full code sample see our Code Share site.

To add an extra layer of security to your online transactions, OneSpan Sign offers robust and flexible recipient-authentication options. Specifically, you can select various ways of validating the identity of the recipient of an invitation to a transaction before they are permitted to access the transaction's documents.

General Authentication refers to tools built into OneSpan Sign that enable you to verify the identity of the recipient through SMS, Email, or a custom Question and Answer format.

Knowledge-Based Authentication Knowledge Based Authentication (KBA) allows you to present challenge questions to your recipient. If the recipient provides the correct answers, they are verified as the correct recipient of the transaction. (KBA) relies on a third-party KBA provider to perform the authentication. That provider is either Equifax US or Equifax Canada.

KBA questions are generated dynamically, based on information in a signer's personal credit report.

KBA authentication can be used in conjunction with any one of the General authentication methods above.

To enable Knowledge-Based Authentication, please contact our Support Team.

Using General Authentication

The code below shows you how to create a Role Object for each signer authentication method. If you need a comparison with basic document-object creation, or if this is your first time creating a package with the Apex SDK, see this guide.

 ESignLiveAPIObjects.Role role = new ESignLiveAPIObjects.Role(); 
 ESignLiveAPIObjects.AuthChallenge firstChallenge = new ESignLiveAPIObjects.AuthChallenge(firstQuestionAnswer, false, firstQuestion);     //Question & Answer     ESignLiveAPIObjects.AuthChallenge secondChallenge = new ESignLiveAPIObjects.AuthChallenge(secondQuestionAnswer, false, secondQuestion);     //Question & Answer     ESignLiveAPIObjects.AuthChallenge smsAuthentication = new ESignLiveAPIObjects.AuthChallenge(null, false, phoneNumber);     //SMS   

Manually sending an SMS code

A new SMS code is generated and sent each time a signer clicks the email link. If for any reason you need to manually send a new SMS code, you can do so using the following function encapsulated in the Code Share:

 public void sendSmsToSigner(String packageId, String roleId) 

Using KBA

You can also authenticate a signer with KBA. You can use the two encapsulated functions below to create a role, and add it to an existing transaction. The two functions are used separately for Equifax USA and Equifax CA:

 public void createRoleWithKBA_EquifaxUSA(String packageId, String roleId, String firstName, String lastName, String email, String streetAddress, String city, String zip, String state, Integer timeAtAddress, String driversLicenseNumber, String dateOfBirth, String socialSecurityNumber, String homePhoneNumber)   public void createRoleWithKBA_EquifaxCA(String packageId, String roleId, String firstName, String lastName, String email, String streetAddress, String city, String zip, String state, Integer timeAtAddress, String driversLicenseNumber, String dateOfBirth, String socialSecurityNumber, String homePhoneNumber) 

Results

After running your code, if you chose to authenticate a signer with Q&A or SMS, the signer will be redirected to the following pages:

CaptureCapture

With Knowledge Based Authentication, the signer's identity is verified by asking them a series of questions about their personal credit report.

kba