Package com.adyen.model.legalentitymanagement

Class IdentificationData

  • public class IdentificationData
extends Object
    IdentificationData

    • Constructor Detail

      • IdentificationData

        public IdentificationData()

    • Method Detail

      • cardNumber

        public IdentificationData cardNumber​(String cardNumber)
        The card number of the document that was issued (AU only).
        Parameters:
        cardNumber -
        Returns:
        the current IdentificationData instance, allowing for method chaining

      • getCardNumber

        public String getCardNumber()
        The card number of the document that was issued (AU only).
        Returns:
        cardNumber

      • setCardNumber

        public void setCardNumber​(String cardNumber)
        The card number of the document that was issued (AU only).
        Parameters:
        cardNumber -

      • expiryDate

        public IdentificationData expiryDate​(String expiryDate)
        The expiry date of the document, in YYYY-MM-DD format.
        Parameters:
        expiryDate -
        Returns:
        the current IdentificationData instance, allowing for method chaining

      • getExpiryDate

        public String getExpiryDate()
        The expiry date of the document, in YYYY-MM-DD format.
        Returns:
        expiryDate

      • setExpiryDate

        public void setExpiryDate​(String expiryDate)
        The expiry date of the document, in YYYY-MM-DD format.
        Parameters:
        expiryDate -

      • issuerCountry

        @Deprecated
public IdentificationData issuerCountry​(String issuerCountry)
        Deprecated.
        since Legal Entity Management API v1
        The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.
        Parameters:
        issuerCountry -
        Returns:
        the current IdentificationData instance, allowing for method chaining

      • getIssuerCountry

        @Deprecated
public String getIssuerCountry()
        Deprecated.
        since Legal Entity Management API v1
        The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.
        Returns:
        issuerCountry

      • setIssuerCountry

        @Deprecated
public void setIssuerCountry​(String issuerCountry)
        Deprecated.
        since Legal Entity Management API v1
        The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.
        Parameters:
        issuerCountry -

      • issuerState

        public IdentificationData issuerState​(String issuerState)
        The state or province where the document was issued (AU only).
        Parameters:
        issuerState -
        Returns:
        the current IdentificationData instance, allowing for method chaining

      • getIssuerState

        public String getIssuerState()
        The state or province where the document was issued (AU only).
        Returns:
        issuerState

      • setIssuerState

        public void setIssuerState​(String issuerState)
        The state or province where the document was issued (AU only).
        Parameters:
        issuerState -

      • nationalIdExempt

        public IdentificationData nationalIdExempt​(Boolean nationalIdExempt)
        Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.
        Parameters:
        nationalIdExempt -
        Returns:
        the current IdentificationData instance, allowing for method chaining

      • getNationalIdExempt

        public Boolean getNationalIdExempt()
        Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.
        Returns:
        nationalIdExempt

      • setNationalIdExempt

        public void setNationalIdExempt​(Boolean nationalIdExempt)
        Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.
        Parameters:
        nationalIdExempt -

      • number

        public IdentificationData number​(String number)
        The number in the document.
        Parameters:
        number -
        Returns:
        the current IdentificationData instance, allowing for method chaining

      • getNumber

        public String getNumber()
        The number in the document.
        Returns:
        number

      • setNumber

        public void setNumber​(String number)
        The number in the document.
        Parameters:
        number -

      • type

        public IdentificationData type​(IdentificationData.TypeEnum type)
        Type of identity data. For individuals, the following types are supported. See our [onboarding guide](https://docs.adyen.com/platforms/onboard-users/onboarding-steps/?onboarding_type=custom) for other supported countries. - Australia: **driversLicense**, **passport** - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport** - New Zealand: **driversLicense**, **passport** - Singapore: **driversLicense**, **nationalIdNumber**, **passport** - All other supported countries: **nationalIdNumber**
        Parameters:
        type -
        Returns:
        the current IdentificationData instance, allowing for method chaining

      • getType

        public IdentificationData.TypeEnum getType()
        Type of identity data. For individuals, the following types are supported. See our [onboarding guide](https://docs.adyen.com/platforms/onboard-users/onboarding-steps/?onboarding_type=custom) for other supported countries. - Australia: **driversLicense**, **passport** - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport** - New Zealand: **driversLicense**, **passport** - Singapore: **driversLicense**, **nationalIdNumber**, **passport** - All other supported countries: **nationalIdNumber**
        Returns:
        type

      • setType

        public void setType​(IdentificationData.TypeEnum type)
        Type of identity data. For individuals, the following types are supported. See our [onboarding guide](https://docs.adyen.com/platforms/onboard-users/onboarding-steps/?onboarding_type=custom) for other supported countries. - Australia: **driversLicense**, **passport** - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport** - New Zealand: **driversLicense**, **passport** - Singapore: **driversLicense**, **nationalIdNumber**, **passport** - All other supported countries: **nationalIdNumber**
        Parameters:
        type -

      • equals

        public boolean equals​(Object o)
        Return true if this IdentificationData object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static IdentificationData fromJson​(String jsonString)
                                   throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of IdentificationData given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of IdentificationData
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to IdentificationData

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of IdentificationData to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException