Comprehensive screening

Gatenox Hub provides Compliance Officers with a robust API, offering powerful screening capabilities for individuals, companies, and crypto addresses, ensuring comprehensive compliance checks.

Screening Individuals (KYC) and Companies (KYB)

Instant screening

Gatenox Hub offers both individuals and companies screening against sanctions / PEP and criminal records.

• For Individuals - provide a surname, given names, and optional date of birth.

New Check

POSThttps://api.app.gatenox.com/api/v1/checks/individuals

Body

multipart/form-data

check_typestring

standard | premium

given_namesstring

surnamestring

date_of_birthstring

optional, YYYY-MM-DD

Response

200400422

OK

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/individuals', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

The endpoint's body requires the following values to be included in the request:

Parameter	Values	Required?
check_type	standard | premium	Yes
given_names		Yes
surname		Yes
date_of_birth		No

• For Companies - specifying company name.

New Check

POSThttps://api.app.gatenox.com/api/v1/checks/companies

Body

multipart/form-data

check_typestring

standard | premium

company_namestring

Response

200400422

OK

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/companies', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

The endpoint's body requires the following values to be included in the request:

Parameter	Values	Required?
check_type	standard | premium	Yes
company_name		Yes

Gatenox Hub offers two levels of sanctions/PEP/criminal records screening:

• Standard Screening: Users with Gatenox Hub licenses can perform free basic screenings against OFAC, EU, UN, PL, UK, and Singapore sanctions lists.

• Premium Screening: A paid service, offering advanced checks against sanctions, PEP databases, and global criminal lists, providing a thorough compliance solution.

Get the results of the screening

Download a comprehensive list of checks and details from previous screenings using the following endpoints:

Individuals

List

GEThttps://api.app.gatenox.com/api/v1/checks/individuals

Query parameters

Response

200

OK

Body

application/json

checks_individualarray of GET_apiv1checksindividuals_response_200_checks_individual (object)

metaGET_apiv1checksindividuals_response_200_meta (object)

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/individuals', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "checks_individual": [
    {
      "id": "text",
      "check_type": "text",
      "created_at": "text",
      "updated_at": "text",
      "state": "text",
      "given_names": "text",
      "surname": "text",
      "date_of_birth": "text"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0
    }
  }
}

Details

GEThttps://api.app.gatenox.com/api/v1/checks/individuals/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/individuals/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Companies

List

GEThttps://api.app.gatenox.com/api/v1/checks/companies

Query parameters

Response

200

OK

Body

application/json

checks_companyarray of GET_apiv1checkscompanies_response_200_checks_company (object)

metaGET_apiv1checkscompanies_response_200_meta (object)

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/companies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "checks_company": [
    {
      "id": "text",
      "check_type": "text",
      "created_at": "text",
      "updated_at": "text",
      "state": "text",
      "company_name": "text"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0
    }
  }
}

Details

GEThttps://api.app.gatenox.com/api/v1/checks/companies/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/companies/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Associated files (if any) can be downloaded via an additional endpoint.

Download Attachement

GEThttps://api.app.gatenox.com/api/v1/attachments/{rest}

Path parameters

rest*string

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/attachments/{rest}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Crypto Address Verification (Blockchain Analytics)

Request a report

Verify crypto addresses by providing the blockchain and the specific address.

New Check

POSThttps://api.app.gatenox.com/api/v1/checks/crypto_address

Query parameters

Body

multipart/form-data

address_typestring

addressstring

check_typestring

(optional, default: coinfirm) coinfirm, amlbot

extendedboolean

(optional, amlbot only, default: false) true, false

flowstring

(optional, amlbot only, default: fast) fast, advanced

tx_hashstring

(optional, ambot only) initiates transaction verification

directionstring

(amlbot only, required when tx_hash filled) deposti, withdrawal

Response

200400422

OK

Body

application/json

check_crypto_addressPOST_apiv1checkscrypto_address_response_200_check_crypto_address (object)

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/crypto_address', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "check_crypto_address": {
    "id": "text",
    "check_type": "text",
    "created_at": "text",
    "updated_at": "text",
    "state": "text",
    "address_type": "text",
    "address": "text"
  }
}

Get the report

Receive a comprehensive crypto address report, including risk assessment, financial analysis (historical balance), and a list of owned tokens.

List

GEThttps://api.app.gatenox.com/api/v1/checks/crypto_address

Query parameters

Response

200

OK

Body

application/json

checks_crypto_addressarray of GET_apiv1checkscrypto_address_response_200_checks_crypto_address (object)

metaGET_apiv1checkscrypto_address_response_200_meta (object)

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/crypto_address', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "checks_crypto_address": [
    {
      "id": "text",
      "check_type": "text",
      "created_at": "text",
      "updated_at": "text",
      "state": "text",
      "cscore_section": {
        "cscore": 0,
        "risk_level": "text"
      },
      "address_type": "text",
      "address": "text"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0
    }
  }
}

Details

GEThttps://api.app.gatenox.com/api/v1/checks/crypto_address/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

check_crypto_addressGET_apiv1checkscrypto_addressid_response_200_check_crypto_address (object)

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/checks/crypto_address/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "check_crypto_address": {
    "id": "text",
    "check_type": "text",
    "created_at": "text",
    "updated_at": "text",
    "state": "text",
    "trust_report": {
      "id": "text",
      "service": "text",
      "external_id": "text",
      "object_type": "text",
      "created_at": "text",
      "updated_at": "text",
      "document": {
        "id": "text",
        "name": "text",
        "document_type": "text",
        "created_at": "text",
        "updated_at": "text",
        "attachments": [
          {
            "id": "text",
            "attachment_type": "text",
            "created_at": "text",
            "updated_at": "text",
            "filesize": 0,
            "mime": "text",
            "urls": {
              "thumb": "text",
              "medium": "text",
              "original": "text"
            }
          }
        ]
      },
      "report": {
        "assets_section": {
          "assets": [
            {
              "name": "text",
              "xrate": 0,
              "symbol": "text",
              "balance": 0,
              "contract": "text",
              "precision": 0,
              "balance_usd": 0
            }
          ],
          "usd_value": 0,
          "assets_count": 0
        },
        "cscore_section": {
          "cscore": 0,
          "risk_level": "text",
          "cscore_info": [
            {
              "id": 0,
              "name": "text",
              "type": 0,
              "impact": 0,
              "group_name": "text"
            }
          ]
        },
        "profile_section": {
          "owner": {
            "id": 0,
            "url": "text",
            "name": "text",
            "uuid": "text"
          },
          "cluster_info": [
            {
              "name": "text",
              "value": "text",
              "description": "text"
            }
          ],
          "identified_profiles": [
            {
              "profile_name": "text",
              "profile_type": "text"
            }
          ]
        },
        "indicators_section": [
          {
            "type": 0,
            "cat_name": "text",
            "risk_detected": false,
            "is_informative": false,
            "sub_categories": [
              {
                "type": 0,
                "flags": [
                  {
                    "id": 0,
                    "name": "text",
                    "type": 0,
                    "risk_detected": false,
                    "is_informative": false
                  }
                ],
                "sub_cat_name": "text",
                "risk_detected": false,
                "is_informative": false
              }
            ],
            "display_priority": 0
          }
        ],
        "report_info_section": {
          "asset": "text",
          "address": "text",
          "version": "text",
          "precision": 0,
          "report_id": "text",
          "is_cluster": false,
          "model_info": {
            "name": "text",
            "uuid": "text",
            "version": 0
          },
          "report_time": "text",
          "report_type": "text",
          "address_type": "text",
          "address_used": false,
          "early_access": false,
          "address_subtype": "text",
          "is_smart_contract": false,
          "report_block_height": 0
        },
        "other_information_section": {
          "glossary": [
            {
              "term": "text",
              "description": "text"
            }
          ],
          "disclaimer": "text"
        },
        "financial_analysis_section": {
          "cc_balance": 0,
          "last_input": {
            "amount": 0,
            "tx_hash": "text",
            "activated": false,
            "usd_value": 0,
            "block_time": "text",
            "block_height": 0
          },
          "first_input": {
            "amount": 0,
            "tx_hash": "text",
            "activated": false,
            "usd_value": 0,
            "block_time": "text",
            "block_height": 0
          },
          "last_output": {
            "amount": 0,
            "tx_hash": "text",
            "activated": false,
            "usd_value": 0,
            "block_time": "text",
            "block_height": 0
          },
          "total_input": {
            "avg_cc_inflow": 0,
            "max_cc_inflow": 0,
            "min_cc_inflow": 0,
            "receive_count": 0,
            "avg_usd_inflow": 0,
            "max_usd_inflow": 0,
            "min_usd_inflow": 0,
            "total_cc_inflow": 0,
            "total_usd_inflow": 0,
            "receive_transaction_count": 0,
            "receive_transaction_asset_count": 0
          },
          "usd_balance": 0,
          "first_output": {
            "amount": 0,
            "tx_hash": "text",
            "activated": false,
            "usd_value": 0,
            "block_time": "text",
            "block_height": 0
          },
          "total_output": {
            "sent_count": 0,
            "avg_cc_outflow": 0,
            "max_cc_outflow": 0,
            "min_cc_outflow": 0,
            "avg_usd_outflow": 0,
            "max_usd_outflow": 0,
            "min_usd_outflow": 0,
            "total_cc_outflow": 0,
            "total_usd_outflow": 0,
            "sent_transaction_count": 0,
            "sent_transaction_asset_count": 0
          },
          "transactions": {
            "tx_count": 0,
            "avg_tx_fee": 0,
            "sum_tx_fee": 0,
            "avg_tx_size": 0,
            "cc_turnover": 0,
            "receive_peak": 0,
            "usd_turnover": 0,
            "days_without_tx": 0,
            "transfers_count": 0,
            "days_since_start": 0
          },
          "usd_exchange_rate": 0,
          "usd_balance_without_tokens": 0
        }
      }
    },
    "cscore_section": {
      "cscore": 0,
      "risk_level": "text"
    },
    "address_type": "text",
    "address": "text"
  }
}

Download the detailed report in PDF format for further analysis and record-keeping.

Download Attachement

GEThttps://api.app.gatenox.com/api/v1/attachments/{rest}

Path parameters

rest*string

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/attachments/{rest}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();