POST
/
KYB
/
search
Search Companies
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/KYB/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "search": "<string>",
  "registrationNumber": "<string>",
  "countryNames": [
    "<string>"
  ],
  "searchType": "<string>",
  "webhookUrl": "<string>"
}'
{
  "requestId": "<string>",
  "companyId": "<string>",
  "serviceId": "<string>"
}
For a usage description of the KYB Search Service, please refer to the KYB page.

Endpoint

POST /KYB/search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Company name or partial name.

countryNames
string[]
required

List of country names to search within.

searchType
string
required

Type of search (e.g., start_with).

registrationNumber
string

Registration number (optional).

webhookUrl
string<uri>

Response

Successfully initiated company search.

requestId
string
companyId
string
serviceId
string