Pre Screening
post
http://<enclave-endpoint>
/v1/pre-screening
Request Pre Screening with asset and address information
By delivering the virtual assets and wallet address, VASPs can verify the risk of the wallet address.It is recommended to pre-verify with Pre Screening API before the verification request.Pre Screening API is used to check the risk level of a wallet address by enclave before virtual asset transaction. Internally, a Chainalysis service is used.Application: When a user requests withdrawal, the originating VASP can check the risk level of the wallet address of a beneficiary prior to the originating VASP's /verifications or vice versa.In a staging environment, Pre Screening API is free of charge for 2 weeks.
Field Name | Data Type | Required | Description |
---|---|---|---|
asset | string | true | Virtual Asset. It is the symbol name of a virtual asset. (ex: ETH instead of Ethereum or Ether) |
address | string | true | Wallet Address of Virtual Asset |
Field Name | Data Type | Required | Description |
---|---|---|---|
preScreening | object | true | - |
preScreening.asset | string | true | Virtual assets which are related to the originating wallet address or the symbol of tokens. e.g. BTC, ETH, UNI, etc. |
preScreening.address | string | true | the originating wallet address |
preScreening.preScreeningId | string | true | Requested ID for Pre Screening |
preScreening.clusterName | string | false | Name of the cluster |
preScreening.clusterCategory | boolean | false | Category of the cluster |
preScreening.rating | string | true | risk |
preScreening.createdAt | string | true | The time at which the request was created using Pre Screening API. UTC ISO 8601 format. |
- Use <mark style-"color:blue;">preScreening.rating field as follows.
- Set as one of "UNKNOWN", "HIGH", "MEDIUM", "LOW".
- The risk rating of the known recipient address.
Last modified 11mo ago