{"@context": "https://schema.org", "@type": "WebAPI", "name": "KYC API Documentation API", "description": "API Interface to retrieve company data and products from business registers", "provider": {"@type": "Organization", "name": "brex.io"}, "documentation": "https://api.brex.io/docs/api-docs.json"}
API Interface to retrieve company data and products from business registers
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.kompany.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
API Interface to retrieve company data and products from business registers
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/v1/company/announcement/{id} | Retrieves announcement data Request full announcement data identified by announcement id v1-company |
POST | /api/v1/company/deepsearch/isin | Retrieves a list of stock exchange listings Lookup stock exchange listings identified by an ISIN (Internationa |
GET | /api/v1/company/deepsearch/lei/{number} | Retrieves a list of companies Lookup companies identified by a LEI (Legal Entity Identifier) number. Search is |
GET | /api/v1/company/deepsearch/name/{country}/{name} | Retrieves a list of companies from the official business register Search for companies with a certain name. Se |
GET | /api/v1/company/deepsearch/number/{country}/{number} | Retrieves a list of companies from the official business register Search for companies with a certain register |
GET | /api/v1/company/monitoring/changeTypes | Get available ChangeTypes Get current list of available ChangeTypes to subscribe to v1-company |
GET | /api/v1/company/monitoring/list | Retrieves a list of registered monitors Query list of all registered monitors for logged in user v1-company |
GET | /api/v1/company/monitoring/list/{id} | Get monitor status for specific company id Query status of registered monitors for a specific company identifi |
POST | /api/v1/company/monitoring/register/{id} | Register a Company for monitoring Add a company to your perpetual monitoring list and register a callback URL |
POST | /api/v1/company/monitoring/unregister/{id} | Deactivates an active notification Deactivate a previously registered company monitor identified by the notifi |
GET | /api/v1/company/notification/list | Retrieves a list of registered notifications Query list of registered callback URLs for logged in user v1-comp |
GET | /api/v1/company/notification/list/{id} | Retrieves a list of registered notifications Query list of registered notifications for a specific company ide |
POST | /api/v1/company/notification/register/{id} | Creates a new notification Register a new callback URL to get notifications about companies. v1-company |
POST | /api/v1/company/notification/unregister/{id} | Unregister a company from Monitoring Deactivate a previously registered company monitor identified by the noti |
GET | /api/v1/company/search/name/{country}/{name} | Retrieves a list of companies from the KYC API company index KYC API company index lookup for companies with a |
GET | /api/v1/company/search/number/{country}/{number} | Retrieves a list of companies from the KYC API company index KYC API company index lookup for companies with a |
POST | /api/v1/company/search/{country} | Retrieves a list of companies from the KYC API company index KYC API company index lookup by country and mixed |
GET | /api/v1/company/{id}/announcements | Retrieves company announcements Search announcements filed to the business register from a company identified |
GET | /api/v1/company/{id}/super/{country} | Retrieves structured data extracted from a company document Request company superdata identified by company id |
GET | /api/v1/company/{id}/{dataset} | Retrieves company details Get company details by id. The level of details is defined by the dataset parameter |
GET | /api/v1/ein-verification/basic-check | Verifies an EIN number Performs a basic verification check of a given EIN tax number. v1-ein-verification |
GET | /api/v1/ein-verification/comprehensive-check | Verifies EIN number and retrieves company data Comprehensive verification of a given EIN number. Additionally |
GET | /api/v1/ein-verification/lookup | Retrieves a list of EIN numbers Lookup EIN number for a company by its company name v1-ein-verification |
POST | /api/v1/iban-verification/check-iban | Checks validity of an IBAN number Basic verification of an IBAN number validating its structure v1-iban-verifi |
POST | /api/v1/iban-verification/comprehensive-check-iban | Checks validity of an IBAN number Comprehensive verification of IBAN number using a service provider for verif |
POST | /api/v1/nif-verification/basic-check/{country} | Verifies a NIF number Performs a basic verification check of a given NIF tax number against NIF.com. Optional |
POST | /api/v1/nif-verification/comprehensive-check/{country} | Verifies a NIF number and retrieves company data Comprehensive verification of given portuguese NIF number aga |
GET | /api/v1/pepsanction/monitor/list | Retrieves a list of monitor entries Retrieve a list of all active Pep Sanction Report monitors for this accoun |
POST | /api/v1/pepsanction/monitor/unregister/{id} | Deactive a pep sanction monitor Unregister a previously created Pep Sanction Report Monitor v1-pepsanction |
POST | /api/v1/pepsanction/monitor/update/{id} | Update details of active Pep Sanction monitor Update the webhook URL of an active Pep Sanction Report Monitor |
POST | /api/v1/pepsanction/order/{type}/{search} | Orders a new Pep Sanction Check Report Order a new Pep Sanction Check by providing either a business or person |
GET | /api/v1/pepsanction/retrieve/{id} | Returns a json or pdf report Retrieve a completed Pep Sanction check structured or in pdf depending on given a |
GET | /api/v1/product/availability/{sku}/{subjectId} | Retrieves a document availability result Check availability and valid options for a particular product for a p |
GET | /api/v1/product/catalog/{country} | Returns a catalog of products Returns a catalog of purchasable products available with some metadata for a par |
GET | /api/v1/product/notifier/{notifierId} | Returns metadata for a notifier Queries and returns all metadata associated with a notifier identified by its |
POST | /api/v1/product/notifier/{orderId}/{type}/{uri} | Creates a notifier for an order Create a notifier for a particular order. Parameters can be supplied in the pa |
POST | /api/v1/product/order/concierge | Places a concierge order Place an order for a concierge product v1-product |
POST | /api/v1/product/order/ubo | Places a UBO order Place an order for a UBO (ultimate beneficial owner) discovery report v1-product |
POST | /api/v1/product/order/{sku}/{option}/{subjectId} | Places a product order Place an order for a particular product identified by its SKU with a particular option |
POST | /api/v1/product/order/{sku}/{subjectId} | Places a product order Place an order for a particular product identified by its SKU for a particular company |
and 14 more operation(s) in this specification, all searchable.
specification origin: https://api.brex.io/docs/api-docs.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.