Package com.yoti.api.client

Class Anchor

java.lang.Object

com.yoti.api.client.Anchor

public class Anchor
extends Object

Anchors represent where, when and how, a profile Attribute value was acquired or verified. For example, Attributes sourced from a backing document such as a Passport will have a signed, timestamped anchor identifying that source

Constructor Summary

Constructors

Constructor	Description
Anchor(String type, String subType, String value, List<X509Certificate> originCertificates, SignedTimestamp signedTimestamp)

Method Summary

Modifier and Type	Method	Description
List<X509Certificate>	getOriginCertificates()	Certificate chain generated when this Anchor was created (attribute value was sourced or verified).
SignedTimestamp	getSignedTimestamp()	Timestamp applied at the time of Anchor creation.
String	getSubType()	Identifies the provider that either sourced or verified the attribute value.
String	getType()	The type of Anchor - most likely "SOURCE" or "VERIFIER" but it's possible that new Anchor types will be added in future
String	getValue()	For SOURCE Anchors, describes how the attribute value was obtained, among the possible options are: ['USER_PROVIDED', 'PASSPORT', 'DRIVING_LICENSE', 'PASSCARD', 'NATIONAL_ID'] For VERIFIER Anchors, describes the verification method used for the attribute, among the possible options are: ['YOTI_ADMIN', 'YOTI_IDENTITY', 'YOTI_OTP', 'PASSPORT_NFC_SIGNATURE', 'ISSUING_AUTHORITY', 'ISSUING_AUTHORITY_PKI']

Methods inherited from class java.lang.Object

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

Constructor Details

Anchor

public Anchor(String type,
 String subType,
 String value,
 List<X509Certificate> originCertificates,
 SignedTimestamp signedTimestamp)

Method Details

getType

public String getType()

The type of Anchor - most likely "SOURCE" or "VERIFIER" but it's possible that new Anchor types will be added in future

Returns:

String, naming the type of the anchor

getSubType

public String getSubType()

Identifies the provider that either sourced or verified the attribute value. The range of possible values is not limited. For example, for a passport, this would either be "NFC" or "OCR"

Returns:

String, further detailing how the attribute value was obtained

getValue

public String getValue()

 For SOURCE Anchors, describes how the attribute value was obtained, among the possible options are: ['USER_PROVIDED', 'PASSPORT', 'DRIVING_LICENSE', 'PASSCARD', 'NATIONAL_ID']

 For VERIFIER Anchors, describes the verification method used for the attribute, among the possible options are: ['YOTI_ADMIN', 'YOTI_IDENTITY', 'YOTI_OTP', 'PASSPORT_NFC_SIGNATURE', 'ISSUING_AUTHORITY', 'ISSUING_AUTHORITY_PKI']
 

Returns:

String, naming the entity that anchored the attribute

getOriginCertificates

public List<X509Certificate> getOriginCertificates()

Certificate chain generated when this Anchor was created (attribute value was sourced or verified). Securely encodes the Anchor type and value.

Returns:

Certificate chain encoding the anchor data

getSignedTimestamp

public SignedTimestamp getSignedTimestamp()

Timestamp applied at the time of Anchor creation.

Returns:

SignedTimestamp representing the time of anchor creation