API referenceeKYB

EkybChecks Modular Business Verification

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

Composable KYB endpoint. Clients specify which modules they need and Incode routes to the correct vendor for the country. Available modules: identity, address, statusEntityType, personAssociation, webPresence, websiteAnalysis, industryInfo, financialIntelligence. Every response carries a referenceId, and every run ends with one EKYB_CHECKS_RESULT webhook carrying the final result (also pollable at GET /omni/verification/async/{referenceId}). webPresence/websiteAnalysis/industryInfo/financialIntelligence may not finish within the synchronous response's wait budget; those are listed in pendingModules and the webhook follows once they resolve.

Headers

api-versionstringrequiredDefaults to 1.0

Request body

application/json

pluginsarray[string]

countrystringrequired≥ 1 chars

ISO 3166-1 alpha-2 country code

taxIdstring

Tax ID or company registration number

businessNamestring

Registered legal name of the business

streetstring

Street address

citystring

City

statestring

State / province

postalCodestring

Postal code / ZIP

personNamesarray[string]

Names of persons to verify association with the business (PERSON_ASSOCIATION module). Each name is matched against the business officer/director registry; one result per name is returned.

websitestring

Business website URL

alternativeNamesarray[string]

Alternative or trade names for the business

phoneNumberstring

Business phone number

emailstring

Business email address

modulesarray[string]

enumidentityaddressstatusEntityTypepersonAssociationwebPresencewebsiteAnalysisindustryInfofinancialIntelligence

Responses

Response body (application/json)

pendingModulesarray[string]

enumidentityaddressstatusEntityTypepersonAssociationwebPresencewebsiteAnalysisindustryInfofinancialIntelligence

referenceIdstring

emptyboolean