> ## Documentation Index > Fetch the complete documentation index at: https://docs.useasterisk.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Document only operations in the linked OpenAPI contract: the source-data ingestion operations and the source-scoped outbound webhook management operations. > Treat the generated OpenAPI document as authoritative for request fields. Never invent compatibility fields, alternate endpoints, or additional source models. > Preserve explicit nulls, decimal strings, timestamps, source identifiers, immutable version identifiers, and document-version links exactly as defined. # Submit a document > Submit exactly one of contentBase64 or sourceUrl. Bytes are stored immediately; HTTP(S) URLs are retained verbatim as PENDING_DOWNLOAD references without fetching or signing. URL acceptance does not establish file availability. contentType describes the declared file type. ## OpenAPI ````yaml /openapi/ingestion.openapi.yaml post /api/ingestion/documents openapi: 3.1.0 info: title: Karsa Data Ingestion API version: current description: >- Source-bound writes for documents, business onboardings, customers, kyb-dossiers, accounts, transactions, outcomes, screening observations, screening dispositions, monitoring controls, monitoring control executions, historical RFI events, source checkpoints, native SEON screening observations, native AiPrise screening observations, and native Chainalysis screening observations. servers: - url: https://api.sandbox.useasterisk.com description: Karsa sandbox API (synthetic test data) - url: https://api.useasterisk.com description: Karsa production API security: [] tags: - name: Customers description: >- Create and version individual or business customer records, including atomic business onboarding where every beneficial owner is an individual Customer. - name: Verifications description: >- Submit immutable customer evidence snapshots for KYC or KYB evaluation, or start a KYB run for a business customer and poll its status. - name: Accounts description: >- Create and version customer-linked bank accounts, virtual accounts, and wallets without coupling the contract to a provider. - name: Documents description: Submit immutable document bytes or URL references and metadata. - name: Transactions description: Create and version money-movement records. - name: Sources description: >- Record source-attested, append-only completeness checkpoints used to qualify downstream evidence windows. - name: Outcomes description: >- Record source outcomes against customers, accounts, transactions, or documents. - name: Screening description: >- Submit provider-neutral verification, screening, alert, and reviewer-disposition evidence for Routine 6 qualification. - name: Controls description: >- Submit the source-owned monitoring control catalog and immutable execution evidence used to assess control coverage. - name: Requests description: >- Submit immutable historical request-for-information lifecycle events used to measure repeat requests and expiry. - name: Webhooks description: >- Manage source-scoped outbound destinations, receive later KYB evaluation lifecycle changes, and list recorded events to catch up on missed deliveries. paths: /api/ingestion/documents: post: tags: - Documents summary: Submit a document description: >- Submit exactly one of contentBase64 or sourceUrl. Bytes are stored immediately; HTTP(S) URLs are retained verbatim as PENDING_DOWNLOAD references without fetching or signing. URL acceptance does not establish file availability. contentType describes the declared file type. operationId: ingestDocument parameters: - schema: type: string minLength: 1 maxLength: 200 description: >- Stable source submission identifier, unique for this source and route example: 01J9ZQ2YD15Y2YZ5H0W3J7D3E2 required: true name: Idempotency-Key in: header requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentWrite' examples: request: value: externalId: document-example-001 sourceExternalId: null documentType: GOVERNMENT_ID displayName: Identity card front contentType: image/jpeg contentBase64: a2Fyc2E= effectiveAt: '2026-08-21T12:00:00.000Z' changeReason: null responses: '200': description: A new immutable version was appended to an existing identity content: application/json: schema: $ref: '#/components/schemas/IngestionResponse' examples: success: value: outcome: VERSION_CREATED resourceId: document_resource_example_01 versionId: document_version_example_01 currentVersionId: document_version_example_01 '201': description: The stable identity and first immutable version were created content: application/json: schema: $ref: '#/components/schemas/IngestionResponse' examples: success: value: outcome: CREATED resourceId: document_resource_example_01 versionId: document_version_example_01 currentVersionId: document_version_example_01 '400': description: 'INVALID_REQUEST: The request did not match the ingestion schema' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: INVALID_REQUEST: value: type: https://karsa.app/problems/invalid-request title: Ingestion Rejected status: 400 detail: The request did not match the ingestion schema code: INVALID_REQUEST requestId: req_example_01 '401': description: >- AUTHENTICATION_REQUIRED: A source-bound bearer credential is required content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: AUTHENTICATION_REQUIRED: value: type: https://karsa.app/problems/authentication-required title: Ingestion Rejected status: 401 detail: A source-bound bearer credential is required code: AUTHENTICATION_REQUIRED requestId: req_example_01 '404': description: 'RESOURCE_NOT_FOUND: A referenced source resource was not found' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: RESOURCE_NOT_FOUND: value: type: https://karsa.app/problems/resource-not-found title: Ingestion Rejected status: 404 detail: A referenced source resource was not found code: RESOURCE_NOT_FOUND requestId: req_example_01 '409': description: 'SOURCE_IDENTITY_CONFLICT: The source identity is already bound' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: SOURCE_IDENTITY_CONFLICT: value: type: https://karsa.app/problems/source-identity-conflict title: Ingestion Rejected status: 409 detail: The source identity is already bound code: SOURCE_IDENTITY_CONFLICT requestId: req_example_01 '422': description: 'FUTURE_EFFECTIVE_AT: Future-effective scheduling is not supported' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: FUTURE_EFFECTIVE_AT: value: type: https://karsa.app/problems/future-effective-at title: Ingestion Rejected status: 422 detail: Future-effective scheduling is not supported code: FUTURE_EFFECTIVE_AT requestId: req_example_01 '429': description: 'RATE_LIMITED: The ingestion source exceeded its configured rate' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: RATE_LIMITED: value: type: https://karsa.app/problems/rate-limited title: Ingestion Rejected status: 429 detail: The ingestion source exceeded its configured rate code: RATE_LIMITED requestId: req_example_01 '500': description: >- INGESTION_INTERNAL_ERROR: The ingestion request could not be completed content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: INGESTION_INTERNAL_ERROR: value: type: https://karsa.app/problems/ingestion-internal-error title: Ingestion Unavailable status: 500 detail: The ingestion request could not be completed code: INGESTION_INTERNAL_ERROR requestId: req_example_01 security: - ingestionBearer: [] components: schemas: DocumentWrite: anyOf: - type: object properties: externalId: type: string minLength: 1 maxLength: 200 sourceExternalId: type: - string - 'null' minLength: 1 maxLength: 200 effectiveAt: type: string format: date-time changeReason: type: - string - 'null' minLength: 1 maxLength: 500 documentType: type: - string - 'null' minLength: 1 maxLength: 200 displayName: type: - string - 'null' minLength: 1 maxLength: 500 contentType: type: string minLength: 1 maxLength: 200 contentBase64: type: string minLength: 1 maxLength: 16777216 required: - externalId - effectiveAt - documentType - displayName - contentType - contentBase64 additionalProperties: false - type: object properties: externalId: type: string minLength: 1 maxLength: 200 sourceExternalId: type: - string - 'null' minLength: 1 maxLength: 200 effectiveAt: type: string format: date-time changeReason: type: - string - 'null' minLength: 1 maxLength: 500 documentType: type: - string - 'null' minLength: 1 maxLength: 200 displayName: type: - string - 'null' minLength: 1 maxLength: 500 contentType: type: string minLength: 1 maxLength: 200 sourceUrl: type: string minLength: 1 maxLength: 8192 format: uri pattern: ^[hH][tT][tT][pP][sS]?:\/\/[^\\/@#?\s]+(?:[/?][^\\#\s]*)?$ description: >- Absolute HTTP(S) document reference, signed or unsigned. No embedded credentials, fragments, whitespace, or backslashes. Retained verbatim; not fetched or signed during ingestion. required: - externalId - effectiveAt - documentType - displayName - contentType - sourceUrl additionalProperties: false IngestionResponse: type: object properties: outcome: type: string enum: - CREATED - VERSION_CREATED resourceId: type: string minLength: 1 versionId: type: string minLength: 1 currentVersionId: type: - string - 'null' minLength: 1 required: - outcome - resourceId - versionId - currentVersionId additionalProperties: false Problem: type: object properties: type: type: string minLength: 1 title: type: string minLength: 1 status: type: integer detail: type: string minLength: 1 code: type: string minLength: 1 requestId: type: string minLength: 1 existingRunId: type: string minLength: 1 issues: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false maxItems: 20 required: - type - title - status - detail - code - requestId additionalProperties: false securitySchemes: ingestionBearer: type: http scheme: bearer description: >- Source-bound WorkOS API key or configured machine OIDC token. OIDC webhook management requires karsa:webhooks:manage. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.