POST
/
KYB
/
search
curl --request POST \
  --url https://api-umbrella.io/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
​
search
string
required

The search query for the company name.

​
countryNames
string[]
required

List of country names to search within.

​
searchType
string
required

The type of search to perform.

​
registrationNumber
string

The registration number of the company (optional).

​
webhookUrl
string

URL for receiving webhook notifications (optional).

Response

200
application/json
Successfully initiated company search.
​
requestId
string

Unique identifier for the request.

​
companyId
string

Unique identifier for the company.

​
serviceId
string

Unique identifier for the service.