Skip to main content
POST

Authorizations

Authorization
string
header
required

Source-bound WorkOS API key or configured machine OIDC token. OIDC webhook management requires karsa:webhooks:manage.

Headers

Idempotency-Key
string
required

Stable source submission identifier, unique for this source and route

Required string length: 1 - 200
Example:

"01J9ZQ2YD15Y2YZ5H0W3J7D3E2"

Body

application/json
externalId
string
required
Required string length: 1 - 200
provider
string
required
Required string length: 1 - 200
providerRecordId
string
required
Required string length: 1 - 200
observationType
enum<string>
required
Available options:
VERIFICATION,
SCREENING,
ALERT,
ERROR
scope
enum<string>
required
Available options:
KYC,
KYB,
FRAUD,
AML,
TRANSACTION_MONITORING,
BLOCKCHAIN_SCREENING,
OTHER
sourceStatus
string
required
Required string length: 1 - 200
normalizedResult
enum<string>
required
Available options:
CLEAR,
MATCH,
REVIEW,
DECLINED,
ERROR,
UNKNOWN
effectiveAt
string<date-time>
required
providerProduct
string | null
Required string length: 1 - 200
providerApiVersion
string | null
Required string length: 1 - 200
providerExecutionId
string | null
Required string length: 1 - 200
alertLifecycle
enum<string>
default:UNKNOWN
Available options:
OPEN,
ACKNOWLEDGED,
CLOSED,
UNKNOWN
severity
string | null
Required string length: 1 - 200
score
string | null
Pattern: ^-?(?:0|[1-9]\d{0,34})(?:\.\d{1,30})?$
scoreScale
string | null
Required string length: 1 - 200
ruleId
string | null
Required string length: 1 - 200
ruleName
string | null
Required string length: 1 - 200
ruleVersion
string | null
Required string length: 1 - 200
categories
string[]
Maximum array length: 50
Required string length: 1 - 200
customerId
string | null
Required string length: 1 - 200
accountId
string | null
Required string length: 1 - 200
transactionId
string | null
Required string length: 1 - 200
Maximum array length: 100
providerObservedAt
string<date-time> | null
artifactHash
string | null
Pattern: ^[a-f0-9]{64}$
providerDetails
object | null
documents
object[]
Maximum array length: 25

Response

The identical source observation already exists

outcome
enum<string>
required
Available options:
CREATED,
EXISTING
resourceId
string
required
Minimum string length: 1
observedAt
string<date-time>
required