Skip to main content
POST
/
kyb
/
screen
Screen company & officers
curl --request POST \
  --url https://api.txcloud.io/v1/kyb/screen \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": "<string>",
  "watchlists": [
    "<string>"
  ],
  "include_directors": true,
  "include_ubos": true
}
'
{
  "id": "<string>",
  "overall_status": "<string>",
  "company": {},
  "directors": [
    {}
  ],
  "ubos": [
    {}
  ],
  "summary": {}
}

Authorizations

Authorization
string
header
required

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

Body

application/json
company_id
string
watchlists
string[]
include_directors
boolean
include_ubos
boolean

Response

200 - application/json

Screening result

id
string
overall_status
string
company
object
directors
object[]
ubos
object[]
summary
object