Skip to main content
POST
Register an item with KRA

Authorizations

x-api-key
string
header
required

Your API key, for example cmp_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx. Create one on the Integrations page of the compliance dashboard.

Path Parameters

id
string
required

The item id.

Body

application/json
branchId
string

The branch to register the item for. Accepts the branch id or its kraBhfId. Defaults to the business's first branch.

force
boolean

Set true to register again an item KRA already has.

businessId
string

The business to act for. Required for organisation-wide keys; omit it for a business-bound key. List the ids you can use with GET /v1/businesses.

Response

The item, now REGISTERED.

data
object
required