Package app.cybrid.cybrid_api_bank.client.api

Class IdentityVerificationsBankApi

java.lang.Object

app.cybrid.cybrid_api_bank.client.api.IdentityVerificationsBankApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-04-12T19:47:44.916654Z[Etc/UTC]")
public class IdentityVerificationsBankApi
extends Object

Constructor Summary

Constructors

Constructor	Description
IdentityVerificationsBankApi()
IdentityVerificationsBankApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<IdentityVerificationBankModel>	createIdentityVerification(PostIdentityVerificationBankModel postIdentityVerificationBankModel)	Create Identity Verification Creates an Identity Verification.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<IdentityVerificationBankModel>>	createIdentityVerificationWithHttpInfo(PostIdentityVerificationBankModel postIdentityVerificationBankModel)
ApiClient	getApiClient()
reactor.core.publisher.Mono<IdentityVerificationWithDetailsBankModel>	getIdentityVerification(String identityVerificationGuid, Boolean includePii)	Get Identity Verification Retrieves an identity verification.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<IdentityVerificationWithDetailsBankModel>>	getIdentityVerificationWithHttpInfo(String identityVerificationGuid, Boolean includePii)
reactor.core.publisher.Mono<IdentityVerificationListBankModel>	listIdentityVerifications(BigInteger page, BigInteger perPage, String guid, String bankGuid, String customerGuid, String state)	List Identity Verifications Retrieves a list of identity verifications.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<IdentityVerificationListBankModel>>	listIdentityVerificationsWithHttpInfo(BigInteger page, BigInteger perPage, String guid, String bankGuid, String customerGuid, String state)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityVerificationsBankApi

public IdentityVerificationsBankApi()

IdentityVerificationsBankApi

@Autowired
public IdentityVerificationsBankApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createIdentityVerification

public reactor.core.publisher.Mono<IdentityVerificationBankModel> createIdentityVerification(PostIdentityVerificationBankModel postIdentityVerificationBankModel)
                                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException

Create Identity Verification Creates an Identity Verification. ## Identity Verifications Identity Verifications confirm an individual's identity with for the purpose of inclusion on the platform. This know-your-customer (KYC) process is a requirement for individuals to be able to transact. At present, we offer support for Cybrid performing the verification or working with partners to accept their KYC/AML process and have it attested to in our platform. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the identity verification details in our private store | | waiting | The Platform is waiting for the customer to complete the identity verification process | | expired | The identity verification process has expired | | completed | The identity verification process has been completed | ## Outcome | State | Description | |-------|-------------| | passed | The customer has passed the identity verification process | | failed | The customer has failed the identity verification process | ## Failure Codes | Code | Description | |-------|-------------| | id_check_failure | Failure due to an issue verifying the provided ID | | id_quality_check_failure | Failure due to an issue verifying the provided ID based on the image quality | | id_barcode_check_failure | Failure due to an issue verifying the provided ID based on the barcode | | id_expiration_check_failure | Failure due to an issue verifying the provided ID based on the expiration date | | id_double_side_check_failure | Failure due to an issue verifying the provided ID based on both sides not being provided | | id_type_allowed_check_failure | Failure due to an issue verifying the provided ID based on the type provided | | id_country_allowed_check_failure | Failure due to an issue verifying the provided ID based on the issuing country | | database_check_failure | Failure due to an issue verifying the provided information against authoritative data sources | | selfie_failure | Failure due to an issue verifying the provided selfie photo | | duplicate_person_check_failure | Failure due to a customer already existing for this person | | name_check_failure | Failure due to an issue verifying the name of the person | | address_check_failure | Failure due to an issue verifying the address of the person | | dob_check_failure | Failure due to an issue verifying the date of birth of the person | | id_number_check_failure | Failure due to an issue verifying an identification number of the person | | phone_number_check_failure | Failure due to an issue verifying the phone number of the person | | email_address_check_failure | Failure due to an issue verifying the email address of the person | | plaid_failure | Failure due to an issue interacting with Plaid | | plaid_item_login_required | Failure due to the Plaid token for the account requiring re-login | | plaid_invalid_product | Failure due to the Plaid product not being supported (contact support) | | plaid_no_accounts | Failure due to the Plaid token having access to no accounts | | decision_timeout | Failure due to an issue verifying the email address of the person | | requested_failure | In sandbox, the caller requested that the process failed | | deleted_account | Failure due to the bank account having been deleted before a decision was made | Required scope: **customers:write**

201 - Identity Verification created

401 - Unauthorized - Authentication failed,

403 - Invalid scope

Parameters:

postIdentityVerificationBankModel - The postIdentityVerificationBankModel parameter

Returns:

IdentityVerificationBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

createIdentityVerificationWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<IdentityVerificationBankModel>> createIdentityVerificationWithHttpInfo(PostIdentityVerificationBankModel postIdentityVerificationBankModel)
                                                                                                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException

getIdentityVerification

public reactor.core.publisher.Mono<IdentityVerificationWithDetailsBankModel> getIdentityVerification(String identityVerificationGuid,
                                                                                                     Boolean includePii)
                                                                                              throws org.springframework.web.reactive.function.client.WebClientResponseException

Get Identity Verification Retrieves an identity verification. Required scope: **customers:read**

200 - identity verification found

401 - Unauthorized - Authentication failed,

403 - Invalid scope

404 - identity_verification not found

Parameters:

identityVerificationGuid - Identifier for the identity verification.

includePii - Include PII in the response.

Returns:

IdentityVerificationWithDetailsBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

getIdentityVerificationWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<IdentityVerificationWithDetailsBankModel>> getIdentityVerificationWithHttpInfo(String identityVerificationGuid,
                                                                                                                                                          Boolean includePii)
                                                                                                                                                   throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException

listIdentityVerifications

public reactor.core.publisher.Mono<IdentityVerificationListBankModel> listIdentityVerifications(BigInteger page,
                                                                                                BigInteger perPage,
                                                                                                String guid,
                                                                                                String bankGuid,
                                                                                                String customerGuid,
                                                                                                String state)
                                                                                         throws org.springframework.web.reactive.function.client.WebClientResponseException

List Identity Verifications Retrieves a list of identity verifications. Required scope: **customers:read**

200 - get list of identity verifications

400 - Invalid requests

401 - Unauthorized - Authentication failed,

403 - Invalid scope

Parameters:

page - The page index to retrieve.

perPage - The number of entities per page to return.

guid - Comma separated guids to list identity verifications for.

bankGuid - Comma separated bank_guids to list identity verifications for.

customerGuid - Comma separated customer_guids to list identity verifications for.

state - Comma separated states to list identity verifications for.

Returns:

IdentityVerificationListBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

listIdentityVerificationsWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<IdentityVerificationListBankModel>> listIdentityVerificationsWithHttpInfo(BigInteger page,
                                                                                                                                                     BigInteger perPage,
                                                                                                                                                     String guid,
                                                                                                                                                     String bankGuid,
                                                                                                                                                     String customerGuid,
                                                                                                                                                     String state)
                                                                                                                                              throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException