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 or province of the business address. Send the form the local registry uses: a two-letter code for the United States, the full province name for Canada.
Postal code of the business address.
Two-letter country code of the business address
The tax or company registration id of the business. Many countries require it and answer 400 when it is missing. Canada takes the Corporations Canada corporation number, a provincial registration number or the CRA business number. The United Arab Emirates takes any value that contains a letter or a digit, because each emirate and free zone issues its own format.
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, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. 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 beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent.
The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field.
Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix.
Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix.
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, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. 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 beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent.
The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field.
Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix.
Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix.
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, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. 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 beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent.
The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field.
Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix.
Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix.
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, present only when the provider had something to qualify. The "tin" entry carries "Tax ID was not found." when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. 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 beneficial owner name from the request that this "ubo_name_match" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent.
The director name from the request that this "directors_name_match" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field.
Carried by the "entityType" entry instead of sub_label: the legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix.
Legal entity type for the matched company, or "Unknown" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix.
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