Class PostIdentityVerificationBankModel
- java.lang.Object
-
- app.cybrid.cybrid_api_bank.client.model.PostIdentityVerificationBankModel
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-06-30T15:22:52.716328Z[Etc/UTC]") public class PostIdentityVerificationBankModel extends Object
Request body for identity verification creation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPostIdentityVerificationBankModel.ExpectedBehavioursEnumGets or Sets expectedBehavioursstatic classPostIdentityVerificationBankModel.MethodEnumThe identity verification method.static classPostIdentityVerificationBankModel.TypeEnumThe type of identity verification.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ADDRESSstatic StringJSON_PROPERTY_ALIASESstatic StringJSON_PROPERTY_COUNTERPARTY_GUIDstatic StringJSON_PROPERTY_COUNTRY_CODEstatic StringJSON_PROPERTY_CUSTOMER_GUIDstatic StringJSON_PROPERTY_DATE_OF_BIRTHstatic StringJSON_PROPERTY_DIRECTOR_CUSTOMER_GUIDSstatic StringJSON_PROPERTY_EMAIL_ADDRESSstatic StringJSON_PROPERTY_EXPECTED_BEHAVIOURSstatic StringJSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUIDstatic StringJSON_PROPERTY_IDENTIFICATION_NUMBERSstatic StringJSON_PROPERTY_METHODstatic StringJSON_PROPERTY_NAMEstatic StringJSON_PROPERTY_NATURE_OF_BUSINESSstatic StringJSON_PROPERTY_OCCUPATIONstatic StringJSON_PROPERTY_PHONE_NUMBERstatic StringJSON_PROPERTY_SUPPORTING_FILE_GUIDSstatic StringJSON_PROPERTY_TYPEstatic StringJSON_PROPERTY_ULTIMATE_BENEFICIAL_OWNERSstatic StringJSON_PROPERTY_WEBSITE
-
Constructor Summary
Constructors Constructor Description PostIdentityVerificationBankModel()
-
Method Summary
-
-
-
Field Detail
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CUSTOMER_GUID
public static final String JSON_PROPERTY_CUSTOMER_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXPECTED_BEHAVIOURS
public static final String JSON_PROPERTY_EXPECTED_BEHAVIOURS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_METHOD
public static final String JSON_PROPERTY_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COUNTERPARTY_GUID
public static final String JSON_PROPERTY_COUNTERPARTY_GUID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COUNTRY_CODE
public static final String JSON_PROPERTY_COUNTRY_CODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDRESS
public static final String JSON_PROPERTY_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DATE_OF_BIRTH
public static final String JSON_PROPERTY_DATE_OF_BIRTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IDENTIFICATION_NUMBERS
public static final String JSON_PROPERTY_IDENTIFICATION_NUMBERS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ALIASES
public static final String JSON_PROPERTY_ALIASES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PHONE_NUMBER
public static final String JSON_PROPERTY_PHONE_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EMAIL_ADDRESS
public static final String JSON_PROPERTY_EMAIL_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_WEBSITE
public static final String JSON_PROPERTY_WEBSITE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NATURE_OF_BUSINESS
public static final String JSON_PROPERTY_NATURE_OF_BUSINESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DIRECTOR_CUSTOMER_GUIDS
public static final String JSON_PROPERTY_DIRECTOR_CUSTOMER_GUIDS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ULTIMATE_BENEFICIAL_OWNERS
public static final String JSON_PROPERTY_ULTIMATE_BENEFICIAL_OWNERS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SUPPORTING_FILE_GUIDS
public static final String JSON_PROPERTY_SUPPORTING_FILE_GUIDS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_OCCUPATION
public static final String JSON_PROPERTY_OCCUPATION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUID
public static final String JSON_PROPERTY_EXTERNAL_BANK_ACCOUNT_GUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
type
public PostIdentityVerificationBankModel type(PostIdentityVerificationBankModel.TypeEnum type)
-
getType
@Nonnull public PostIdentityVerificationBankModel.TypeEnum getType()
The type of identity verification.- Returns:
- type
-
setType
public void setType(PostIdentityVerificationBankModel.TypeEnum type)
-
customerGuid
public PostIdentityVerificationBankModel customerGuid(String customerGuid)
-
getCustomerGuid
@Nullable public String getCustomerGuid()
The customer's identifier. Required when type is kyc and method is attested_business_registration or type is kyc and method is attested_id_and_selfie.- Returns:
- customerGuid
-
getCustomerGuid_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getCustomerGuid_JsonNullable()
-
setCustomerGuid_JsonNullable
public void setCustomerGuid_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> customerGuid)
-
setCustomerGuid
public void setCustomerGuid(String customerGuid)
-
expectedBehaviours
public PostIdentityVerificationBankModel expectedBehaviours(List<PostIdentityVerificationBankModel.ExpectedBehavioursEnum> expectedBehaviours)
-
addExpectedBehavioursItem
public PostIdentityVerificationBankModel addExpectedBehavioursItem(PostIdentityVerificationBankModel.ExpectedBehavioursEnum expectedBehavioursItem)
-
getExpectedBehaviours
@Nullable public List<PostIdentityVerificationBankModel.ExpectedBehavioursEnum> getExpectedBehaviours()
The optional expected behaviour to simulate.- Returns:
- expectedBehaviours
-
getExpectedBehaviours_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<PostIdentityVerificationBankModel.ExpectedBehavioursEnum>> getExpectedBehaviours_JsonNullable()
-
setExpectedBehaviours_JsonNullable
public void setExpectedBehaviours_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<PostIdentityVerificationBankModel.ExpectedBehavioursEnum>> expectedBehaviours)
-
setExpectedBehaviours
public void setExpectedBehaviours(List<PostIdentityVerificationBankModel.ExpectedBehavioursEnum> expectedBehaviours)
-
method
public PostIdentityVerificationBankModel method(PostIdentityVerificationBankModel.MethodEnum method)
-
getMethod
@Nullable public PostIdentityVerificationBankModel.MethodEnum getMethod()
The identity verification method. Required when type is counterparty, type is kyc, or type is bank_account.- Returns:
- method
-
getMethod_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<PostIdentityVerificationBankModel.MethodEnum> getMethod_JsonNullable()
-
setMethod_JsonNullable
public void setMethod_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<PostIdentityVerificationBankModel.MethodEnum> method)
-
setMethod
public void setMethod(PostIdentityVerificationBankModel.MethodEnum method)
-
counterpartyGuid
public PostIdentityVerificationBankModel counterpartyGuid(String counterpartyGuid)
-
getCounterpartyGuid
@Nullable public String getCounterpartyGuid()
The counterparty's identifier. Required when type is counterparty.- Returns:
- counterpartyGuid
-
getCounterpartyGuid_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getCounterpartyGuid_JsonNullable()
-
setCounterpartyGuid_JsonNullable
public void setCounterpartyGuid_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> counterpartyGuid)
-
setCounterpartyGuid
public void setCounterpartyGuid(String counterpartyGuid)
-
countryCode
public PostIdentityVerificationBankModel countryCode(String countryCode)
-
getCountryCode
@Nullable public String getCountryCode()
The ISO 3166 country 2-Alpha country the customer is being verified in. If not present, will default to the Bank's configured country code. Optional when type is kyc and method is id_and_selfie, type is kyc and method is tax_id_and_selfie, or type is kyc and method is business_registration.- Returns:
- countryCode
-
getCountryCode_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getCountryCode_JsonNullable()
-
setCountryCode_JsonNullable
public void setCountryCode_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> countryCode)
-
setCountryCode
public void setCountryCode(String countryCode)
-
name
public PostIdentityVerificationBankModel name(PostIdentityVerificationNameBankModel name)
-
getName
@Nullable public PostIdentityVerificationNameBankModel getName()
Get name- Returns:
- name
-
getName_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<PostIdentityVerificationNameBankModel> getName_JsonNullable()
-
setName_JsonNullable
public void setName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<PostIdentityVerificationNameBankModel> name)
-
setName
public void setName(PostIdentityVerificationNameBankModel name)
-
address
public PostIdentityVerificationBankModel address(PostIdentityVerificationAddressBankModel address)
-
getAddress
@Nullable public PostIdentityVerificationAddressBankModel getAddress()
Get address- Returns:
- address
-
getAddress_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<PostIdentityVerificationAddressBankModel> getAddress_JsonNullable()
-
setAddress_JsonNullable
public void setAddress_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<PostIdentityVerificationAddressBankModel> address)
-
setAddress
public void setAddress(PostIdentityVerificationAddressBankModel address)
-
dateOfBirth
public PostIdentityVerificationBankModel dateOfBirth(LocalDate dateOfBirth)
-
getDateOfBirth
@Nullable public LocalDate getDateOfBirth()
The customer's date of birth. Required when type is kyc and method is attested or type is kyc and method is attested_id_and_selfie.- Returns:
- dateOfBirth
-
getDateOfBirth_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<LocalDate> getDateOfBirth_JsonNullable()
-
setDateOfBirth_JsonNullable
public void setDateOfBirth_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<LocalDate> dateOfBirth)
-
setDateOfBirth
public void setDateOfBirth(LocalDate dateOfBirth)
-
identificationNumbers
public PostIdentityVerificationBankModel identificationNumbers(List<PostIdentificationNumberBankModel> identificationNumbers)
-
addIdentificationNumbersItem
public PostIdentityVerificationBankModel addIdentificationNumbersItem(PostIdentificationNumberBankModel identificationNumbersItem)
-
getIdentificationNumbers
@Nullable public List<PostIdentificationNumberBankModel> getIdentificationNumbers()
The customer's identification numbers. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, or type is kyc and method is attested_id_and_selfie.- Returns:
- identificationNumbers
-
getIdentificationNumbers_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<PostIdentificationNumberBankModel>> getIdentificationNumbers_JsonNullable()
-
setIdentificationNumbers_JsonNullable
public void setIdentificationNumbers_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<PostIdentificationNumberBankModel>> identificationNumbers)
-
setIdentificationNumbers
public void setIdentificationNumbers(List<PostIdentificationNumberBankModel> identificationNumbers)
-
aliases
public PostIdentityVerificationBankModel aliases(List<PostIdentityVerificationAliasesInnerBankModel> aliases)
-
addAliasesItem
public PostIdentityVerificationBankModel addAliasesItem(PostIdentityVerificationAliasesInnerBankModel aliasesItem)
-
getAliases
@Nullable public List<PostIdentityVerificationAliasesInnerBankModel> getAliases()
The aliases of the customer. Optional when type is kyc and method is attested_business_registration.- Returns:
- aliases
-
getAliases_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<PostIdentityVerificationAliasesInnerBankModel>> getAliases_JsonNullable()
-
setAliases_JsonNullable
public void setAliases_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<PostIdentityVerificationAliasesInnerBankModel>> aliases)
-
setAliases
public void setAliases(List<PostIdentityVerificationAliasesInnerBankModel> aliases)
-
phoneNumber
public PostIdentityVerificationBankModel phoneNumber(String phoneNumber)
-
getPhoneNumber
@Nullable public String getPhoneNumber()
The customer's phone number. Required when type is kyc and method is attested_business_registration or type is kyc and method is attested_id_and_selfie. Optional when type is bank_account and method is attested_ownership.- Returns:
- phoneNumber
-
getPhoneNumber_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getPhoneNumber_JsonNullable()
-
setPhoneNumber_JsonNullable
public void setPhoneNumber_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> phoneNumber)
-
setPhoneNumber
public void setPhoneNumber(String phoneNumber)
-
emailAddress
public PostIdentityVerificationBankModel emailAddress(String emailAddress)
-
getEmailAddress
@Nullable public String getEmailAddress()
The customer's email address. Required when type is kyc and method is attested_business_registration or type is kyc and method is attested_id_and_selfie. Optional when type is bank_account and method is attested_ownership.- Returns:
- emailAddress
-
getEmailAddress_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getEmailAddress_JsonNullable()
-
setEmailAddress_JsonNullable
public void setEmailAddress_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> emailAddress)
-
setEmailAddress
public void setEmailAddress(String emailAddress)
-
website
public PostIdentityVerificationBankModel website(String website)
-
getWebsite
@Nullable public String getWebsite()
The customer's website. Required when type is kyc and method is attested_business_registration.- Returns:
- website
-
getWebsite_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getWebsite_JsonNullable()
-
setWebsite_JsonNullable
public void setWebsite_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> website)
-
setWebsite
public void setWebsite(String website)
-
natureOfBusiness
public PostIdentityVerificationBankModel natureOfBusiness(String natureOfBusiness)
-
getNatureOfBusiness
@Nullable public String getNatureOfBusiness()
The customer's nature of business. Required when type is kyc and method is attested_business_registration.- Returns:
- natureOfBusiness
-
getNatureOfBusiness_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getNatureOfBusiness_JsonNullable()
-
setNatureOfBusiness_JsonNullable
public void setNatureOfBusiness_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> natureOfBusiness)
-
setNatureOfBusiness
public void setNatureOfBusiness(String natureOfBusiness)
-
directorCustomerGuids
public PostIdentityVerificationBankModel directorCustomerGuids(List<String> directorCustomerGuids)
-
addDirectorCustomerGuidsItem
public PostIdentityVerificationBankModel addDirectorCustomerGuidsItem(String directorCustomerGuidsItem)
-
getDirectorCustomerGuids
@Nullable public List<String> getDirectorCustomerGuids()
The customer guids of the directors of the business Required when type is kyc and method is attested_business_registration.- Returns:
- directorCustomerGuids
-
getDirectorCustomerGuids_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<String>> getDirectorCustomerGuids_JsonNullable()
-
setDirectorCustomerGuids_JsonNullable
public void setDirectorCustomerGuids_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> directorCustomerGuids)
-
ultimateBeneficialOwners
public PostIdentityVerificationBankModel ultimateBeneficialOwners(List<PostUltimateBeneficialOwnerBankModel> ultimateBeneficialOwners)
-
addUltimateBeneficialOwnersItem
public PostIdentityVerificationBankModel addUltimateBeneficialOwnersItem(PostUltimateBeneficialOwnerBankModel ultimateBeneficialOwnersItem)
-
getUltimateBeneficialOwners
@Nullable public List<PostUltimateBeneficialOwnerBankModel> getUltimateBeneficialOwners()
The ultimate beneficial owners of the business with 10% or more ownership Required when type is kyc and method is attested_business_registration.- Returns:
- ultimateBeneficialOwners
-
getUltimateBeneficialOwners_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<PostUltimateBeneficialOwnerBankModel>> getUltimateBeneficialOwners_JsonNullable()
-
setUltimateBeneficialOwners_JsonNullable
public void setUltimateBeneficialOwners_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<PostUltimateBeneficialOwnerBankModel>> ultimateBeneficialOwners)
-
setUltimateBeneficialOwners
public void setUltimateBeneficialOwners(List<PostUltimateBeneficialOwnerBankModel> ultimateBeneficialOwners)
-
supportingFileGuids
public PostIdentityVerificationBankModel supportingFileGuids(List<String> supportingFileGuids)
-
addSupportingFileGuidsItem
public PostIdentityVerificationBankModel addSupportingFileGuidsItem(String supportingFileGuidsItem)
-
getSupportingFileGuids
@Nullable public List<String> getSupportingFileGuids()
File guids supporting the verification Required when type is kyc and method is attested_business_registration or type is kyc and method is attested_id_and_selfie.- Returns:
- supportingFileGuids
-
getSupportingFileGuids_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<String>> getSupportingFileGuids_JsonNullable()
-
setSupportingFileGuids_JsonNullable
public void setSupportingFileGuids_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> supportingFileGuids)
-
occupation
public PostIdentityVerificationBankModel occupation(String occupation)
-
getOccupation
@Nullable public String getOccupation()
The customer's occupation. Optional when type is kyc and method is attested_id_and_selfie.- Returns:
- occupation
-
getOccupation_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getOccupation_JsonNullable()
-
setOccupation_JsonNullable
public void setOccupation_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> occupation)
-
setOccupation
public void setOccupation(String occupation)
-
externalBankAccountGuid
public PostIdentityVerificationBankModel externalBankAccountGuid(String externalBankAccountGuid)
-
getExternalBankAccountGuid
@Nullable public String getExternalBankAccountGuid()
The external bank account's identifier. Required when type is bank_account.- Returns:
- externalBankAccountGuid
-
getExternalBankAccountGuid_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getExternalBankAccountGuid_JsonNullable()
-
setExternalBankAccountGuid_JsonNullable
public void setExternalBankAccountGuid_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> externalBankAccountGuid)
-
setExternalBankAccountGuid
public void setExternalBankAccountGuid(String externalBankAccountGuid)
-
-