KYC API Documentation API

by brex.io

API keyHTTPSFinance

Overview

API Interface to retrieve company data and products from business registers

KYC API Documentation is a finance API from brex.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 54 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Finance
Base URL: https://api.kompany.com/
Version: 2021.12
Endpoints: 54
OpenAPI: Specification ↗
Spec updated: 2021-08-09

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.kompany.com/api/v1/company/monitoring/changeTypes" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://api.kompany.com/api/v1/company/monitoring/changeTypes", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.kompany.com/api/v1/company/monitoring/changeTypes",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/api/v1/company/announcement/{id}`	Retrieves announcement data
POST	`/api/v1/company/deepsearch/isin`	Retrieves a list of stock exchange listings
GET	`/api/v1/company/deepsearch/lei/{number}`	Retrieves a list of companies
GET	`/api/v1/company/deepsearch/name/{country}/{name}`	Retrieves a list of companies from the official business register
GET	`/api/v1/company/deepsearch/number/{country}/{number}`	Retrieves a list of companies from the official business register
GET	`/api/v1/company/monitoring/changeTypes`	Get available ChangeTypes
GET	`/api/v1/company/monitoring/list`	Retrieves a list of registered monitors
GET	`/api/v1/company/monitoring/list/{id}`	Get monitor status for specific company id
POST	`/api/v1/company/monitoring/register/{id}`	Register a Company for monitoring
POST	`/api/v1/company/monitoring/unregister/{id}`	Deactivates an active notification
GET	`/api/v1/company/notification/list`	Retrieves a list of registered notifications
GET	`/api/v1/company/notification/list/{id}`	Retrieves a list of registered notifications
POST	`/api/v1/company/notification/register/{id}`	Creates a new notification
POST	`/api/v1/company/notification/unregister/{id}`	Unregister a company from Monitoring
GET	`/api/v1/company/search/name/{country}/{name}`	Retrieves a list of companies from the KYC API company index
GET	`/api/v1/company/search/number/{country}/{number}`	Retrieves a list of companies from the KYC API company index
POST	`/api/v1/company/search/{country}`	Retrieves a list of companies from the KYC API company index
GET	`/api/v1/company/{id}/announcements`	Retrieves company announcements
GET	`/api/v1/company/{id}/super/{country}`	Retrieves structured data extracted from a company document
GET	`/api/v1/company/{id}/{dataset}`	Retrieves company details
GET	`/api/v1/ein-verification/basic-check`	Verifies an EIN number
GET	`/api/v1/ein-verification/comprehensive-check`	Verifies EIN number and retrieves company data
GET	`/api/v1/ein-verification/lookup`	Retrieves a list of EIN numbers
POST	`/api/v1/iban-verification/check-iban`	Checks validity of an IBAN number
POST	`/api/v1/iban-verification/comprehensive-check-iban`	Checks validity of an IBAN number
POST	`/api/v1/nif-verification/basic-check/{country}`	Verifies a NIF number
POST	`/api/v1/nif-verification/comprehensive-check/{country}`	Verifies a NIF number and retrieves company data
GET	`/api/v1/pepsanction/monitor/list`	Retrieves a list of monitor entries
POST	`/api/v1/pepsanction/monitor/unregister/{id}`	Deactive a pep sanction monitor
POST	`/api/v1/pepsanction/monitor/update/{id}`	Update details of active Pep Sanction monitor
POST	`/api/v1/pepsanction/order/{type}/{search}`	Orders a new Pep Sanction Check Report
GET	`/api/v1/pepsanction/retrieve/{id}`	Returns a json or pdf report
GET	`/api/v1/product/availability/{sku}/{subjectId}`	Retrieves a document availability result
GET	`/api/v1/product/catalog/{country}`	Returns a catalog of products
GET	`/api/v1/product/notifier/{notifierId}`	Returns metadata for a notifier
POST	`/api/v1/product/notifier/{orderId}/{type}/{uri}`	Creates a notifier for an order
POST	`/api/v1/product/order/concierge`	Places a concierge order
POST	`/api/v1/product/order/ubo`	Places a UBO order
POST	`/api/v1/product/order/{sku}/{option}/{subjectId}`	Places a product order
POST	`/api/v1/product/order/{sku}/{subjectId}`	Places a product order
GET	`/api/v1/product/search/{subjectId}`	Returns a list of products
GET	`/api/v1/product/status/{orderId}`	Returns metadata for a order
POST	`/api/v1/product/update/{action}/{orderId}`	Updates metadata of an order
GET	`/api/v1/product/{orderId}`	Retrieves the result of an order
GET	`/api/v1/system/countries`	Returns a list of countries
GET	`/api/v1/system/health`	Returns the health information for the official business registers based on usage.
GET	`/api/v1/system/pricelist`	Returns a list of products with prices
GET	`/api/v1/tin-verification/basic-check`	Verifies a TIN number
GET	`/api/v1/tin-verification/comprehensive-check`	EIN Name Lookup with TIN number and retrieves company data
GET	`/api/v1/tin-verification/name-lookup`	EIN Name Lookup with TIN number
POST	`/api/v1/vat-verification/basic-check/{country}`	Returns a verification result
POST	`/api/v1/vat-verification/comprehensive-check/{country}`	Returns a verification result and company data
POST	`/api/v1/vat-verification/leveltwo-check/{country}`	Returns a level two verification result
POST	`/api/v1/vat-verification/lookup/{country}`	Returns a list of vat numbers with additional data