KausateKausate Docs
Prefill

Pre-fill Company Data

Get company report data for form pre-filling (indexed with real-time fallback).

POST
/v2/companies/{kausateId}/prefill
X-API-Key<token>

Sign up at Kausate.com to get an API key

In: header

Path Parameters

kausateId*string

Company ID

Header Parameters

X-Partner-Customer-Id?|

Optional partner customer ID

Request Body

application/json

customerReference?|

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.kausate.com/v2/companies/string/prefill" \  -H "Content-Type: application/json" \  -d '{}'
{
  "orderId": "co_de_4JFFrsbQ99t1nmRw2JgzmG-report-org_01ABC-20240319143022",
  "customerReference": "my-ref-123",
  "status": "completed",
  "requestTime": "2024-03-19T14:30:22.787045Z",
  "responseTime": "2024-03-19T14:32:45.108791Z",
  "result": {
    "type": "companyReport",
    "companyReport": {
      "basicInformation": {
        "legalName": "Example Solutions GmbH",
        "type": "organization"
      }
    }
  }
}
{
  "detail": "Invalid company ID format"
}
{
  "detail": "Invalid API key"
}
{
  "detail": "Insufficient credits. Required: 10, Available: 5"
}
{
  "detail": "Company not found"
}
{
  "detail": "Request timed out after 300 seconds. The workflow may still be running in the background."
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
{
  "detail": "An internal error occurred"
}

Last updated on