API reference, eKYB

EkybChecks Modular Business Verification

POSThttps://demo-api.incodesmile.com/omni/kyb

Verifies a business against official registries and other sources. The caller picks the modules to run:

  • identity: tax ID and business name match
  • address: registered address match
  • statusEntityType: registration status and legal form
  • personAssociation: 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 in personNames
  • webPresence: social profiles, websites, phone numbers and emails
  • websiteAnalysis: domain age and TLS certificate of the website
  • industryInfo: industry classification and risk level
  • financialIntelligence: liens, litigation, bankruptcy and credit information
  • groupStructure: 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}.

Headers

api-versionstringrequiredDefaults to 1.0

Request body

application/json

pluginsarray[string]
countrystringrequired≥ 1 chars

Country of registration, ISO 3166-1 alpha-2. "UK" is accepted for GB.

taxIdstring

Tax ID or company registration number. In the United States: 1 to 20 letters, digits, spaces or hyphens; required by the identity module.

businessNamestring

Registered legal name of the business. In the United States, required by the identity, address, webPresence, websiteAnalysis and industryInfo modules.

streetstring

Street address

citystring

City. In the United States, required by the address, webPresence, websiteAnalysis and industryInfo modules.

statestring

State or province. In the United States, required by the address, webPresence, websiteAnalysis and industryInfo modules.

postalCodestring

Postal code / ZIP

personNamesarray[string]

Names to check against the people associated with the business (personAssociation module). One personMatches entry is returned per name.

websitestring

Business website URL

alternativeNamesarray[string]

Alternative or trade names for the business

phoneNumberstring

Business phone number

emailstring

Business email address

modulesarray
enumidentityaddressstatusEntityTypepersonAssociationwebPresencewebsiteAnalysisindustryInfofinancialIntelligencegroupStructure

Responses

no body