Class EntityDocumentService

Read-only access to entity documents

Hierarchy (View Summary)

EntityDocumentQueryService
- EntityDocumentService

Index

Constructors

constructor

new EntityDocumentService(
    __namedParameters: {
        eventPublisher: CustomerEventPublisher;
        identityQueryService: IdentityQueryService;
        organizationQueryService: OrganizationQueryService;
        relatedPersonQueryService: RelatedPersonQueryService;
        s3Bucket: string;
        s3Client: S3Client;
        s3StagingBucket: string;
        sqlClient: Pool;
        temporalClient: Client;
        temporalTaskQueue: string;
        valkeyClient: ValkeyClient | null;
    },
): EntityDocumentService
Parameters
- __namedParameters: {
      eventPublisher: CustomerEventPublisher;
      identityQueryService: IdentityQueryService;
      organizationQueryService: OrganizationQueryService;
      relatedPersonQueryService: RelatedPersonQueryService;
      s3Bucket: string;
      s3Client: S3Client;
      s3StagingBucket: string;
      sqlClient: Pool;
      temporalClient: Client;
      temporalTaskQueue: string;
      valkeyClient: ValkeyClient | null;
  }
Returns EntityDocumentService
Overrides EntityDocumentQueryService.constructor
- Defined in packages/entity-services/src/entity-document/EntityDocumentService.ts:50

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

`Protected` `Readonly`s3Bucket

s3Bucket: string

`Protected` `Readonly`s3Client

s3Client: S3Client

Methods

completeUpload

completeUpload(
    __namedParameters: {
        customerId: string;
        entityId: string;
        uploadId: string;
    },
): Promise<
    { ok: true; value: EntityDocument }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: { customerId: string; entityId: string; uploadId: string }
Returns Promise<
{ ok: true; value: EntityDocument }
| { error: ServiceError; ok: false },
>
- Defined in packages/entity-services/src/entity-document/EntityDocumentService.ts:261

delete

delete(
    __namedParameters: {
        customerId: string;
        entityId: string;
        entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON";
        id: string;
    },
): Promise<{ ok: true; value: true } | { error: ServiceError; ok: false }>
Parameters
- __namedParameters: {
      customerId: string;
      entityId: string;
      entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON";
      id: string;
  }
  - customerId: string
  - entityId: string
  - entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON"
    
    Which kind of owner entityId refers to; gates the webhook below.
  - id: string
Returns Promise<{ ok: true; value: true } | { error: ServiceError; ok: false }>
- Defined in packages/entity-services/src/entity-document/EntityDocumentService.ts:417

get

get(
__namedParameters: { customerId: string; entityId: string; id: string },
): Promise<{ ok: true; value: EntityDocument | null }>
Parameters
- __namedParameters: { customerId: string; entityId: string; id: string }
Returns Promise<{ ok: true; value: EntityDocument | null }>
Inherited from EntityDocumentQueryService.get
- Defined in packages/entity-services/src/entity-document/EntityDocumentQueryService.ts:56

getDownloadUrl

getDownloadUrl(
    __namedParameters: {
        customerId: string;
        disposition?: "attachment" | "inline";
        entityId: string;
        id: string;
    },
): Promise<{ ok: true; value: string | null }>
Parameters
- __namedParameters: {
      customerId: string;
      disposition?: "attachment" | "inline";
      entityId: string;
      id: string;
  }
  - customerId: string
  - Optionaldisposition?: "attachment" | "inline"
    
    attachment (the default) forces a download — the dashboards' download buttons depend on it, because they click a programmatic anchor and would otherwise navigate the panel away to a raw S3 URL. inline lets a browser render the bytes in place, for the document viewer.
  - entityId: string
  - id: string
Returns Promise<{ ok: true; value: string | null }>
Inherited from EntityDocumentQueryService.getDownloadUrl
- Defined in packages/entity-services/src/entity-document/EntityDocumentQueryService.ts:110

initiateUpload

initiateUpload(
    __namedParameters: {
        customerId: string;
        description?: string;
        entityId: string;
        entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON";
        fileName: string;
        fileSize: number;
        fileType: string;
        side?: "BACK" | "FRONT" | null;
        type:
            | "ADDRESS_PROOF_DOCUMENT"
            | "AML_POLICY"
            | "ANTI_BRIBERY_POLICY"
            | "ARTICLES_OF_INCORPORATION"
            | "AUDITED_ACCOUNTS"
            | "BALANCE_SHEET"
            | "BANK_ACCOUNT_DETAILS"
            | "BANK_STATEMENT_DOCUMENT"
            | "BUSINESS_REGISTRATION_DOCUMENT"
            | "CAC_CERTIFICATE"
            | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
            | "CHAMBER_OF_COMMERCE_CERTIFICATE"
            | "COMPANY_CONSTITUTION"
            | "COMPANY_PROFILE"
            | "CORPORATE_CHART"
            | "DATA_PROTECTION_POLICY"
            | "DIRECTORS_REGISTRY"
            | "DRIVER_LICENSE"
            | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
            | "FRAUD_CHECK_DOCUMENT"
            | "ID_CARD"
            | "INVOICE"
            | "MEMORANDUM_OF_ASSOCIATION"
            | "NATIONAL_ID"
            | "OPERATING_LICENSE_DOCUMENT"
            | "OTHER"
            | "PARTNERSHIP_DEED"
            | "PASSPORT"
            | "PEP_FORM"
            | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
            | "RESIDENT_CARD"
            | "SHAREHOLDERS_REGISTRY"
            | "SOURCE_OF_FUNDS_DOCUMENT"
            | "TAX_CERTIFICATE"
            | "USER_SELFIE"
            | "USER_SELFIE_VIDEO"
            | "VISA_DOCUMENT"
            | "VOTER_ID_CARD";
    },
): Promise<
    | {
        ok: true;
        value: { expiresAt: Date; uploadId: string; uploadUrl: string };
    }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: {
      customerId: string;
      description?: string;
      entityId: string;
      entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON";
      fileName: string;
      fileSize: number;
      fileType: string;
      side?: "BACK" | "FRONT" | null;
      type:
          | "ADDRESS_PROOF_DOCUMENT"
          | "AML_POLICY"
          | "ANTI_BRIBERY_POLICY"
          | "ARTICLES_OF_INCORPORATION"
          | "AUDITED_ACCOUNTS"
          | "BALANCE_SHEET"
          | "BANK_ACCOUNT_DETAILS"
          | "BANK_STATEMENT_DOCUMENT"
          | "BUSINESS_REGISTRATION_DOCUMENT"
          | "CAC_CERTIFICATE"
          | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
          | "CHAMBER_OF_COMMERCE_CERTIFICATE"
          | "COMPANY_CONSTITUTION"
          | "COMPANY_PROFILE"
          | "CORPORATE_CHART"
          | "DATA_PROTECTION_POLICY"
          | "DIRECTORS_REGISTRY"
          | "DRIVER_LICENSE"
          | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
          | "FRAUD_CHECK_DOCUMENT"
          | "ID_CARD"
          | "INVOICE"
          | "MEMORANDUM_OF_ASSOCIATION"
          | "NATIONAL_ID"
          | "OPERATING_LICENSE_DOCUMENT"
          | "OTHER"
          | "PARTNERSHIP_DEED"
          | "PASSPORT"
          | "PEP_FORM"
          | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
          | "RESIDENT_CARD"
          | "SHAREHOLDERS_REGISTRY"
          | "SOURCE_OF_FUNDS_DOCUMENT"
          | "TAX_CERTIFICATE"
          | "USER_SELFIE"
          | "USER_SELFIE_VIDEO"
          | "VISA_DOCUMENT"
          | "VOTER_ID_CARD";
  }
  - customerId: string
  - Optionaldescription?: string
  - entityId: string
  - entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON"
    
    Which kind of owner entityId refers to — the caller always knows it.
  - fileName: string
  - fileSize: number
  - fileType: string
  - Optionalside?: "BACK" | "FRONT" | null
  - type:
        | "ADDRESS_PROOF_DOCUMENT"
        | "AML_POLICY"
        | "ANTI_BRIBERY_POLICY"
        | "ARTICLES_OF_INCORPORATION"
        | "AUDITED_ACCOUNTS"
        | "BALANCE_SHEET"
        | "BANK_ACCOUNT_DETAILS"
        | "BANK_STATEMENT_DOCUMENT"
        | "BUSINESS_REGISTRATION_DOCUMENT"
        | "CAC_CERTIFICATE"
        | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
        | "CHAMBER_OF_COMMERCE_CERTIFICATE"
        | "COMPANY_CONSTITUTION"
        | "COMPANY_PROFILE"
        | "CORPORATE_CHART"
        | "DATA_PROTECTION_POLICY"
        | "DIRECTORS_REGISTRY"
        | "DRIVER_LICENSE"
        | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
        | "FRAUD_CHECK_DOCUMENT"
        | "ID_CARD"
        | "INVOICE"
        | "MEMORANDUM_OF_ASSOCIATION"
        | "NATIONAL_ID"
        | "OPERATING_LICENSE_DOCUMENT"
        | "OTHER"
        | "PARTNERSHIP_DEED"
        | "PASSPORT"
        | "PEP_FORM"
        | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
        | "RESIDENT_CARD"
        | "SHAREHOLDERS_REGISTRY"
        | "SOURCE_OF_FUNDS_DOCUMENT"
        | "TAX_CERTIFICATE"
        | "USER_SELFIE"
        | "USER_SELFIE_VIDEO"
        | "VISA_DOCUMENT"
        | "VOTER_ID_CARD"
Returns Promise<
    | {
        ok: true;
        value: { expiresAt: Date; uploadId: string; uploadUrl: string };
    }
    | { error: ServiceError; ok: false },
>
- Defined in packages/entity-services/src/entity-document/EntityDocumentService.ts:174

search

search(
    __namedParameters: {
        customerId: string;
        entityId: string;
        page?: number;
        pageSize?: number;
        statuses?: ("ACTIVE" | "DELETED")[];
        types?: (
            | "ADDRESS_PROOF_DOCUMENT"
            | "AML_POLICY"
            | "ANTI_BRIBERY_POLICY"
            | "ARTICLES_OF_INCORPORATION"
            | "AUDITED_ACCOUNTS"
            | "BALANCE_SHEET"
            | "BANK_ACCOUNT_DETAILS"
            | "BANK_STATEMENT_DOCUMENT"
            | "BUSINESS_REGISTRATION_DOCUMENT"
            | "CAC_CERTIFICATE"
            | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
            | "CHAMBER_OF_COMMERCE_CERTIFICATE"
            | "COMPANY_CONSTITUTION"
            | "COMPANY_PROFILE"
            | "CORPORATE_CHART"
            | "DATA_PROTECTION_POLICY"
            | "DIRECTORS_REGISTRY"
            | "DRIVER_LICENSE"
            | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
            | "FRAUD_CHECK_DOCUMENT"
            | "ID_CARD"
            | "INVOICE"
            | "MEMORANDUM_OF_ASSOCIATION"
            | "NATIONAL_ID"
            | "OPERATING_LICENSE_DOCUMENT"
            | "OTHER"
            | "PARTNERSHIP_DEED"
            | "PASSPORT"
            | "PEP_FORM"
            | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
            | "RESIDENT_CARD"
            | "SHAREHOLDERS_REGISTRY"
            | "SOURCE_OF_FUNDS_DOCUMENT"
            | "TAX_CERTIFICATE"
            | "USER_SELFIE"
            | "USER_SELFIE_VIDEO"
            | "VISA_DOCUMENT"
            | "VOTER_ID_CARD"
        )[];
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: EntityDocument[]; total: number };
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      entityId: string;
      page?: number;
      pageSize?: number;
      statuses?: ("ACTIVE" | "DELETED")[];
      types?: (
          | "ADDRESS_PROOF_DOCUMENT"
          | "AML_POLICY"
          | "ANTI_BRIBERY_POLICY"
          | "ARTICLES_OF_INCORPORATION"
          | "AUDITED_ACCOUNTS"
          | "BALANCE_SHEET"
          | "BANK_ACCOUNT_DETAILS"
          | "BANK_STATEMENT_DOCUMENT"
          | "BUSINESS_REGISTRATION_DOCUMENT"
          | "CAC_CERTIFICATE"
          | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
          | "CHAMBER_OF_COMMERCE_CERTIFICATE"
          | "COMPANY_CONSTITUTION"
          | "COMPANY_PROFILE"
          | "CORPORATE_CHART"
          | "DATA_PROTECTION_POLICY"
          | "DIRECTORS_REGISTRY"
          | "DRIVER_LICENSE"
          | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
          | "FRAUD_CHECK_DOCUMENT"
          | "ID_CARD"
          | "INVOICE"
          | "MEMORANDUM_OF_ASSOCIATION"
          | "NATIONAL_ID"
          | "OPERATING_LICENSE_DOCUMENT"
          | "OTHER"
          | "PARTNERSHIP_DEED"
          | "PASSPORT"
          | "PEP_FORM"
          | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
          | "RESIDENT_CARD"
          | "SHAREHOLDERS_REGISTRY"
          | "SOURCE_OF_FUNDS_DOCUMENT"
          | "TAX_CERTIFICATE"
          | "USER_SELFIE"
          | "USER_SELFIE_VIDEO"
          | "VISA_DOCUMENT"
          | "VOTER_ID_CARD"
      )[];
  }
  - customerId: string
  - entityId: string
  - Optionalpage?: number
    
    Defaults to 1
  - OptionalpageSize?: number
    
    Defaults to 50
  - Optionalstatuses?: ("ACTIVE" | "DELETED")[]
  - Optionaltypes?: (
        | "ADDRESS_PROOF_DOCUMENT"
        | "AML_POLICY"
        | "ANTI_BRIBERY_POLICY"
        | "ARTICLES_OF_INCORPORATION"
        | "AUDITED_ACCOUNTS"
        | "BALANCE_SHEET"
        | "BANK_ACCOUNT_DETAILS"
        | "BANK_STATEMENT_DOCUMENT"
        | "BUSINESS_REGISTRATION_DOCUMENT"
        | "CAC_CERTIFICATE"
        | "CERTIFIED_ANNUAL_RETURNS_STATEMENT"
        | "CHAMBER_OF_COMMERCE_CERTIFICATE"
        | "COMPANY_CONSTITUTION"
        | "COMPANY_PROFILE"
        | "CORPORATE_CHART"
        | "DATA_PROTECTION_POLICY"
        | "DIRECTORS_REGISTRY"
        | "DRIVER_LICENSE"
        | "FINANCIAL_CONDUCT_AUTHORITY_AUTHORIZATION"
        | "FRAUD_CHECK_DOCUMENT"
        | "ID_CARD"
        | "INVOICE"
        | "MEMORANDUM_OF_ASSOCIATION"
        | "NATIONAL_ID"
        | "OPERATING_LICENSE_DOCUMENT"
        | "OTHER"
        | "PARTNERSHIP_DEED"
        | "PASSPORT"
        | "PEP_FORM"
        | "REPORTING_ENTITY_REGISTRATION_DOCUMENT"
        | "RESIDENT_CARD"
        | "SHAREHOLDERS_REGISTRY"
        | "SOURCE_OF_FUNDS_DOCUMENT"
        | "TAX_CERTIFICATE"
        | "USER_SELFIE"
        | "USER_SELFIE_VIDEO"
        | "VISA_DOCUMENT"
        | "VOTER_ID_CARD"
    )[]
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: EntityDocument[]; total: number };
    },
>
Inherited from EntityDocumentQueryService.search
- Defined in packages/entity-services/src/entity-document/EntityDocumentQueryService.ts:143

Class EntityDocumentService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EntityDocumentService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Protected Readonlys3Bucket

Protected Readonlys3Client

Methods

completeUpload

Parameters

Returns Promise< { ok: true; value: EntityDocument } | { error: ServiceError; ok: false },>

delete

Parameters

customerId: string

entityId: string

entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON"

id: string

Returns Promise<{ ok: true; value: true } | { error: ServiceError; ok: false }>

get

Parameters

Returns Promise<{ ok: true; value: EntityDocument | null }>

getDownloadUrl

Parameters

customerId: string

Optionaldisposition?: "attachment" | "inline"

entityId: string

id: string

Returns Promise<{ ok: true; value: string | null }>

initiateUpload

Parameters

customerId: string

Optionaldescription?: string

entityId: string

entityType: "IDENTITY" | "ORGANIZATION" | "RELATED_PERSON"

fileName: string

fileSize: number

fileType: string

Optionalside?: "BACK" | "FRONT" | null

Returns Promise< | { ok: true; value: { expiresAt: Date; uploadId: string; uploadUrl: string }; } | { error: ServiceError; ok: false },>

search

Parameters

customerId: string

entityId: string

Optionalpage?: number

OptionalpageSize?: number

Optionalstatuses?: ("ACTIVE" | "DELETED")[]

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

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

`Protected` `Readonly`s3Bucket

`Protected` `Readonly`s3Client

Returns Promise<
{ ok: true; value: EntityDocument }
| { error: ServiceError; ok: false },
>

`Optional`disposition?: "attachment" | "inline"

`Optional`description?: string

`Optional`side?: "BACK" | "FRONT" | null

Returns Promise<
| {
ok: true;
value: { expiresAt: Date; uploadId: string; uploadUrl: string };
}
| { error: ServiceError; ok: false },
>

`Optional`page?: number

`Optional`pageSize?: number

`Optional`statuses?: ("ACTIVE" | "DELETED")[]

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