Skip to main content

Offsite Integration

In offsite integration, the merchant collects input through their own interface and sends the screening request to Shufti via the API or backoffice.

Parameters​

ParametersDescription
is_crypto_requestRequired: Yes
Type: String
This parameter must be set to "1" to identify the request as a Crypto Wallet Screening request.
background_checksRequired: Yes
Type: Object
This object contains the screening parameters for the crypto wallet or entity.
nameRequired: Yes
Type: Object
Contains the identifier to be screened.
full_name: Provide the wallet address or entity name here.
filtersRequired: No
Type: Array
Define the databases to screen against.
Accepted values: "sanction", "warning", "adverse-media"
Example: ["sanction", "warning"]
match_scoreRequired: No
Type: Integer
Accepted Range: 0-100
Controls the strictness of the matching process.
Default: 100
ongoingRequired: No
Type: String
Accepted Values: "0", "1"
Enable ("1") or disable ("0") ongoing monitoring for the submitted identifier.

Sample Request Payload​

{
"reference": "****sp-bc-****-****",
"is_crypto_request": "1",
"verification_mode": "any",
"background_checks": {
"name": {
"full_name": "0x1a2b3c4d5e6f7890abcdef1234567890abcdef12"
},
"match_score": 100,
"filters": ["sanction", "warning"],
"legacy_version": "0",
"ongoing": "0"
}
}