@adyen/api-library/lib/src/typings/legalEntityManagement/document.d.ts

The Adyen API Library for NodeJS enables you to work with Adyen APIs.

import { Attachment } from './attachment';
import { OwnerEntity } from './ownerEntity';
export declare class Document {
    'attachment'?: Attachment | null;
    /**
    * Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document.
    */
    'attachments'?: Array<Attachment>;
    /**
    * The creation date of the document.
    */
    'creationDate'?: Date;
    /**
    * Your description for the document.
    */
    'description': string;
    /**
    * The expiry date of the document, in YYYY-MM-DD format.
    *
    * @deprecated since Legal Entity Management API v1
    */
    'expiryDate'?: string;
    /**
    * The filename of the document.
    */
    'fileName'?: string;
    /**
    * The unique identifier of the document.
    */
    'id'?: string;
    /**
    * 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**.
    *
    * @deprecated since Legal Entity Management API v1
    */
    'issuerCountry'?: string;
    /**
    * The state or province where the document was issued (AU only).
    *
    * @deprecated since Legal Entity Management API v1
    */
    'issuerState'?: string;
    /**
    * The modification date of the document.
    */
    'modificationDate'?: Date;
    /**
    * The number in the document.
    */
    'number'?: string;
    'owner'?: OwnerEntity | null;
    /**
    * 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).
    */
    'type': Document.TypeEnum;
    static discriminator: string | undefined;
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
}
export declare namespace Document {
    enum TypeEnum {
        BankStatement = "bankStatement",
        DriversLicense = "driversLicense",
        IdentityCard = "identityCard",
        NationalIdNumber = "nationalIdNumber",
        Passport = "passport",
        ProofOfAddress = "proofOfAddress",
        ProofOfNationalIdNumber = "proofOfNationalIdNumber",
        ProofOfResidency = "proofOfResidency",
        RegistrationDocument = "registrationDocument",
        VatDocument = "vatDocument",
        ProofOfOrganizationTaxInfo = "proofOfOrganizationTaxInfo",
        ProofOfIndividualTaxId = "proofOfIndividualTaxId",
        ProofOfOwnership = "proofOfOwnership",
        ProofOfSignatory = "proofOfSignatory",
        LiveSelfie = "liveSelfie",
        ProofOfIndustry = "proofOfIndustry",
        ConstitutionalDocument = "constitutionalDocument",
        ProofOfFundingOrWealthSource = "proofOfFundingOrWealthSource",
        ProofOfRelationship = "proofOfRelationship"
    }
}