Places a UBO order

POST

/api/v1/product/order/ubo

v1-product

Place an order for a UBO (ultimate beneficial owner) discovery report

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.kompany.com//api/v1/product/order/ubo' \
--data-urlencode 'subjectId=null'

Response Example

200 - Example 1

{}

Request

Body Params application/x-www-form-urlencoded

callbackUrl

string

optional

An optional callback URL to which updates about the order will be sent (for instance if credits are exceeded)

Example:

null

credits

number

optional

Specify a maximum amount of credits which should be used. To disable use -1

Example:

-1

includeDocs

string

optional

Include purchase of register document to ubo report

levels

string

optional

Define a threshold for different levels of crawling

Example:

25,50

strategy

string

optional

Choose a matching strategy. Available options (FULL,LEVELS)

Example:

FULL

subjectId

string

required

KYC API Id (32 byte hexid) of the company you want to place the order for

Example:

null

Responses

🟢200Success

application/json

Body

object {0}

🔴500500

Places a concierge order

Places a product order