@cfxlabsinc/b2b-services
    Preparing search index...

    Read-only access to entity documents

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    dbHelper: DbHelper
    s3Bucket: string
    s3Client: S3Client

    Methods

    • Parameters

      • __namedParameters: {
            customerId: string;
            entityId: string;
            page?: number;
            pageSize?: number;
            statuses?: ("ACTIVE" | "DELETED")[];
            types?: (
                | "BANK_STATEMENT_DOCUMENT"
                | "OPERATING_LICENSE_DOCUMENT"
                | "SOURCE_OF_FUNDS_DOCUMENT"
                | "BUSINESS_REGISTRATION_DOCUMENT"
                | "ADDRESS_PROOF_DOCUMENT"
                | "FRAUD_CHECK_DOCUMENT"
                | "BANK_ACCOUNT_DETAILS"
                | "OTHER"
                | "PASSPORT"
                | "DRIVER_LICENSE"
                | "NATIONAL_ID"
                | "ID_CARD"
                | "VOTER_ID_CARD"
                | "RESIDENT_CARD"
                | "VISA_DOCUMENT"
                | "USER_SELFIE"
                | "TAX_CERTIFICATE"
                | "CHAMBER_OF_COMMERCE_CERTIFICATE"
                | "CAC_CERTIFICATE"
                | "ARTICLES_OF_INCORPORATION"
                | "AML_POLICY"
                | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
                | "DIRECTORS_REGISTRY"
                | "CORPORATE_CHART"
                | "SHAREHOLDERS_REGISTRY"
                | "BALANCE_SHEET"
                | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
                | "COMPANY_CONSTITUTION"
                | "MEMORANDUM_OF_ASSOCIATION"
                | "PARTNERSHIP_DEED"
                | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
                | "COMPANY_PROFILE"
                | "AUDITED_ACCOUNTS"
                | "ANTI_BRIBERY_POLICY"
                | "DATA_PROTECTION_POLICY"
                | "INVOICE"
                | "PEP_FORM"
            )[];
        }
        • customerId: string
        • entityId: string
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 50

        • Optionalstatuses?: ("ACTIVE" | "DELETED")[]
        • Optionaltypes?: (
              | "BANK_STATEMENT_DOCUMENT"
              | "OPERATING_LICENSE_DOCUMENT"
              | "SOURCE_OF_FUNDS_DOCUMENT"
              | "BUSINESS_REGISTRATION_DOCUMENT"
              | "ADDRESS_PROOF_DOCUMENT"
              | "FRAUD_CHECK_DOCUMENT"
              | "BANK_ACCOUNT_DETAILS"
              | "OTHER"
              | "PASSPORT"
              | "DRIVER_LICENSE"
              | "NATIONAL_ID"
              | "ID_CARD"
              | "VOTER_ID_CARD"
              | "RESIDENT_CARD"
              | "VISA_DOCUMENT"
              | "USER_SELFIE"
              | "TAX_CERTIFICATE"
              | "CHAMBER_OF_COMMERCE_CERTIFICATE"
              | "CAC_CERTIFICATE"
              | "ARTICLES_OF_INCORPORATION"
              | "AML_POLICY"
              | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
              | "DIRECTORS_REGISTRY"
              | "CORPORATE_CHART"
              | "SHAREHOLDERS_REGISTRY"
              | "BALANCE_SHEET"
              | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
              | "COMPANY_CONSTITUTION"
              | "MEMORANDUM_OF_ASSOCIATION"
              | "PARTNERSHIP_DEED"
              | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
              | "COMPANY_PROFILE"
              | "AUDITED_ACCOUNTS"
              | "ANTI_BRIBERY_POLICY"
              | "DATA_PROTECTION_POLICY"
              | "INVOICE"
              | "PEP_FORM"
          )[]

      Returns Promise<
          {
              ok: true;
              value: { hasNext: boolean; items: EntityDocument[]; total: number };
          },
      >