Documentation

Partner API

Create governed cases from your systems.

This reference is generated from Clarivy’s live partner contract. Credentials are scoped by tenant and use case; secrets are never embedded in this page.

Credential guide OpenAPI JSON

Quick start

One credential. One stable request. One case.

  1. 1

    Create a service credential

    Use one key per source system and environment. Scope it to case.create and the approved workflows.

  2. 2

    Store the secret once

    Move the one-time secret directly into the calling system’s managed secret store.

  3. 3

    POST the case

    Send the business facts, bearer credential and a stable Idempotency-Key.

Minimum request
curl --request POST \
  'https://app.clarivy.pro/api/integrations/v1/cases' \
  --header 'Authorization: Bearer <service-key>' \
  --header 'Idempotency-Key: <stable-unique-request-id>' \
  --header 'Content-Type: application/json' \
  --data '{
    "reference": "LOS-2026-000184",
    "title": "Merchant eligibility review",
    "purpose": "Assess approved SME lending controls.",
    "use_case": "merchant_eligibility",
    "subject_name": "Example Merchant LLC",
    "subject_type": "legal_entity",
    "legal_basis": "contract_performance",
    "jurisdiction": "AE",
    "retention_days": 180
  }'

Base URL

https://app.clarivy.pro/api

Idempotent replay

The same key and payload return the original result. The same key with a changed payload returns a conflict.

Authority boundary

Do not send tenant, policy version, owner or audit actor fields. Clarivy derives them from the service credential and published workflow.

Error handling

Retry temporary failures with the same idempotency key. Correct permanent authorization or validation failures before sending another request.

StatusMeaningCaller action
400Missing idempotency key.Add one stable key for the logical operation.
401Invalid, expired or revoked credential.Stop retries and restore authorization.
403Credential lacks the workflow scope.Request an administrator scope review.
409Duplicate reference or idempotency mismatch.Reconcile using the original request identifier.
422Payload does not satisfy the schema.Correct the request; do not retry unchanged.
5xxTemporary service or dependency failure.Retry with the same key and bounded backoff.

Live contract

Interactive API reference

Generated from the deployed public OpenAPI schema. Administrative and internal review routes are deliberately excluded.

Paths, field names, enum values and code examples remain in their canonical API form so integrations behave consistently in every language.