Package com.stripe.model.identity

Class BlocklistEntry

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.identity.BlocklistEntry

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class BlocklistEntry
extends ApiResource
implements HasId

A BlocklistEntry represents an entry in our identity verification blocklist. It helps prevent fraudulent users from repeatedly attempting verification with similar information. When you create a BlocklistEntry, we store data from a specified VerificationReport, such as document details or facial biometrics. This allows us to compare future verification attempts against these entries. If a match is found, we categorize the new verification as unverified.

To learn more, see Identity Verification Blocklist

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
BlocklistEntry()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static BlocklistEntry	create(BlocklistEntryCreateParams params)	Creates a BlocklistEntry object from a verification report.
static BlocklistEntry	create(BlocklistEntryCreateParams params, RequestOptions options)	Creates a BlocklistEntry object from a verification report.
static BlocklistEntry	create(Map<String,Object> params)	Creates a BlocklistEntry object from a verification report.
static BlocklistEntry	create(Map<String,Object> params, RequestOptions options)	Creates a BlocklistEntry object from a verification report.
BlocklistEntry	disable()	Disables a BlocklistEntry object.
BlocklistEntry	disable(RequestOptions options)	Disables a BlocklistEntry object.
BlocklistEntry	disable(BlocklistEntryDisableParams params)	Disables a BlocklistEntry object.
BlocklistEntry	disable(BlocklistEntryDisableParams params, RequestOptions options)	Disables a BlocklistEntry object.
BlocklistEntry	disable(Map<String,Object> params)	Disables a BlocklistEntry object.
BlocklistEntry	disable(Map<String,Object> params, RequestOptions options)	Disables a BlocklistEntry object.
boolean	equals(Object o)
Long	getCreated()	Time at which the object was created.
Long	getDisabledAt()	Time at which you disabled the BlocklistEntry.
Long	getExpiresAt()	Time at which the BlocklistEntry expires.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
String	getStatus()	The current status of the BlocklistEntry.
String	getType()	The type of BlocklistEntry.
String	getVerificationReport()	Get ID of expandable verificationReport object.
VerificationReport	getVerificationReportObject()	Get expanded verificationReport.
String	getVerificationSession()	Get ID of expandable verificationSession object.
VerificationSession	getVerificationSessionObject()	Get expanded verificationSession.
int	hashCode()
static BlocklistEntryCollection	list(BlocklistEntryListParams params)	Returns a list of BlocklistEntry objects associated with your account.
static BlocklistEntryCollection	list(BlocklistEntryListParams params, RequestOptions options)	Returns a list of BlocklistEntry objects associated with your account.
static BlocklistEntryCollection	list(Map<String,Object> params)	Returns a list of BlocklistEntry objects associated with your account.
static BlocklistEntryCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of BlocklistEntry objects associated with your account.
static BlocklistEntry	retrieve(String id)	Retrieves a BlocklistEntry object by its identifier.
static BlocklistEntry	retrieve(String id, RequestOptions options)	Retrieves a BlocklistEntry object by its identifier.
static BlocklistEntry	retrieve(String id, BlocklistEntryRetrieveParams params, RequestOptions options)	Retrieves a BlocklistEntry object by its identifier.
static BlocklistEntry	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a BlocklistEntry object by its identifier.
void	setCreated(Long created)	Time at which the object was created.
void	setDisabledAt(Long disabledAt)	Time at which you disabled the BlocklistEntry.
void	setExpiresAt(Long expiresAt)	Time at which the BlocklistEntry expires.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setStatus(String status)	The current status of the BlocklistEntry.
void	setType(String type)	The type of BlocklistEntry.
void	setVerificationReport(String id)
void	setVerificationReportObject(VerificationReport expandableObject)
void	setVerificationSession(String id)
void	setVerificationSessionObject(VerificationSession expandableObject)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

BlocklistEntry

public BlocklistEntry()

Method Details

getVerificationReport

public String getVerificationReport()

Get ID of expandable verificationReport object.

setVerificationReport

public void setVerificationReport(String id)

getVerificationReportObject

public VerificationReport getVerificationReportObject()

Get expanded verificationReport.

setVerificationReportObject

public void setVerificationReportObject(VerificationReport expandableObject)

getVerificationSession

public String getVerificationSession()

Get ID of expandable verificationSession object.

setVerificationSession

public void setVerificationSession(String id)

getVerificationSessionObject

public VerificationSession getVerificationSessionObject()

Get expanded verificationSession.

setVerificationSessionObject

public void setVerificationSessionObject(VerificationSession expandableObject)

create

public static BlocklistEntry create(Map<String,Object> params)
                             throws StripeException

Creates a BlocklistEntry object from a verification report.

A blocklist entry prevents future identity verifications that match the same identity information. You can create blocklist entries from verification reports that contain document extracted data or a selfie.

Related guide: Identity Verification Blocklist

Throws:

StripeException

create

public static BlocklistEntry create(Map<String,Object> params,
 RequestOptions options)
                             throws StripeException

Creates a BlocklistEntry object from a verification report.

A blocklist entry prevents future identity verifications that match the same identity information. You can create blocklist entries from verification reports that contain document extracted data or a selfie.

Related guide: Identity Verification Blocklist

Throws:

StripeException

create

public static BlocklistEntry create(BlocklistEntryCreateParams params)
                             throws StripeException

Creates a BlocklistEntry object from a verification report.

A blocklist entry prevents future identity verifications that match the same identity information. You can create blocklist entries from verification reports that contain document extracted data or a selfie.

Related guide: Identity Verification Blocklist

Throws:

StripeException

create

public static BlocklistEntry create(BlocklistEntryCreateParams params,
 RequestOptions options)
                             throws StripeException

Creates a BlocklistEntry object from a verification report.

A blocklist entry prevents future identity verifications that match the same identity information. You can create blocklist entries from verification reports that contain document extracted data or a selfie.

Related guide: Identity Verification Blocklist

Throws:

StripeException

disable

public BlocklistEntry disable()
                       throws StripeException

Disables a BlocklistEntry object.

After a BlocklistEntry is disabled, it will no longer block future verifications that match the same information. This action is irreversible. To re-enable it, a new BlocklistEntry must be created using the same verification report.

Related guide: Identity Verification Blocklist

Throws:

StripeException

disable

public BlocklistEntry disable(RequestOptions options)
                       throws StripeException

Disables a BlocklistEntry object.

After a BlocklistEntry is disabled, it will no longer block future verifications that match the same information. This action is irreversible. To re-enable it, a new BlocklistEntry must be created using the same verification report.

Related guide: Identity Verification Blocklist

Throws:

StripeException

disable

public BlocklistEntry disable(Map<String,Object> params)
                       throws StripeException

Disables a BlocklistEntry object.

After a BlocklistEntry is disabled, it will no longer block future verifications that match the same information. This action is irreversible. To re-enable it, a new BlocklistEntry must be created using the same verification report.

Related guide: Identity Verification Blocklist

Throws:

StripeException

disable

public BlocklistEntry disable(Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

Disables a BlocklistEntry object.

After a BlocklistEntry is disabled, it will no longer block future verifications that match the same information. This action is irreversible. To re-enable it, a new BlocklistEntry must be created using the same verification report.

Related guide: Identity Verification Blocklist

Throws:

StripeException

disable

public BlocklistEntry disable(BlocklistEntryDisableParams params)
                       throws StripeException

Disables a BlocklistEntry object.

After a BlocklistEntry is disabled, it will no longer block future verifications that match the same information. This action is irreversible. To re-enable it, a new BlocklistEntry must be created using the same verification report.

Related guide: Identity Verification Blocklist

Throws:

StripeException

disable

public BlocklistEntry disable(BlocklistEntryDisableParams params,
 RequestOptions options)
                       throws StripeException

Disables a BlocklistEntry object.

After a BlocklistEntry is disabled, it will no longer block future verifications that match the same information. This action is irreversible. To re-enable it, a new BlocklistEntry must be created using the same verification report.

Related guide: Identity Verification Blocklist

Throws:

StripeException

list

public static BlocklistEntryCollection list(Map<String,Object> params)
                                     throws StripeException

Returns a list of BlocklistEntry objects associated with your account.

The blocklist entries are returned sorted by creation date, with the most recently created entries appearing first.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

list

public static BlocklistEntryCollection list(Map<String,Object> params,
 RequestOptions options)
                                     throws StripeException

Returns a list of BlocklistEntry objects associated with your account.

The blocklist entries are returned sorted by creation date, with the most recently created entries appearing first.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

list

public static BlocklistEntryCollection list(BlocklistEntryListParams params)
                                     throws StripeException

Returns a list of BlocklistEntry objects associated with your account.

The blocklist entries are returned sorted by creation date, with the most recently created entries appearing first.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

list

public static BlocklistEntryCollection list(BlocklistEntryListParams params,
 RequestOptions options)
                                     throws StripeException

Returns a list of BlocklistEntry objects associated with your account.

The blocklist entries are returned sorted by creation date, with the most recently created entries appearing first.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

retrieve

public static BlocklistEntry retrieve(String id)
                               throws StripeException

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

retrieve

public static BlocklistEntry retrieve(String id,
 RequestOptions options)
                               throws StripeException

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

retrieve

public static BlocklistEntry retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                               throws StripeException

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

retrieve

public static BlocklistEntry retrieve(String id,
 BlocklistEntryRetrieveParams params,
 RequestOptions options)
                               throws StripeException

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getDisabledAt

public Long getDisabledAt()

Time at which you disabled the BlocklistEntry. Measured in seconds since the Unix epoch.

getExpiresAt

public Long getExpiresAt()

Time at which the BlocklistEntry expires. Measured in seconds since the Unix epoch.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to identity.blocklist_entry.

getStatus

public String getStatus()

The current status of the BlocklistEntry.

One of active, disabled, or redacted.

getType

public String getType()

The type of BlocklistEntry.

One of document, or selfie.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setDisabledAt

public void setDisabledAt(Long disabledAt)

Time at which you disabled the BlocklistEntry. Measured in seconds since the Unix epoch.

setExpiresAt

public void setExpiresAt(Long expiresAt)

Time at which the BlocklistEntry expires. Measured in seconds since the Unix epoch.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to identity.blocklist_entry.

setStatus

public void setStatus(String status)

The current status of the BlocklistEntry.

One of active, disabled, or redacted.

setType

public void setType(String type)

The type of BlocklistEntry.

One of document, or selfie.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId