/api/v1/company/search/number/{country}/{number}

Retrieves a list of companies from the KYC API company index

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars
• number (path, required) — company registration number
• limit (query, limit) — number of search results

/api/v1/company/search/{country}

Retrieves a list of companies from the KYC API company index

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars

/api/v1/company/announcement/{id}

Retrieves announcement data

• id (path, required) — announcement hex ID

/api/v1/company/deepsearch/isin

Retrieves a list of stock exchange listings

/api/v1/company/deepsearch/lei/{number}

Retrieves a list of companies

• number (path, required) — lei number
• page (query, page) — Pagination for the ISIN number results (1000 numbers per page)

/api/v1/company/deepsearch/name/{country}/{name}

Retrieves a list of companies from the official business register

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars
• name (path, required) — company name

/api/v1/company/deepsearch/number/{country}/{number}

Retrieves a list of companies from the official business register

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars
• number (path, required) — company registration number

/api/v1/company/monitoring/changeTypes

Get available ChangeTypes

/api/v1/company/monitoring/list

Retrieves a list of registered monitors

/api/v1/company/monitoring/list/{id}

Get monitor status for specific company id

• id (path, required) — Company Hex ID

/api/v1/company/monitoring/register/{id}

Register a Company for monitoring

• id (path, required) — Company Hex ID

/api/v1/company/monitoring/unregister/{id}

Deactivates an active notification

• id (path, required) — Registration id of monitoring request record

/api/v1/company/notification/list

Retrieves a list of registered notifications

/api/v1/company/notification/list/{id}

Retrieves a list of registered notifications

• id (path, required) — Company Hex ID

/api/v1/company/notification/register/{id}

Creates a new notification

• id (path, required) — Company Hex ID

/api/v1/company/notification/unregister/{id}

Unregister a company from Monitoring

• id (path, required) — Registration id of monitoring request record

/api/v1/company/search/name/{country}/{name}

Retrieves a list of companies from the KYC API company index

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars
• name (path, required) — company name
• limit (query, limit) — number of search results

/api/v1/company/{id}/announcements

Retrieves company announcements

• id (path, required) — company hex ID
• limit (query, limit) — limit of announcements in response (default 10)
• offset (query, offset) — to paginate through results (default 0)
• data (query) — If this parameter is set to false, you will only receive ids, and no additional data about announcements and no hits to the metric will be counted. (and potentially minimizing your costs)

/api/v1/company/{id}/super/{country}

Retrieves structured data extracted from a company document

• id (path, required) — company superdata by id
• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars
• lang (query) — Optional data translation (only available in limited jurisdictions)

/api/v1/company/{id}/{dataset}

Retrieves company details

• id (path, required) — company master data by id
• check_stock_listing (query) — Try to retrieve additional stock information for this company. (Only available on refresh)
• dataset (path, required) — company master data by id
• lang (query) — Optional data translation (only available in limited jurisdictions)

/api/v1/ein-verification/basic-check

Verifies an EIN number

• ein (query, required) — Nine letter EIN number with or without hyphens

/api/v1/ein-verification/comprehensive-check

Verifies EIN number and retrieves company data

• ein (query, required) — Nine letter EIN number with or without hyphens

/api/v1/ein-verification/lookup

Retrieves a list of EIN numbers

• name (query, required) — Business name of the company
• state (query) — Optional state parameter to improve results. (Two letter code for example CA or US-CA for California)
• zip (query) — Optional zip code parameter to improve results. (Zip is preferred over state)
• tight (query) — Optional parameter to do tight matching. (Only the best match will be returned rather then the top 5)

/api/v1/iban-verification/check-iban

Checks validity of an IBAN number

/api/v1/iban-verification/comprehensive-check-iban

Checks validity of an IBAN number

/api/v1/nif-verification/basic-check/{country}

Verifies a NIF number

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars

/api/v1/nif-verification/comprehensive-check/{country}

Verifies a NIF number and retrieves company data

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars

/api/v1/pepsanction/monitor/list

Retrieves a list of monitor entries

/api/v1/pepsanction/monitor/unregister/{id}

Deactive a pep sanction monitor

• id (path, required) — The identifier of the Monitor

/api/v1/pepsanction/monitor/update/{id}

Update details of active Pep Sanction monitor

• id (path, required) — The identifier of the Monitor

/api/v1/pepsanction/order/{type}/{search}

Orders a new Pep Sanction Check Report

• type (path, required) — Type (Business or Person) of the requested Pep Sanction Check
• search (path, required) — Search string for the Pep Sanction Check

/api/v1/pepsanction/retrieve/{id}

Returns a json or pdf report

• accept (header) — The type (pdf or json) in which the check should be returned
• id (path, required) — The id of the ordered Pep Sanction Check (id as returned by orderPepSanction call)

/api/v1/product/availability/{sku}/{subjectId}

Retrieves a document availability result

• sku (path, required) — SKU - 9 character value from a Product object
• subjectId (path, required) — Subject (e.g. Company) ID - 32 character hex value

/api/v1/product/catalog/{country}

Returns a catalog of products

• country (path, required) — two letter country code in upper case

/api/v1/product/notifier/{notifierId}

Returns metadata for a notifier

• notifierId (path, required) — ID of the ProductOrderNotifier as returned from a /notifier POST call - 32 character hex value

/api/v1/product/notifier/{orderId}/{type}/{uri}

Creates a notifier for an order

• orderId (path, required) — ID of the ProductOrder as returned from a /product/buy call - 32 character hex value
• type (path, required) — Type of the notifier - indicates the action the notifier will perform. Currently GET and POST are supported which performs an http(s) GET/POST to the supplied uri with appended notifierId= and orderId= parameters when the order processing is completed. Upon the POST request the order object is sent as a JSON body
• uri (path, required) — URI of the notifier for the 'complete' action. Currently only a GET method HTTP(s) URL is supported. 1 to 250 characters long. Every slash in the URI must be replaced by a ~

/api/v1/product/order/concierge

Places a concierge order

/api/v1/product/order/ubo

Places a UBO order

/api/v1/product/order/{sku}/{option}/{subjectId}

Places a product order

• sku (path, required) — SKU - 9 character value from a Product object
• option (path, required) — Product option (e.g. Accounts year) from a previous Availability call
• subjectId (path, required) — Subject (e.g. Company) ID - 32 character hex value

/api/v1/product/order/{sku}/{subjectId}

Places a product order

• sku (path, required) — SKU - 9 character value from a Product object
• subjectId (path, required) — Subject (e.g. Company) ID - 32 character hex value

/api/v1/product/search/{subjectId}

Returns a list of products

• subjectId (path, required) — Subject (e.g. Company) ID - 32 character hex value

/api/v1/product/status/{orderId}

Returns metadata for a order

• orderId (path, required) — ID of the ProductOrder as returned from a /product/buy call - 32 character hex value

/api/v1/product/update/{action}/{orderId}

Updates metadata of an order

• action (path, required) — The action you want to perform for the order
• orderId (path, required) — ID of the ProductOrder as returned from a /product/buy call - 32 character hex value

/api/v1/product/{orderId}

Retrieves the result of an order

• orderId (path, required) — ID of the ProductOrder as returned from a /product/buy call - 32 character hex value

/api/v1/system/countries

Returns a list of countries

/api/v1/system/health

Returns the health information for the official business registers based on usage.

/api/v1/system/pricelist

Returns a list of products with prices

/api/v1/tin-verification/basic-check

Verifies a TIN number

• tin (query, required) — Nine letter TIN number with or without hyphens
• name (query, required) — Company Name

/api/v1/tin-verification/comprehensive-check

EIN Name Lookup with TIN number and retrieves company data

• tin (query, required) — Nine letter TIN number with or without hyphens
• name (query, required) — Company Name
• threshold (query) — The percentage of minimum similarity threshold for company matching (optional, default: 70%)

/api/v1/tin-verification/name-lookup

EIN Name Lookup with TIN number

• tin (query, required) — Nine letter TIN number with or without hyphens

/api/v1/vat-verification/basic-check/{country}

Returns a verification result

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars

/api/v1/vat-verification/comprehensive-check/{country}

Returns a verification result and company data

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars

/api/v1/vat-verification/leveltwo-check/{country}

Returns a level two verification result

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars

/api/v1/vat-verification/lookup/{country}

Returns a list of vat numbers with additional data

• country (path, required) — ISO_3166-1_alpha-2 representation of a country name - 2 chars