Integrations
Connect your own register login so that your orders in that register run under it
For most registers your Kausate API key is all you need. A few registers grant access only to a named company or person, so there you connect your own login with that register as an integration, and we sign in as you. A jurisdiction page says under Coverage at a glance whether a register needs one, which capabilities it unlocks (they show as Credentialed) and which fields the register expects.
Store the credentials
Send them to Create Integration with the datasource and the fields from the jurisdiction page:
curl -X POST "https://api.kausate.com/v2/integrations" \
-H "X-API-Key: $API_KEY" \
-H "Kausate-Version: 2026-08-01" \
-H "Content-Type: application/json" \
-d '{
"datasourceSlug": "de-transparenzregister",
"secretValues": {
"email": "registered-company@example.com",
"password": "the-account-password"
}
}'The response does not include the values:
{
"datasourceSlug": "de-transparenzregister",
"datasourceName": "Transparenzregister",
"createdAt": "2026-06-06T10:00:00Z",
"updatedAt": "2026-06-06T10:00:00Z"
}Credential values are write-only: no endpoint returns them. Manage them with List, Update to rotate a password, and Delete.
Keep several customers apart
If you act for several end customers, store each customer's login under a
customerId:
curl -X POST "https://api.kausate.com/v2/integrations?customerId=acme-bank" \
-H "X-API-Key: $API_KEY" \
-H "Kausate-Version: 2026-08-01" \
-H "Content-Type: application/json" \
-d '{
"datasourceSlug": "de-transparenzregister",
"secretValues": { "email": "kyb@acme-bank.example", "password": "..." }
}'customerId must be URL-safe (letters, numbers, dashes, underscores) and at
most 150 characters. Omit it to store one set for your whole organization,
used for every call.
Call with those credentials
Send the customerId in the X-Customer-Id header. It selects the credential
set and scopes the order to that customer:
curl -X POST "https://api.kausate.com/v2/companies/ubo" \
-H "X-API-Key: $API_KEY" \
-H "Kausate-Version: 2026-08-01" \
-H "X-Customer-Id: acme-bank" \
-H "Content-Type: application/json" \
-d '{ "kausateId": "co_de_4JFFrsbQ99t1nmRw2JgzmG" }'Send the same header when you poll the order. Omit it to use the credentials stored for your whole organization.
Check that it worked
List integrations shows the
datasource with its updatedAt. A call to a Credentialed capability with no
credentials stored returns an error; see Errors.
Related
- Jurisdiction coverage: what Credentialed and the other statuses mean.
- Sync and async: polling an order.
Last updated on