Verifies a business against official registries and other sources. The caller picks the modules to run:
identity: tax ID and business name matchaddress: registered address matchstatusEntityType: registration status and legal formpersonAssociation: people associated with the business (officers and directors; outside the US also shareholders, which can be companies, and persons with significant control), and a match for each name inpersonNameswebPresence: social profiles, websites, phone numbers and emailswebsiteAnalysis: domain age and TLS certificate of the websiteindustryInfo: industry classification and risk levelfinancialIntelligence: liens, litigation, bankruptcy and credit informationgroupStructure: parent, subsidiary and affiliated companies
Module availability depends on the country and on how the organization is configured.
Every requested module appears in the response. The supported modules run normally. A
module that is not supported for the country returns an error object with status
notSupported in place of its data, and the request still succeeds. A module that ran
but could not produce a result also returns an error object in place of its data.
In an onboarding session, GET /omni/kyb/form returns a ready-to-render form for this request,
with the fields each country needs.
Match fields use these values: verified (exact or near-exact match),
approximateMatch (close match), unverified (did not match, or could not be checked) and notFound (no
record found). A module error can also have the status notSupported.
Every response carries a referenceId. Some modules (webPresence, websiteAnalysis,
industryInfo, financialIntelligence) may not finish before the response is returned.
When that happens they are listed in pendingModules. Every run ends with exactly one
KYB_RESULT webhook, carrying referenceId and the final result. The final result is
also available from GET /omni/verification/async/{referenceId}.