CompanySearchPublicApiResource

Changed on
post/resources/api/companies/{applicantId}/search/fetch

Request

  • Base URL: https://api.sumsub.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.sumsub.com/resources/api/companies/{applicantId}/search/fetch
  • Auth: none declared

Path parameters

applicantIdstring required

Request body

searchItemIdstring

Response

default response

alternativeNamesstring[]
applicantPositionstring
companyNamestring

The name of the company.

companyNameEnstring
controlSchemestring

Description of the control scheme of the company ownership or group of entities.

countrystring

Alpha-3 code of the country where the company is legally registered (for example, DEU, GBR, ARG, and so on).

emailstring

Company email address.

incorporatedOnstring date-time

The date of company incorporation (format YYYY-mm-dd, e.g. 2001-09-25).

legalAddressstring

The address a legal entity uses to register with a legal authority.

legalFormstring
leiCodestring
licenseNumberstring
noDirectorsboolean
noDocsboolean
noRepresentativesboolean
noShareholdersboolean

When set to true, a company is to be verified with no shareholders specified in the company profile. For example, in case when the verification level settings require a company to have three shareholders but the company has just one.

noUBOsboolean

When set to true, a company is to be verified with no UBOs specified in the company profile. For example, in case when another legal entity that cannot be a UBO owns this company.

ownershipStructureDepthinteger
phonestring

Company phone number.

postalAddressstring

Company postal address.

primaryContactBeneficiaryIdstring
registrationLocationstring

City, town, or another location where the company was registered.

registrationNumberstring

Unique number assigned to the company when it was registered as a legal entity.

skippedTypesCompanyBeneficiaryType[]
taxIdstring

Taxpayer registration number/Code of taxpayer registration.

typestring

Type of legal entity. For example, Private Company Limited by Shares, Public Limited Company, Limited Partnership, and so on.

websitestring

Website URL of the company.

Changes

  • 45b265a2523bRevision changes
    • warning

      added the new legal enum value to the /// response property for the response status

    • warning

      added the new postal enum value to the /// response property for the response status

    • warning

      added the new trade enum value to the /// response property for the response status

  • fbd3666b9f07Revision changes
    • info

      added the optional property /// to the response with the status