Upload a native AiPrise verification response

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

effectiveAt

string<date-time>

required

scope

enum<string>

required

Available options:

KYC,

KYB

response

object

required

Hide child attributes

response.verification_session_id

string

required

Required string length: 1 - 200

response.template_id

string

required

Required string length: 1 - 200

response.created_at

required

Required range: 0 <= x <= 8640000000000000

response.status

string

required

Required string length: 1 - 200

response.aiprise_summary

object

required

Hide child attributes

response.aiprise_summary.verification_result

string

Required string length: 1 - 200

response.aiprise_summary.decision

string

Required string length: 1 - 200

response.client_reference_id

string

Required string length: 1 - 200

Maximum array length: 500

Hide child attributes

Maximum array length: 500

Hide child attributes

response.aml_info

object

Hide child attributes

response.aml_info.{key}

any

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

Hide child attributes

Available options:

CUSTOMER,

ACCOUNT,

TRANSACTION

Required string length: 1 - 200

providerObservedAt

string<date-time> | null

artifactHash

string | null

Pattern: ^[a-f0-9]{64}$

documents

object[]

Maximum array length: 25

Hide child attributes

documents.documentVersionId

string

required

Required string length: 1 - 200

documents.role

string

required

Required string length: 1 - 200

documents.roleDetail

string | null

Required string length: 1 - 200

providerApiVersion

string | null

Required string length: 1 - 200

Response

The identical source AiPrise screening observation already exists

outcome

enum<string>

required

Available options:

CREATED,

EXISTING

resourceId

string

required

Minimum string length: 1

observedAt

string<date-time>

required

Customers

Verifications

Accounts

Documents

Transactions

Sources

Outcomes

Screening

Controls

Requests

Webhooks

Upload a native AiPrise verification response

Authorizations

Headers

Body

Response