This endpoint performs an eKYB check for the business specified
API reference, eKYB
eKYB
POST
https://demo-api.incodesmile.com/omni/externalVerification/ekybHeaders
Request body
application/json
Name of the business
Address line 1 of the business
Street name of the business address
The exterior number of the business address
Address line 2 of the business
City of the business address.
State of the business address.
Postal code of the business address.
Two-letter country code of the business address
The tax id of the business
Ultimate Beneficial Owner name. Deprecated — use uboNames instead.
Ultimate Beneficial Owners names
Names of the directors of the business
Responses
Response body (application/json)
The name of test
Whether the test ows passed.
Additional info on the status.
Human readable description of the status.
Machine-readable qualifiers for this check. The "tin" entry carries "Tax ID was not found." when the vendor returned no company for the supplied identifier; otherwise it carries exactly one of REGNO or VATNO, naming the identifier class the lookup resolved through. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational.
The name of test
Whether the test ows passed.
Additional info on the status.
Human readable description of the status.
Machine-readable qualifiers for this check. The "tin" entry carries "Tax ID was not found." when the vendor returned no company for the supplied identifier; otherwise it carries exactly one of REGNO or VATNO, naming the identifier class the lookup resolved through. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational.
Only present on a 202 async dispatch: PENDING until the verification finishes and the result is delivered via the EKYB_VERIFICATION_RESULT webhook.
enum
PENDINGCOMPLETEDFAILEDOnly present on a 202 async dispatch: id correlating the webhook notification and the result-poll endpoint with this request.
Response body (application/json)
The name of test
Whether the test ows passed.
Additional info on the status.
Human readable description of the status.
Machine-readable qualifiers for this check. The "tin" entry carries "Tax ID was not found." when the vendor returned no company for the supplied identifier; otherwise it carries exactly one of REGNO or VATNO, naming the identifier class the lookup resolved through. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational.
The name of test
Whether the test ows passed.
Additional info on the status.
Human readable description of the status.
Machine-readable qualifiers for this check. The "tin" entry carries "Tax ID was not found." when the vendor returned no company for the supplied identifier; otherwise it carries exactly one of REGNO or VATNO, naming the identifier class the lookup resolved through. The "ubo_name_match" entry carries NO_SHAREHOLDER_DATA, and "directors_name_match" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An "Unverified" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational.
Only present on a 202 async dispatch: PENDING until the verification finishes and the result is delivered via the EKYB_VERIFICATION_RESULT webhook.
enum
PENDINGCOMPLETEDFAILEDOnly present on a 202 async dispatch: id correlating the webhook notification and the result-poll endpoint with this request.
Response body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details