> ## 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 KYB dossier > Records one complete source snapshot for an existing business Customer version and queues its KYB evaluation. ## OpenAPI ````yaml /openapi/ingestion.openapi.yaml post /api/ingestion/kyb-dossiers 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/kyb-dossiers: post: tags: - Verifications summary: Submit a KYB dossier description: >- Records one complete source snapshot for an existing business Customer version and queues its KYB evaluation. operationId: ingestKybDossier 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/KybDossierSubmission' examples: request: value: customerVersionId: customer_version_example_01 sourceVersion: provider-kyb-001 sourceEffectiveAt: '2026-08-21T12:00:00.000Z' relatedParties: [] relationships: [] documents: [] providerEvidence: [] responses: '200': description: >- The identical source dossier and its existing workflow run were returned content: application/json: schema: $ref: '#/components/schemas/KybDossierSubmissionResponse' examples: success: value: dossierId: kyb_dossier_example_01 customerVersionId: customer_version_example_01 workflowRunId: workflow_run_example_01 caseId: case_example_01 evaluationStatus: EXISTING statusUrl: /api/cases/case_example_01 observedAt: '2026-08-21T12:00:01.000Z' '201': description: The immutable dossier and queued workflow run were created content: application/json: schema: $ref: '#/components/schemas/KybDossierSubmissionResponse' examples: success: value: dossierId: kyb_dossier_example_01 customerVersionId: customer_version_example_01 workflowRunId: workflow_run_example_01 caseId: case_example_01 evaluationStatus: QUEUED statusUrl: /api/cases/case_example_01 observedAt: '2026-08-21T12:00:01.000Z' '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: >- KYB_SOURCE_VERSION_CONFLICT: The source version is already bound to a different dossier snapshot content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: KYB_SOURCE_VERSION_CONFLICT: value: type: https://karsa.app/problems/kyb-source-version-conflict title: Ingestion Rejected status: 409 detail: >- The source version is already bound to a different dossier snapshot code: KYB_SOURCE_VERSION_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 '503': description: >- KYB_RUNTIME_UNAVAILABLE: KYB evaluation is not available in this deployment, or KYB is not set up for this workspace content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: KYB_RUNTIME_UNAVAILABLE: value: type: https://karsa.app/problems/kyb-runtime-unavailable title: Ingestion Unavailable status: 503 detail: >- KYB evaluation is not available in this deployment, or KYB is not set up for this workspace code: KYB_RUNTIME_UNAVAILABLE requestId: req_example_01 security: - ingestionBearer: [] components: schemas: KybDossierSubmission: type: object properties: customerVersionId: type: string minLength: 1 sourceVersion: type: string minLength: 1 maxLength: 200 sourceEffectiveAt: type: string format: date-time relatedParties: type: array items: oneOf: - type: object properties: externalId: type: string minLength: 1 maxLength: 200 kind: type: string enum: - PERSON identity: type: object properties: legalName: type: string minLength: 1 maxLength: 300 givenName: type: - string - 'null' minLength: 1 maxLength: 500 middleName: type: - string - 'null' minLength: 1 maxLength: 500 familyName: type: - string - 'null' minLength: 1 maxLength: 500 dateOfBirth: type: - string - 'null' format: date nationalities: type: - array - 'null' items: type: string pattern: ^[A-Z]{2}$ minItems: 1 maxItems: 10 residenceCountry: type: - string - 'null' pattern: ^[A-Z]{2}$ required: - legalName - givenName - middleName - familyName - dateOfBirth - nationalities - residenceCountry additionalProperties: false required: - externalId - kind - identity additionalProperties: false - type: object properties: externalId: type: string minLength: 1 maxLength: 200 kind: type: string enum: - BUSINESS identity: type: object properties: legalName: type: string minLength: 1 maxLength: 300 legalForm: type: - string - 'null' minLength: 1 maxLength: 500 formationCountry: type: - string - 'null' pattern: ^[A-Z]{2}$ registrationNumber: type: - string - 'null' minLength: 1 maxLength: 500 required: - legalName - legalForm - formationCountry - registrationNumber additionalProperties: false required: - externalId - kind - identity additionalProperties: false maxItems: 250 relationships: type: array items: oneOf: - type: object properties: relationshipType: type: string enum: - OWNERSHIP relationshipExternalId: type: string minLength: 1 maxLength: 200 ownerExternalId: type: string minLength: 1 maxLength: 200 ownedBusiness: oneOf: - type: object properties: type: type: string enum: - ROOT_CUSTOMER required: - type additionalProperties: false - type: object properties: type: type: string enum: - RELATED_PARTY externalId: type: string minLength: 1 maxLength: 200 required: - type - externalId additionalProperties: false ownershipPercent: type: - number - 'null' exclusiveMinimum: 0 maximum: 100 required: - relationshipType - relationshipExternalId - ownerExternalId - ownedBusiness - ownershipPercent additionalProperties: false - type: object properties: relationshipType: type: string enum: - ROLE_ASSIGNMENT relationshipExternalId: type: string minLength: 1 maxLength: 200 personExternalId: type: string minLength: 1 maxLength: 200 targetBusiness: oneOf: - type: object properties: type: type: string enum: - ROOT_CUSTOMER required: - type additionalProperties: false - type: object properties: type: type: string enum: - RELATED_PARTY externalId: type: string minLength: 1 maxLength: 200 required: - type - externalId additionalProperties: false role: type: string enum: - CONTROL_PERSON - DIRECTOR - OFFICER - AUTHORIZED_SIGNER - REPRESENTATIVE - OTHER required: - relationshipType - relationshipExternalId - personExternalId - targetBusiness - role additionalProperties: false maxItems: 500 documents: type: array items: type: object properties: documentVersionId: type: string minLength: 1 maxLength: 200 role: type: string enum: - FORMATION_DOCUMENT - TAX_AUTHORITY_DOCUMENT - BUSINESS_PROOF_OF_ADDRESS - OWNERSHIP_DOCUMENT - OWNER_ID_FRONT - OWNER_ID_BACK - OWNER_PROOF_OF_ADDRESS - SOURCE_OF_FUNDS - BUSINESS_ACTIVITY - REGULATORY_AUTHORIZATION - BANK_STATEMENT - CONTRACT - INVOICE_OR_RECEIPT - ADDITIONAL_INFO - OTHER subtype: type: string minLength: 1 maxLength: 100 pattern: ^[A-Z][A-Z0-9_]*$ subject: oneOf: - type: object properties: type: type: string enum: - ROOT_CUSTOMER required: - type additionalProperties: false - type: object properties: type: type: string enum: - RELATED_PARTY externalId: type: string minLength: 1 maxLength: 200 required: - type - externalId additionalProperties: false languageTags: type: array items: type: string minLength: 2 maxLength: 35 minItems: 1 maxItems: 3 required: - documentVersionId - role - subtype - subject - languageTags additionalProperties: false maxItems: 50 providerEvidence: type: array items: oneOf: - type: object properties: sourceRecordId: type: string minLength: 1 maxLength: 200 sourceStatus: type: string minLength: 1 maxLength: 200 sourceResult: type: - string - 'null' minLength: 1 maxLength: 500 subject: oneOf: - type: object properties: type: type: string enum: - ROOT_CUSTOMER required: - type additionalProperties: false - type: object properties: type: type: string enum: - RELATED_PARTY externalId: type: string minLength: 1 maxLength: 200 required: - type - externalId additionalProperties: false sourceObservedAt: type: string format: date-time sourceOperation: type: object properties: packageId: type: string minLength: 1 maxLength: 200 operationId: type: - string - 'null' minLength: 1 maxLength: 200 required: - packageId - operationId additionalProperties: false evidenceType: type: string enum: - IDENTITY_VERIFICATION verificationType: type: string minLength: 1 maxLength: 100 context: type: string enum: - CURRENT - OTHER required: - sourceRecordId - sourceStatus - sourceResult - subject - sourceObservedAt - sourceOperation - evidenceType - verificationType - context additionalProperties: false - type: object properties: sourceRecordId: type: string minLength: 1 maxLength: 200 sourceStatus: type: string minLength: 1 maxLength: 200 sourceResult: type: - string - 'null' minLength: 1 maxLength: 500 subject: oneOf: - type: object properties: type: type: string enum: - ROOT_CUSTOMER required: - type additionalProperties: false - type: object properties: type: type: string enum: - RELATED_PARTY externalId: type: string minLength: 1 maxLength: 200 required: - type - externalId additionalProperties: false sourceObservedAt: type: string format: date-time sourceOperation: type: object properties: packageId: type: string minLength: 1 maxLength: 200 operationId: type: - string - 'null' minLength: 1 maxLength: 200 required: - packageId - operationId additionalProperties: false evidenceType: type: string enum: - SCREENING screeningCategories: type: array items: type: string minLength: 1 maxLength: 500 minItems: 1 maxItems: 25 findingExternalIds: type: array items: type: string minLength: 1 maxLength: 200 maxItems: 100 context: type: string enum: - CURRENT - OTHER required: - sourceRecordId - sourceStatus - sourceResult - subject - sourceObservedAt - sourceOperation - evidenceType - screeningCategories - findingExternalIds - context additionalProperties: false maxItems: 500 required: - customerVersionId - sourceVersion - sourceEffectiveAt - relatedParties - relationships - documents - providerEvidence additionalProperties: false KybDossierSubmissionResponse: type: object properties: dossierId: type: string minLength: 1 customerVersionId: type: string minLength: 1 workflowRunId: type: string minLength: 1 caseId: type: string minLength: 1 evaluationStatus: type: string enum: - QUEUED - EXISTING statusUrl: type: string minLength: 1 maxLength: 500 observedAt: type: string format: date-time required: - dossierId - customerVersionId - workflowRunId - caseId - evaluationStatus - statusUrl - observedAt 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.