Package com.adyen.model.legalentitymanagement

Class Document

  • public class Document
extends Object
    Document

    • Method Detail

      • attachment

        public Document attachment​(Attachment attachment)
        attachment
        Parameters:
        attachment -
        Returns:
        the current Document instance, allowing for method chaining

      • getAttachment

        public Attachment getAttachment()
        Get attachment
        Returns:
        attachment

      • setAttachment

        public void setAttachment​(Attachment attachment)
        attachment
        Parameters:
        attachment -

      • attachments

        public Document attachments​(List<Attachment> attachments)
        Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.
        Parameters:
        attachments - Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.
        Returns:
        the current Document instance, allowing for method chaining

      • getAttachments

        public List<Attachment> getAttachments()
        Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.
        Returns:
        attachments Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.

      • setAttachments

        public void setAttachments​(List<Attachment> attachments)
        Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.
        Parameters:
        attachments - Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.

      • getCreationDate

        public OffsetDateTime getCreationDate()
        The creation date of the document.
        Returns:
        creationDate The creation date of the document.

      • description

        public Document description​(String description)
        Your description for the document.
        Parameters:
        description - Your description for the document.
        Returns:
        the current Document instance, allowing for method chaining

      • getDescription

        public String getDescription()
        Your description for the document.
        Returns:
        description Your description for the document.

      • setDescription

        public void setDescription​(String description)
        Your description for the document.
        Parameters:
        description - Your description for the document.

      • expiryDate

        @Deprecated
public Document expiryDate​(String expiryDate)
        Deprecated.
        since Legal Entity Management API v1
        The expiry date of the document, in YYYY-MM-DD format.
        Parameters:
        expiryDate - The expiry date of the document, in YYYY-MM-DD format.
        Returns:
        the current Document instance, allowing for method chaining

      • getExpiryDate

        @Deprecated
public String getExpiryDate()
        Deprecated.
        // deprecated since Legal Entity Management API v1
        The expiry date of the document, in YYYY-MM-DD format.
        Returns:
        expiryDate The expiry date of the document, in YYYY-MM-DD format.

      • setExpiryDate

        @Deprecated
public void setExpiryDate​(String expiryDate)
        Deprecated.
        since Legal Entity Management API v1
        The expiry date of the document, in YYYY-MM-DD format.
        Parameters:
        expiryDate - The expiry date of the document, in YYYY-MM-DD format.

      • fileName

        public Document fileName​(String fileName)
        The filename of the document.
        Parameters:
        fileName - The filename of the document.
        Returns:
        the current Document instance, allowing for method chaining

      • getFileName

        public String getFileName()
        The filename of the document.
        Returns:
        fileName The filename of the document.

      • setFileName

        public void setFileName​(String fileName)
        The filename of the document.
        Parameters:
        fileName - The filename of the document.

      • getId

        public String getId()
        The unique identifier of the document.
        Returns:
        id The unique identifier of the document.

      • issuerCountry

        @Deprecated
public Document 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 - 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:
        the current Document instance, allowing for method chaining

      • getIssuerCountry

        @Deprecated
public String getIssuerCountry()
        Deprecated.
        // 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 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**.

      • 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 - 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**.

      • issuerState

        @Deprecated
public Document issuerState​(String issuerState)
        Deprecated.
        since Legal Entity Management API v1
        The state or province where the document was issued (AU only).
        Parameters:
        issuerState - The state or province where the document was issued (AU only).
        Returns:
        the current Document instance, allowing for method chaining

      • getIssuerState

        @Deprecated
public String getIssuerState()
        Deprecated.
        // deprecated since Legal Entity Management API v1
        The state or province where the document was issued (AU only).
        Returns:
        issuerState The state or province where the document was issued (AU only).

      • setIssuerState

        @Deprecated
public void setIssuerState​(String issuerState)
        Deprecated.
        since Legal Entity Management API v1
        The state or province where the document was issued (AU only).
        Parameters:
        issuerState - The state or province where the document was issued (AU only).

      • getModificationDate

        public OffsetDateTime getModificationDate()
        The modification date of the document.
        Returns:
        modificationDate The modification date of the document.

      • number

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

      • getNumber

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

      • setNumber

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

      • owner

        public Document owner​(OwnerEntity owner)
        owner
        Parameters:
        owner -
        Returns:
        the current Document instance, allowing for method chaining

      • getOwner

        public OwnerEntity getOwner()
        Get owner
        Returns:
        owner

      • setOwner

        public void setOwner​(OwnerEntity owner)
        owner
        Parameters:
        owner -

      • type

        public Document type​(Document.TypeEnum type)
        Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** or **proofOfRelationship**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value is **constitutionalDocument**. * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).
        Parameters:
        type - Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** or **proofOfRelationship**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value is **constitutionalDocument**. * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).
        Returns:
        the current Document instance, allowing for method chaining

      • getType

        public Document.TypeEnum getType()
        Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** or **proofOfRelationship**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value is **constitutionalDocument**. * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).
        Returns:
        type Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** or **proofOfRelationship**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value is **constitutionalDocument**. * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).

      • setType

        public void setType​(Document.TypeEnum type)
        Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** or **proofOfRelationship**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value is **constitutionalDocument**. * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).
        Parameters:
        type - Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** or **proofOfRelationship**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * For **trust**, the `type` value is **constitutionalDocument**. * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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