Package com.yoti.api.client.docs.session.instructions

Class Instructions

java.lang.Object

com.yoti.api.client.docs.session.instructions.Instructions

public class Instructions
extends Object

Configures the instructions in order to be able to complete In-Branch Verification.

In order to provide the end-user with the instructions to complete an In-Branch Verification session, you can supply the information necessary using the Instructions payload.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Instructions.Builder

Method Summary

Modifier and Type	Method	Description
static Instructions.Builder	builder()
Branch	getBranch()	The branch that has been selected to perform the In-Branch Verification
ContactProfile	getContactProfile()	The contact profile that will be used for any communication with the end-user
List<DocumentProposal>	getDocuments()	A list of document proposals that will satisfy the sessions requirements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static Instructions.Builder builder()

getContactProfile

public ContactProfile getContactProfile()

The contact profile that will be used for any communication with the end-user

Returns:

the contact profile

getDocuments

public List<DocumentProposal> getDocuments()

A list of document proposals that will satisfy the sessions requirements.

Returns:

the document proposals

getBranch

public Branch getBranch()

The branch that has been selected to perform the In-Branch Verification

Returns:

the branch