@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/entity-services
entity-document
EntityDocumentQueryService
Class EntityDocumentQueryService
Read-only access to entity documents
Hierarchy (
View Summary
)
EntityDocumentQueryService
EntityDocumentService
Index
Constructors
constructor
Properties
db
db
Helper
s3
Bucket
s3
Client
Methods
get
get
Download
Url
search
Constructors
constructor
new
EntityDocumentQueryService
(
__namedParameters
:
{
s3Bucket
:
string
;
s3Client
:
S3Client
;
sqlClient
:
Sql
;
}
,
)
:
EntityDocumentQueryService
Parameters
__namedParameters
:
{
s3Bucket
:
string
;
s3Client
:
S3Client
;
sqlClient
:
Sql
}
Returns
EntityDocumentQueryService
Properties
Protected
Readonly
db
db
:
B2bDatabase
Protected
Readonly
db
Helper
dbHelper
:
DbHelper
Protected
Readonly
s3
Bucket
s3Bucket
:
string
Protected
Readonly
s3
Client
s3Client
:
S3Client
Methods
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
}
>
get
Download
Url
getDownloadUrl
(
__namedParameters
:
{
customerId
:
string
;
entityId
:
string
;
id
:
string
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
string
|
null
}
>
Parameters
__namedParameters
:
{
customerId
:
string
;
entityId
:
string
;
id
:
string
}
Returns
Promise
<
{
ok
:
true
;
value
:
string
|
null
}
>
search
search
(
__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"
)
[]
;
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
{
hasNext
:
boolean
;
items
:
EntityDocument
[]
;
total
:
number
}
;
}
,
>
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
Optional
page
?:
number
Defaults to 1
Optional
pageSize
?:
number
Defaults to 50
Optional
statuses
?:
(
"ACTIVE"
|
"DELETED"
)
[]
Optional
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"
)
[]
Returns
Promise
<
{
ok
:
true
;
value
:
{
hasNext
:
boolean
;
items
:
EntityDocument
[]
;
total
:
number
}
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
db
db
Helper
s3
Bucket
s3
Client
Methods
get
get
Download
Url
search
@cfxlabsinc/b2b-services
Loading...
Read-only access to entity documents