KYC API Documentation
API Interface to retrieve company data and products from business registers
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API Interface to retrieve company data and products from business registers
Endpoints 54
v1-system
- GETReturns a list of countries
/api/v1/system/countriesRetrieve the list of all currently enabled countries - GETReturns the health information for the official business registers based on usage.
/api/v1/system/healthReturns the health information for the official business registers based on usage. - GETReturns a list of products with prices
/api/v1/system/pricelistRetrieve pricing rules for your subscription plan
v1-company
- GETRetrieves announcement data
/api/v1/company/announcement/:idRequest full announcement data identified by announcement id - POSTRetrieves a list of stock exchange listings
/api/v1/company/deepsearch/isinLookup stock exchange listings identified by an ISIN (International Securities Identification Number) number. Search is forwarded to a provider. - GETRetrieves a list of companies
/api/v1/company/deepsearch/lei/:number?page=1Lookup companies identified by a LEI (Legal Entity Identifier) number. Search is forwarded to a provider. - GETRetrieves a list of companies from the official business register
/api/v1/company/deepsearch/name/:country/:nameSearch for companies with a certain name. Search is forwarded to the respective business register of the country. - GETRetrieves a list of companies from the official business register
/api/v1/company/deepsearch/number/:country/:numberSearch for companies with a certain register number. Search is forwarded to the respective business register of the country. - GETGet available ChangeTypes
/api/v1/company/monitoring/changeTypesGet current list of available ChangeTypes to subscribe to - GETRetrieves a list of registered monitors
/api/v1/company/monitoring/listQuery list of all registered monitors for logged in user - GETGet monitor status for specific company id
/api/v1/company/monitoring/list/:idQuery status of registered monitors for a specific company identified by a company id - POSTRegister a Company for monitoring
/api/v1/company/monitoring/register/:idAdd a company to your perpetual monitoring list and register a callback URL to get monitoring alerts. - POSTDeactivates an active notification
/api/v1/company/monitoring/unregister/:idDeactivate a previously registered company monitor identified by the notifier id - GETRetrieves a list of registered notifications
/api/v1/company/notification/listQuery list of registered callback URLs for logged in user - GETRetrieves a list of registered notifications
/api/v1/company/notification/list/:idQuery list of registered notifications for a specific company identified by a company id - POSTCreates a new notification
/api/v1/company/notification/register/:idRegister a new callback URL to get notifications about companies. - POSTUnregister a company from Monitoring
/api/v1/company/notification/unregister/:idDeactivate a previously registered company monitor identified by the notifier id - GETRetrieves a list of companies from the KYC API company index
/api/v1/company/search/name/:country/:name?limit=0KYC API company index lookup for companies with a certain name in a country. - GETRetrieves a list of companies from the KYC API company index
/api/v1/company/search/number/:country/:number?limit=0KYC API company index lookup for companies with a certain register number in a country. - POSTRetrieves a list of companies from the KYC API company index
/api/v1/company/search/:countryKYC API company index lookup by country and mixed parameters. This function requires a country code then a mixture of name - GETRetrieves company announcements
/api/v1/company/:id/announcements?limit=0&offset=0&data=trueSearch announcements filed to the business register from a company identified by an id - GETRetrieves structured data extracted from a company document
/api/v1/company/:id/super/:country?lang=Request company superdata identified by company id - GETRetrieves company details
/api/v1/company/:id/:dataset?check_stock_listing=true&lang=Get company details by id. The level of details is defined by the dataset parameter
v1-product
- GETRetrieves a document availability result
/api/v1/product/availability/:sku/:subjectIdCheck availability and valid options for a particular product for a particular company identfied by its id - GETReturns a catalog of products
/api/v1/product/catalog/:countryReturns a catalog of purchasable products available with some metadata for a particular country - GETReturns metadata for a notifier
/api/v1/product/notifier/:notifierIdQueries and returns all metadata associated with a notifier identified by its notifer id - POSTCreates a notifier for an order
/api/v1/product/notifier/:orderId/:type/:uriCreate a notifier for a particular order. Parameters can be supplied in the path - POSTPlaces a concierge order
/api/v1/product/order/conciergePlace an order for a concierge product - POSTPlaces a UBO order
/api/v1/product/order/uboPlace an order for a UBO (ultimate beneficial owner) discovery report - POSTPlaces a product order
/api/v1/product/order/:sku/:option/:subjectIdPlace an order for a particular product identified by its SKU with a particular option for a particular company identified by its id - POSTPlaces a product order
/api/v1/product/order/:sku/:subjectIdPlace an order for a particular product identified by its SKU for a particular company identified by its id - GETReturns a list of products
/api/v1/product/search/:subjectIdSearch for possible products for a particular company identified by its id - GETReturns metadata for a order
/api/v1/product/status/:orderIdRetrieve the current status of an order identified by its order id - POSTUpdates metadata of an order
/api/v1/product/update/:action/:orderIdUpdate an existing order identified by its order id - GETRetrieves the result of an order
/api/v1/product/:orderIdRetrieves the document or structured data associated with a completed order identified with its order id
v1-pepsanction
- GETRetrieves a list of monitor entries
/api/v1/pepsanction/monitor/listRetrieve a list of all active Pep Sanction Report monitors for this account - POSTDeactive a pep sanction monitor
/api/v1/pepsanction/monitor/unregister/:idUnregister a previously created Pep Sanction Report Monitor - POSTUpdate details of active Pep Sanction monitor
/api/v1/pepsanction/monitor/update/:idUpdate the webhook URL of an active Pep Sanction Report Monitor - POSTOrders a new Pep Sanction Check Report
/api/v1/pepsanction/order/:type/:searchOrder a new Pep Sanction Check by providing either a business or person name with some additional optional parameters. - GETReturns a json or pdf report
/api/v1/pepsanction/retrieve/:idRetrieve a completed Pep Sanction check structured or in pdf depending on given accept header
v1-vat-verification
- POSTReturns a verification result
/api/v1/vat-verification/basic-check/:countryBasic verification of given VAT number against VIES. Optional parameters may help to build a better confidence score. - POSTReturns a verification result and company data
/api/v1/vat-verification/comprehensive-check/:countryExtended verification of given VAT number against VIES. Optional parameters may help to build a better confidence score. - POSTReturns a level two verification result
/api/v1/vat-verification/leveltwo-check/:countrySecond Level Verification of VAT number against BMF Austria. Optional confirmation parameter can be provided to order a Confirmation Report. - POSTReturns a list of vat numbers with additional data
/api/v1/vat-verification/lookup/:countryReverse VAT Lookup: Search for companies and their VAT numbers by company name. Search is forwarded to a provider.
v1-ein-verification
- GETVerifies an EIN number
/api/v1/ein-verification/basic-check?ein=stringPerforms a basic verification check of a given EIN tax number. - GETVerifies EIN number and retrieves company data
/api/v1/ein-verification/comprehensive-check?ein=stringComprehensive verification of a given EIN number. Additionally to the basic verification it will lookup company details - GETRetrieves a list of EIN numbers
/api/v1/ein-verification/lookup?name=string&state=string&zip=string&tight=trueLookup EIN number for a company by its company name
v1-nif-verification
- POSTVerifies a NIF number
/api/v1/nif-verification/basic-check/:countryPerforms a basic verification check of a given NIF tax number against NIF.com. Optional parameters may be added to improve calculation of confidence score. - POSTVerifies a NIF number and retrieves company data
/api/v1/nif-verification/comprehensive-check/:countryComprehensive verification of given portuguese NIF number against NIF.com. Optional parameters may help to build a better confidence score. Additional company…
v1-iban-verification
- POSTChecks validity of an IBAN number
/api/v1/iban-verification/check-ibanBasic verification of an IBAN number validating its structure - POSTChecks validity of an IBAN number
/api/v1/iban-verification/comprehensive-check-ibanComprehensive verification of IBAN number using a service provider for verification
v1-tin-verification
- GETVerifies a TIN number
/api/v1/tin-verification/basic-check?tin=string&name=stringPerforms a basic verification check of a given TIN number and name. - GETEIN Name Lookup with TIN number and retrieves company data
/api/v1/tin-verification/comprehensive-check?tin=string&name=string&threshold=0Performs an EIN name match using provided TIN Number. Additionally to the name lookup it will lookup company details - GETEIN Name Lookup with TIN number
/api/v1/tin-verification/name-lookup?tin=stringPerforms an EIN name match using provided TIN Number
API details
- Base URL
https://api.kompany.com- Authentication
- An API key in the user_key header
- Operations
- 54 operations on 54 pathsGET 31POST 23
- Main resources
- v1-company 20v1-product 12v1-pepsanction 5v1-vat-verification 4v1-ein-verification 3v1-system 3v1-tin-verification 3v1-iban-verification 2v1-nif-verification 2
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2021.12 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the KYC API Documentation in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the KYC API Documentation collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the user_key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Returns a list of countries” (GET /api/v1/system/countries), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the KYC API Documentation?
API Interface to retrieve company data and products from business registers It is listed under Finance & banking and has 54 endpoints.
Who publishes the KYC API Documentation?
It is listed from Brex's public API description (an OpenAPI document), not published by Brex on Swastik Codes. Anyone who controls brex.io can claim the profile by adding a DNS TXT record.
What is the base URL of the KYC API Documentation?
Requests go to https://api.kompany.com. Endpoint paths are added to this base URL.
How do I authenticate with the KYC API Documentation?
With an API key in the user_key header.
How many endpoints does the KYC API Documentation have?
54 operations on 54 paths (31 GET, 23 POST). The largest groups are v1-company, v1-product, v1-pepsanction, v1-vat-verification.
Is forking the KYC API Documentation free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.