KYB Search Service - IdCanopy API Documentation

curl --request POST \ --url https://api-umbrella.io/api/services/kyb/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "IDCanopy Group Ltd", "country": "GB", "locality": "London" } '

{ "status": true, "data": [ { "transactionId": "a8b89ef3-9d93-4d96-a495-be605fd1b2fe", "companyId": "223c8dde-9c82-4811-ba3c-4f9fe648c2da", "name": "IDCANOPY GROUP LTD", "status": "active", "registrationNumber": "16262990", "addressLine": "71-75 Shelton Street, Covent Garden, London, United Kingdom, WC2H 9JQ", "country": "GB" } ] }

Endpoint

POST /kyb/search

Authorizations

Authorization

string

header

required

Bearer token obtained from POST /auth. Valid for 60 minutes.

Body

application/json

Option 1
Option 2

name

string

required

Company name. Fuzzy matching applied.

Example:

"IDCanopy Group Ltd"

country

string

required

ISO 3166-1 alpha-2 country code.

Example:

"GB"

companyNo

string

Official registration number. Exact match.

Example:

"16262990"

locality

string

City or locality to narrow results.

Example:

"London"

Response

200 - application/json

One or more matching companies.

status

boolean

true on success.

data

object[]

Show child attributes

​Endpoint

Authorizations

Body

Response

Endpoint