Integration

Introduction

The API is used to integrate the PureFi into your personal project. This interface is intended for developers and accompanied by detailed API Documentation.

Main URL: https://issuer.app.purefi.io/.

Getting Started

Access

Please contact us for getting the access.

Authorization

The API uses token authentication. You will be provided with a token which must be included in the header of all requests made to the API.

-H 'PUREFI-API-KEY: <API_TOKEN>'

Requests

AML risk score

Note: supported networks are Ethereum, Binance Smart Chain, Polygon.

Request Parameters:

1. Request type: POST
2. Access Point: https://issuer.app.purefi.io/api/aml/check
3. Content-Type: application/json
4. Parameters array:

• address - address representing the contract/
• type - address type, default wallet
• chainId - id network, default 1

const data = [
    {
        address: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
        type: CONTRACT, // CONTRACT, WALLET
        chainId: 56, // Ethereum = 1, Binance Smart Chain = 56, Polygon = 137
    },
];

async function getAmlScore(payload = {}) {
    const response = await fetch('https://issuer.app.purefi.io/api/aml/check', {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'PUREFI-API-KEY': 'xxxxx',
        },
        body: data,
    });
    return await response.json();
}

getAmlScore(payload)
    .then((data) => {
        console.log(data);
    })
    .catch((err) => {
        console.log(err);
    });

Successful response example:

[
    {
        address: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
        riskScore: 37,
        connections: {
            darkService: 0,
            atm: 0,
            exchangeFraudulent: 0,
            exchangeMlriskHigh: 0,
            exchangeMlriskLow: 0,
            exchangeMlriskModerate: 0,
            exchangeMlriskVeryhigh: 0,
            gambling: 0,
            illegalService: 0,
            marketplace: 0,
            miner: 0,
            mixer: 0,
            p2pExchangeMlriskHigh: 0,
            p2pExchangeMlriskLow: 0,
            payment: 0,
            ransom: 0,
            scam: 0,
            stolenCoins: 0,
            wallet: 0,
            childExploitation: 0,
            liquidityPools: 0,
            other: 0,
            sanctions: 0,
            seizedAssets: 0,
            terrorismFinancing: 0,
            p2pExchangeLicensed: 0,
            p2pExchangeUnlicensed: 0,
        },
    },
];

Error response example:

{
  "errorCode": 0,
  "message": "string",
  "details": {}
}

PureFi report

Note: supported networks are Ethereum, Binance Smart Chain, Polygon.

Request Parameters:

1. Request type: POST
2. Access Point: https://issuer.app.purefi.io/api/aml/report
3. Content-Type: application/json
4. Parameters array:

• address - address representing the contract/
• type - address type, default wallet
• chainId - id network, default 1

const data = [
    {
        address: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
        type: CONTRACT, // CONTRACT, WALLET
        chainId: 56, // Ethereum = 1, Binance Smart Chain = 56, Polygon = 137
    },
];

async function getPurefiReport(payload = {}) {
    const response = await fetch(
        'https://issuer.app.purefi.io/api/aml/report',
        {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json',
                'PUREFI-API-KEY': 'xxxxx',
            },
            body: data,
        }
    );
    return await response.json();
}

getPurefiReport(payload)
    .then((data) => {
        console.log(data);
    })
    .catch((err) => {
        console.log(err);
    });

Successful response example:

{
  "link": "string"
}

Error response example:

{
  "errorCode": 0,
  "message": "string",
  "details": {}
}