BusinessVerifier
Defined in: packages/channel/src/verification/business.verify.ts:91
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BusinessVerifier(
options?):BusinessVerifier
Defined in: packages/channel/src/verification/business.verify.ts:107
Parameters
Section titled “Parameters”options?
Section titled “options?”Partial<BusinessVerifierOptions> = {}
Returns
Section titled “Returns”BusinessVerifier
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addDocument()
Section titled “addDocument()”addDocument(
requestId,document):Promise<VerificationRequest>
Defined in: packages/channel/src/verification/business.verify.ts:237
Update verification request with additional documents
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
document
Section titled “document”Returns
Section titled “Returns”Promise<VerificationRequest>
addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
approveVerification()
Section titled “approveVerification()”approveVerification(
requestId,reviewerId,notes?):Promise<VerificationRequest>
Defined in: packages/channel/src/verification/business.verify.ts:172
Manually approve verification
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
reviewerId
Section titled “reviewerId”string
notes?
Section titled “notes?”string
Returns
Section titled “Returns”Promise<VerificationRequest>
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/channel/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: packages/channel/src/shared/event-emitter.ts:71
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”EventEmitter.eventNames
getVerificationByChannelId()
Section titled “getVerificationByChannelId()”getVerificationByChannelId(
channelId):VerificationRequest|null
Defined in: packages/channel/src/verification/business.verify.ts:160
Get verification request by channel ID
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
Returns
Section titled “Returns”VerificationRequest | null
getVerificationRequest()
Section titled “getVerificationRequest()”getVerificationRequest(
requestId):VerificationRequest|null
Defined in: packages/channel/src/verification/business.verify.ts:153
Get verification request by ID
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
Returns
Section titled “Returns”VerificationRequest | null
getVerificationStats()
Section titled “getVerificationStats()”getVerificationStats():
object
Defined in: packages/channel/src/verification/business.verify.ts:305
Get verification statistics
Returns
Section titled “Returns”object
autoApprovalRate
Section titled “autoApprovalRate”autoApprovalRate:
number
averageProcessingTime
Section titled “averageProcessingTime”averageProcessingTime:
number
byStatus
Section titled “byStatus”byStatus:
Record<string,number>
total:
number
listenerCount()
Section titled “listenerCount()”listenerCount(
eventName):number
Defined in: packages/channel/src/shared/event-emitter.ts:67
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
listVerificationRequests()
Section titled “listVerificationRequests()”listVerificationRequests(
filters?):VerificationRequest[]
Defined in: packages/channel/src/verification/business.verify.ts:272
List verification requests with filters
Parameters
Section titled “Parameters”filters?
Section titled “filters?”channelId?
Section titled “channelId?”string
status?
Section titled “status?”submittedAfter?
Section titled “submittedAfter?”Date
submittedBefore?
Section titled “submittedBefore?”Date
Returns
Section titled “Returns”off(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
rejectVerification()
Section titled “rejectVerification()”rejectVerification(
requestId,reviewerId,reason):Promise<VerificationRequest>
Defined in: packages/channel/src/verification/business.verify.ts:203
Manually reject verification
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
reviewerId
Section titled “reviewerId”string
reason
Section titled “reason”string
Returns
Section titled “Returns”Promise<VerificationRequest>
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/channel/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
submitVerification()
Section titled “submitVerification()”submitVerification(
channelId,businessInfo,documents):Promise<VerificationRequest>
Defined in: packages/channel/src/verification/business.verify.ts:116
Submit business verification request
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
businessInfo
Section titled “businessInfo”documents
Section titled “documents”Returns
Section titled “Returns”Promise<VerificationRequest>