Package com.stripe.service.identity

Class BlocklistEntryService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.identity.BlocklistEntryService

public final class BlocklistEntryService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
BlocklistEntryService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
BlocklistEntry	create(BlocklistEntryCreateParams params)	Creates a BlocklistEntry object from a verification report.
BlocklistEntry	create(BlocklistEntryCreateParams params, RequestOptions options)	Creates a BlocklistEntry object from a verification report.
BlocklistEntry	disable(String id)	Disables a BlocklistEntry object.
BlocklistEntry	disable(String id, RequestOptions options)	Disables a BlocklistEntry object.
BlocklistEntry	disable(String id, BlocklistEntryDisableParams params)	Disables a BlocklistEntry object.
BlocklistEntry	disable(String id, BlocklistEntryDisableParams params, RequestOptions options)	Disables a BlocklistEntry object.
StripeCollection<BlocklistEntry>	list()	Returns a list of BlocklistEntry objects associated with your account.
StripeCollection<BlocklistEntry>	list(RequestOptions options)	Returns a list of BlocklistEntry objects associated with your account.
StripeCollection<BlocklistEntry>	list(BlocklistEntryListParams params)	Returns a list of BlocklistEntry objects associated with your account.
StripeCollection<BlocklistEntry>	list(BlocklistEntryListParams params, RequestOptions options)	Returns a list of BlocklistEntry objects associated with your account.
BlocklistEntry	retrieve(String id)	Retrieves a BlocklistEntry object by its identifier.
BlocklistEntry	retrieve(String id, RequestOptions options)	Retrieves a BlocklistEntry object by its identifier.
BlocklistEntry	retrieve(String id, BlocklistEntryRetrieveParams params)	Retrieves a BlocklistEntry object by its identifier.
BlocklistEntry	retrieve(String id, BlocklistEntryRetrieveParams params, RequestOptions options)	Retrieves a BlocklistEntry object by its identifier.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

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

Constructor Details

BlocklistEntryService

public BlocklistEntryService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<BlocklistEntry> 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 StripeCollection<BlocklistEntry> list(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 StripeCollection<BlocklistEntry> list()
                                      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 StripeCollection<BlocklistEntry> 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

create

public 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 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

retrieve

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

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

retrieve

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

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

retrieve

public BlocklistEntry retrieve(String id)
                        throws StripeException

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

retrieve

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

Retrieves a BlocklistEntry object by its identifier.

Related guide: Identity Verification Blocklist.

Throws:

StripeException

disable

public BlocklistEntry disable(String id,
 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(String id,
 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(String id)
                       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(String id,
 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