Class IdentityVerificationsBankApi
- java.lang.Object
-
- app.cybrid.cybrid_api_bank.client.api.IdentityVerificationsBankApi
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-07-12T18:29:26.488549Z[Etc/UTC]") public class IdentityVerificationsBankApi extends Object
-
-
Constructor Summary
Constructors Constructor Description IdentityVerificationsBankApi()IdentityVerificationsBankApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods 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)ApiClientgetApiClient()reactor.core.publisher.Mono<IdentityVerificationWithDetailsBankModel>getIdentityVerification(String identityVerificationGuid)Get Identity Verification Retrieves an identity verification.reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<IdentityVerificationWithDetailsBankModel>>getIdentityVerificationWithHttpInfo(String identityVerificationGuid)reactor.core.publisher.Mono<IdentityVerificationListBankModel>listIdentityVerifications(BigInteger page, BigInteger perPage, String guid, String bankGuid, String customerGuid)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)voidsetApiClient(ApiClient apiClient)
-
-
-
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 | 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) 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.- 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) 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) 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.- 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) throws org.springframework.web.reactive.function.client.WebClientResponseException
- Throws:
org.springframework.web.reactive.function.client.WebClientResponseException
-
-