v1

latestOpenAPI 3.1.02026-07-241460559.8 KB

Search companies for applicant

post/resources/api/companies/{applicantId}/search

Path parameters

applicantIdstring required

Unique identifier of the company applicant in the Sumsub system. <br><br>This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant profile is created on the Sumsub side, and can be found in the Dashboard. <br><br>If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Query parameters

offsetinteger

Offset of the companies to return. The value cannot exceed 100.

limitinteger

Maximum number of companies to return. The value must be greater than 0 and cannot exceed 10.

Request body

countrystring

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

statestring

Two-letter code representing a state, province, region, jurisdiction, or similar administrative area.

⚠️ Applicable to the USA and Canada.

companyNamestring

Name of the company. Maximum length: 250 characters.

⚠️ The set of input search parameters varies depending on the connected sources.

numberstring

Registration or identification number of the company. Maximum length: 100 characters.