API reference · eKYB

Get eKYB session data for the current session

GET/omni/externalVerification/ekyb/session

Base URL: https://demo-api.incodesmile.com — Incode demo environment

Returns stored eKYB verification request/response data for the interview associated with the caller's session token. Intended for downstream onboarding steps (e.g. the business watchlist screen) to reuse data the user already entered on the eKYB form, such as businessName, country and taxId, without requiring an executive token.

Path & query parameters

Name In Type Required Description
api-version header string yes

Responses

200

OK

Response body (application/json):

Field Type Required Description
requestData BusinessVerificationRequestData
requestData.plugins array[string]
requestData.businessName string
requestData.address string
requestData.addressLine1 string
requestData.street string
requestData.houseNo string
requestData.addressLine2 string
requestData.city string
requestData.state string
requestData.postalCode string
requestData.country string Enum: US, BR, CA, CN, UK, GB, DE, FR, RO, ES, IT, IL, AR, IE, JP, SE, NO, VN, NL, NG, KE, CM, HK, IN, MX, DK, BG, MT, LT, KM, TR, EG, AE, SA, AU
requestData.taxId string
requestData.uboNames array[string]
requestData.directors array[string]
verificationResult BusinessVerificationResultData
verificationResult.businessName string
verificationResult.businessClassification string
verificationResult.addressVerification string
verificationResult.cityVerification string
verificationResult.postalCodeVerification string
verificationResult.addressPropertyType string
verificationResult.addressDeliverability string
verificationResult.tinVerification string
verificationResult.uboNameMatch string
verificationResult.registrationStatus string Enum: Active, Inactive, Unknown
verificationResult.entityType EntityTypeData
verificationResult.entityType.entityType string
verificationResult.uboNameVerificationResults array[UboNameVerificationResultData]
verificationResult.uboNameVerificationResults.name string
verificationResult.uboNameVerificationResults.uboNameMatch string
verificationResult.uboNameVerificationResults.matchId string
verificationResult.uboNameVerificationResults.ownershipPercentage string
verificationResult.directorsVerificationResults array[UboNameVerificationResultData]
verificationResult.directorsVerificationResults.name string
verificationResult.directorsVerificationResults.uboNameMatch string
verificationResult.directorsVerificationResults.matchId string
verificationResult.directorsVerificationResults.ownershipPercentage string
verificationResult.people array[PeopleData]
verificationResult.people.name string
verificationResult.people.titles array[TitleData]
verificationResult.people.titles.title string
verificationResult.people.memberType string
verificationResult.verificationMessages VerificationMessages
verificationResult.verificationMessages.tinVerificationMessage string
externalVerificationThirdPartyRequest object
externalVerificationThirdPartyResponse object

400

Bad Request

Response body (application/json):

Field Type Required Description
timestamp integer (int64) UTC timestamp in milliseconds
status integer (int32) Custom error code or HTTP status code
error string HTTP status error
message string Custom error message
path string Endpoint path
details object Custom error details
Was this page helpful?