Trigger a KYB run (by external ID)
Starts a KYB run for a business customer addressed by your source’s customer externalId. Without a body the run uses the customer’s current version and its currently available ingested documents; related parties and provider evidence carry forward from the customer’s latest KYB dossier. Status is derived from the run and its Case: pending (queued), running, needs_review (finished with open issues for an analyst), completed (finished without open issues), or failed. Only customers owned by the calling ingestion source are visible.
Authorizations
Source-bound WorkOS API key or configured machine OIDC token. OIDC webhook management requires karsa:webhooks:manage.
Headers
Stable source submission identifier, unique for this source and route
1 - 200"01J9ZQ2YD15Y2YZ5H0W3J7D3E2"
Path Parameters
The customer externalId your ingestion source supplied
1Body
1 - 50 elementsResponse
The KYB run was queued. The Location header names the run; replaying the same Idempotency-Key and body returns this response again.
1pending, running, needs_review, completed, failed 111