Class PureFI

Index

Methods

setSigner unsetSigner getSigner setIssuerUrl getIssuerUrl checkRisk downloadReport verifyRule verifyRuleV5

Methods

`Static`setSigner

setSigner(signer: ISigner): void
Sets a signer. The signer must implement ISigner interface

Provided signer will be used later on to sign messages within checkRisk and downloadReport methods

There is one exception

In case of checkRisk and downloadReport overloads that get PureFIPayload as an argument, mentioned methods assume you signed a message by yourself (probably you have a specific scenario around signing), so you don't need to set any signer at all in this particular case

All for the sake of flexibility
Parameters
- signer: ISigner
  an instance that implements the ISigner interface
Returns void
- Defined in src/purefi/index.ts:69

`Static`unsetSigner

unsetSigner(): void
Sets signer to undefined

Returns void
- Defined in src/purefi/index.ts:76

`Static`getSigner

getSigner(): undefined | ISigner
Returns current signer

Returns undefined | ISigner
- Defined in src/purefi/index.ts:83

`Static`setIssuerUrl

setIssuerUrl(baseUrl: string): void
Sets issuer url
Parameters
- baseUrl: string
Returns void
- Defined in src/purefi/index.ts:90

`Static`getIssuerUrl

getIssuerUrl(): string
Gets issuer url

Returns string
- Defined in src/purefi/index.ts:97

`Static`checkRisk

checkRisk(
param: string,
config?: AxiosRequestConfig,
): Promise<CheckRiskResponse>
Performs AML risk score screening

It assumes that provided address is the address of a wallet
Parameters
- param: string
  An address to screen
- Optionalconfig: AxiosRequestConfig
Returns Promise<CheckRiskResponse>
- Defined in src/purefi/index.ts:108
checkRisk(
param: string[],
config?: AxiosRequestConfig,
): Promise<CheckRiskResponse[]>
Performs AML risk score screening

It assumes that provided addresses are wallet-kind addresses
Parameters
- param: string[]
  An array of addresses to screen
- Optionalconfig: AxiosRequestConfig
Returns Promise<CheckRiskResponse[]>
- Defined in src/purefi/index.ts:119
checkRisk(
param: PureFIAddress,
config?: AxiosRequestConfig,
): Promise<CheckRiskResponse>
Performs AML risk score screening

Allows to specify what type of address you screen
Parameters
- param: PureFIAddress
  A PureFIAddress to screen
- Optionalconfig: AxiosRequestConfig
Returns Promise<CheckRiskResponse>
- Defined in src/purefi/index.ts:131
checkRisk(
param: PureFIAddress[],
config?: AxiosRequestConfig,
): Promise<CheckRiskResponse[]>
Performs AML risk score screening

Allows to specify what type of addresses you screen
Parameters
- param: PureFIAddress[]
  An array of PureFIAddress'es to screen
- Optionalconfig: AxiosRequestConfig
Returns Promise<CheckRiskResponse[]>
- Defined in src/purefi/index.ts:143
checkRisk(
param: PureFIPayload,
config?: AxiosRequestConfig,
): Promise<CheckRiskResponse[]>
Performs AML risk score screening

Consider using this overload if you want to have more control

over message signing and handle this process by yourself

In this particular case you don't need to set any signers
Parameters
- param: PureFIPayload
- Optionalconfig: AxiosRequestConfig
Returns Promise<CheckRiskResponse[]>
- Defined in src/purefi/index.ts:157

`Static`downloadReport

downloadReport(
param: string,
config: AxiosRequestConfig,
): Promise<DownloadReportResponse>
Generates PureFI VC Certificate in .pdf format

It assumes that provided address is the address of a wallet
Parameters
- param: string
  An address to screen
- config: AxiosRequestConfig
Returns Promise<DownloadReportResponse>
- Defined in src/purefi/index.ts:411
downloadReport(
param: string[],
config: AxiosRequestConfig,
): Promise<DownloadReportResponse>
Generates PureFI VC Certificate in .pdf format

It assumes that provided addresses are wallet-kind addresses
Parameters
- param: string[]
  An array of addresses to screen
- config: AxiosRequestConfig
Returns Promise<DownloadReportResponse>
- Defined in src/purefi/index.ts:422
downloadReport(
param: PureFIAddress,
config: AxiosRequestConfig,
): Promise<DownloadReportResponse>
Generates PureFI VC Certificate in .pdf format

Allows to specify type of the address
Parameters
- param: PureFIAddress
  A PureFIAddress to generate a report
- config: AxiosRequestConfig
Returns Promise<DownloadReportResponse>
- Defined in src/purefi/index.ts:434
downloadReport(
param: PureFIAddress[],
config: AxiosRequestConfig,
): Promise<DownloadReportResponse>
Generates PureFI VC Certificate in .pdf format

Allows to specify types of the addresses
Parameters
- param: PureFIAddress[]
  An array of PureFIAddress'es to generate a report
- config: AxiosRequestConfig
Returns Promise<DownloadReportResponse>
- Defined in src/purefi/index.ts:446
downloadReport(
param: PureFIPayload,
config: AxiosRequestConfig,
): Promise<DownloadReportResponse>
Generates PureFI VC Certificate in .pdf format

Consider using this overload if you want to have more control

over message signing and handle this process by yourself

In this particular case you don't need to set any signers
Parameters
- param: PureFIPayload
- config: AxiosRequestConfig
Returns Promise<DownloadReportResponse>
- Defined in src/purefi/index.ts:460

`Static`verifyRule

verifyRule(
    param: PureFIPayload,
    signatureType?: SignatureType,
    config?: AxiosRequestConfig,
): Promise<string>
Parameters
- param: PureFIPayload
- OptionalsignatureType: SignatureType
- Optionalconfig: AxiosRequestConfig
Returns Promise<string>
- Defined in src/purefi/index.ts:697
verifyRule(
    param: VerifyRulePayload,
    signatureType?: SignatureType,
    config?: AxiosRequestConfig,
): Promise<string>
Parameters
- param: VerifyRulePayload
- OptionalsignatureType: SignatureType
- Optionalconfig: AxiosRequestConfig
Returns Promise<string>
- Defined in src/purefi/index.ts:703

`Static`verifyRuleV5

verifyRuleV5(
    payload: PureFIRuleV5Payload,
    signatureType?: SignatureType,
    config?: AxiosRequestConfig,
): Promise<string>
Parameters
- payload: PureFIRuleV5Payload
- signatureType: SignatureType = SignatureType.ECDSA
- config: AxiosRequestConfig = {}
Returns Promise<string>
- Defined in src/purefi/index.ts:907

Class PureFI

Index

Methods

Methods

StaticsetSigner

Parameters

Returns void

StaticunsetSigner

Returns void

StaticgetSigner

Returns undefined | ISigner

StaticsetIssuerUrl

Parameters

Returns void

StaticgetIssuerUrl

Returns string

StaticcheckRisk

Parameters

Returns Promise<CheckRiskResponse>

Parameters

Returns Promise<CheckRiskResponse[]>

Parameters

Returns Promise<CheckRiskResponse>

Parameters

Returns Promise<CheckRiskResponse[]>

Parameters

Returns Promise<CheckRiskResponse[]>

StaticdownloadReport

Parameters

Returns Promise<DownloadReportResponse>

Parameters

Returns Promise<DownloadReportResponse>

Parameters

Returns Promise<DownloadReportResponse>

Parameters

Returns Promise<DownloadReportResponse>

Parameters

Returns Promise<DownloadReportResponse>

StaticverifyRule

Parameters

Returns Promise<string>

Parameters

Returns Promise<string>

StaticverifyRuleV5

Parameters

Returns Promise<string>

Settings

On This Page

`Static`setSigner

`Static`unsetSigner

`Static`getSigner

`Static`setIssuerUrl

`Static`getIssuerUrl

`Static`checkRisk

`Static`downloadReport

`Static`verifyRule

`Static`verifyRuleV5