> ## 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. # Update a customer > Updates supplied mutable fields and appends a complete immutable customer snapshot. Stable customer identity and customer type are not replaceable. ## OpenAPI ````yaml /openapi/ingestion.openapi.yaml put /api/ingestion/customers/{customerId} 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/customers/{customerId}: put: tags: - Customers summary: Update a customer description: >- Updates supplied mutable fields and appends a complete immutable customer snapshot. Stable customer identity and customer type are not replaceable. operationId: updateCustomer parameters: - schema: type: string minLength: 1 maxLength: 200 required: true name: customerId in: path - 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/CustomerUpdate' examples: request: value: lifecycleStatus: ACTIVE business: phone: '+12025550124' transactionPurpose: Pay suppliers, payroll, and operating expenses effectiveAt: '2026-08-06T14:00:00.000Z' changeReason: SOURCE_PROFILE_UPDATED responses: '200': description: A new immutable version was appended to the customer content: application/json: schema: $ref: '#/components/schemas/IngestionResponse' examples: versionCreated: value: outcome: VERSION_CREATED resourceId: customer_resource_example_01 versionId: customer_version_example_02 currentVersionId: customer_version_example_02 '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: CustomerUpdate: type: object properties: effectiveAt: type: string format: date-time changeReason: type: - string - 'null' minLength: 1 maxLength: 2000 lifecycleStatus: type: string enum: - PENDING - ACTIVE - SUSPENDED - CLOSED onboardedAt: type: - string - 'null' format: date-time customData: type: - object - 'null' additionalProperties: {} documents: type: array items: type: object properties: documentVersionId: type: string minLength: 1 maxLength: 200 role: type: string minLength: 1 maxLength: 200 roleDetail: type: - string - 'null' minLength: 1 maxLength: 200 required: - documentVersionId - role additionalProperties: false maxItems: 25 business: type: object properties: verificationTier: type: - object - 'null' properties: sourceText: type: string minLength: 1 maxLength: 500 category: type: - string - 'null' enum: - LIGHT - STANDARD - ENHANCED - OTHER required: - sourceText - category additionalProperties: false onboardingContext: type: - object - 'null' properties: ipAddress: type: - string - 'null' format: ip latitude: type: - number - 'null' minimum: -90 maximum: 90 longitude: type: - number - 'null' minimum: -180 maximum: 180 required: - ipAddress - latitude - longitude additionalProperties: false profileImageUrl: type: - string - 'null' maxLength: 2000 format: uri termsAcceptanceId: type: - string - 'null' minLength: 1 maxLength: 200 additionalInformation: type: - array - 'null' items: type: object properties: label: type: string minLength: 1 maxLength: 500 value: type: string minLength: 1 maxLength: 5000 required: - label - value additionalProperties: false maxItems: 50 legalName: type: string minLength: 1 maxLength: 300 tradeNames: type: - array - 'null' items: type: string minLength: 1 maxLength: 500 minItems: 1 maxItems: 20 legalForm: type: - object - 'null' properties: sourceText: type: string minLength: 1 maxLength: 500 category: type: - string - 'null' enum: - SOLE_PROPRIETORSHIP - PARTNERSHIP - LIMITED_LIABILITY_ENTITY - CORPORATION - NONPROFIT - TRUST_OR_FOUNDATION - GOVERNMENT_ENTITY - OTHER required: - sourceText - category additionalProperties: false formationJurisdiction: type: - object - 'null' properties: country: type: string pattern: ^[A-Z]{2}$ administrativeAreaCode: type: - string - 'null' minLength: 1 maxLength: 500 administrativeAreaName: type: - string - 'null' minLength: 1 maxLength: 500 required: - country - administrativeAreaCode - administrativeAreaName additionalProperties: false formationDate: type: - string - 'null' format: date registrationNumber: type: - string - 'null' minLength: 1 maxLength: 500 taxIdentifiers: type: - array - 'null' items: type: object properties: country: type: string pattern: ^[A-Z]{2}$ type: type: string enum: - EIN - TIN - VAT - CNPJ - RFC - NIT - NTN - BIN - TRN - OTHER typeSourceText: type: - string - 'null' minLength: 1 maxLength: 500 number: type: string minLength: 1 maxLength: 200 required: - country - type - typeSourceText - number additionalProperties: false minItems: 1 maxItems: 10 registeredAddress: type: - object - 'null' properties: addressLines: type: array items: type: string minLength: 1 maxLength: 500 minItems: 1 maxItems: 6 locality: type: - string - 'null' minLength: 1 maxLength: 500 administrativeAreaCode: type: - string - 'null' minLength: 1 maxLength: 500 administrativeAreaName: type: - string - 'null' minLength: 1 maxLength: 500 postalCode: type: - string - 'null' minLength: 1 maxLength: 40 country: type: string pattern: ^[A-Z]{2}$ required: - addressLines - locality - administrativeAreaCode - administrativeAreaName - postalCode - country additionalProperties: false email: type: - string - 'null' maxLength: 320 format: email phone: type: - string - 'null' pattern: ^\+[1-9]\d{1,14}$ website: type: - string - 'null' maxLength: 2000 format: uri operatingAddress: type: - object - 'null' properties: addressLines: type: array items: type: string minLength: 1 maxLength: 500 minItems: 1 maxItems: 6 locality: type: - string - 'null' minLength: 1 maxLength: 500 administrativeAreaCode: type: - string - 'null' minLength: 1 maxLength: 500 administrativeAreaName: type: - string - 'null' minLength: 1 maxLength: 500 postalCode: type: - string - 'null' minLength: 1 maxLength: 40 country: type: string pattern: ^[A-Z]{2}$ required: - addressLines - locality - administrativeAreaCode - administrativeAreaName - postalCode - country additionalProperties: false businessDescription: type: - string - 'null' minLength: 1 maxLength: 2000 industry: type: - object - 'null' properties: system: type: string enum: - NAICS - NACE - ISIC - MCC - OTHER systemSourceText: type: - string - 'null' minLength: 1 maxLength: 500 code: type: - string - 'null' minLength: 1 maxLength: 80 label: type: - string - 'null' minLength: 1 maxLength: 500 required: - system - systemSourceText - code - label additionalProperties: false accountPurpose: type: - string - 'null' minLength: 1 maxLength: 2000 transactionPurpose: type: - string - 'null' minLength: 1 maxLength: 2000 sourceOfFunds: type: - object - 'null' properties: categories: type: array items: type: string enum: - OPERATING_REVENUE - OWNER_OR_SHAREHOLDER_FUNDS - INVESTMENT_OR_CAPITAL - LOAN_OR_CREDIT - ASSET_SALE - GRANT_OR_DONATION - OTHER minItems: 1 maxItems: 7 explanation: type: - string - 'null' minLength: 1 maxLength: 2000 required: - categories - explanation additionalProperties: false sourceOfWealth: type: - string - 'null' minLength: 1 maxLength: 2000 annualRevenue: type: - object - 'null' properties: currency: type: string pattern: ^[A-Z]{3}$ minimum: type: - string - 'null' pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$ maximum: type: - string - 'null' pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$ required: - currency - minimum - maximum additionalProperties: false expectedMonthlyAmount: type: - object - 'null' properties: currency: type: string pattern: ^[A-Z]{3}$ minimum: type: - string - 'null' pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$ maximum: type: - string - 'null' pattern: ^(?:0|[1-9]\d*)(?:\.\d+)?$ required: - currency - minimum - maximum additionalProperties: false expectedMonthlyTransactionCount: type: - object - 'null' properties: minimum: type: - integer - 'null' minimum: 0 maximum: type: - integer - 'null' minimum: 0 required: - minimum - maximum additionalProperties: false operatingCountries: type: - array - 'null' items: type: string pattern: ^[A-Z]{2}$ minItems: 1 maxItems: 50 handlesThirdPartyFunds: type: - boolean - 'null' publiclyTraded: type: - boolean - 'null' regulatedActivities: type: - array - 'null' items: type: object properties: sourceActivity: type: string minLength: 1 maxLength: 500 activityCode: type: string enum: - MONEY_TRANSMISSION - PAYMENT_SERVICES - VIRTUAL_ASSET_SERVICES - CUSTODY - EXCHANGE_OR_TRADING - LENDING - BANKING - BROKER_DEALER - OTHER jurisdictionCountry: type: - string - 'null' pattern: ^[A-Z]{2}$ authorizationKind: type: - string - 'null' enum: - LICENCE - REGULATORY_REGISTRATION - ACCEPTED_EXEMPTION authority: type: - string - 'null' minLength: 1 maxLength: 500 authorizationNumber: type: - string - 'null' minLength: 1 maxLength: 500 declaredStatus: type: - string - 'null' enum: - AUTHORIZED - PENDING - EXEMPT - NOT_AUTHORIZED required: - sourceActivity - activityCode - jurisdictionCountry - authorizationKind - authority - authorizationNumber - declaredStatus additionalProperties: false minItems: 1 maxItems: 25 additionalProperties: false individual: type: object properties: verificationTier: type: - object - 'null' properties: sourceText: type: string minLength: 1 maxLength: 500 category: type: - string - 'null' enum: - LIGHT - STANDARD - ENHANCED - OTHER required: - sourceText - category additionalProperties: false onboardingContext: type: - object - 'null' properties: ipAddress: type: - string - 'null' format: ip latitude: type: - number - 'null' minimum: -90 maximum: 90 longitude: type: - number - 'null' minimum: -180 maximum: 180 required: - ipAddress - latitude - longitude additionalProperties: false profileImageUrl: type: - string - 'null' maxLength: 2000 format: uri termsAcceptanceId: type: - string - 'null' minLength: 1 maxLength: 200 additionalInformation: type: - array - 'null' items: type: object properties: label: type: string minLength: 1 maxLength: 500 value: type: string minLength: 1 maxLength: 5000 required: - label - value additionalProperties: false maxItems: 50 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}$ residentialAddress: type: - object - 'null' properties: addressLines: type: array items: type: string minLength: 1 maxLength: 500 minItems: 1 maxItems: 6 locality: type: - string - 'null' minLength: 1 maxLength: 500 administrativeAreaCode: type: - string - 'null' minLength: 1 maxLength: 500 administrativeAreaName: type: - string - 'null' minLength: 1 maxLength: 500 postalCode: type: - string - 'null' minLength: 1 maxLength: 40 country: type: string pattern: ^[A-Z]{2}$ required: - addressLines - locality - administrativeAreaCode - administrativeAreaName - postalCode - country additionalProperties: false email: type: - string - 'null' maxLength: 320 format: email phone: type: - string - 'null' pattern: ^\+[1-9]\d{1,14}$ taxIdentifiers: type: - array - 'null' items: type: object properties: country: type: string pattern: ^[A-Z]{2}$ type: type: string enum: - EIN - TIN - VAT - CNPJ - RFC - NIT - NTN - BIN - TRN - OTHER typeSourceText: type: - string - 'null' minLength: 1 maxLength: 500 number: type: string minLength: 1 maxLength: 200 required: - country - type - typeSourceText - number additionalProperties: false minItems: 1 maxItems: 10 accountPurpose: type: - string - 'null' minLength: 1 maxLength: 2000 transactionPurpose: type: - string - 'null' minLength: 1 maxLength: 2000 sourceOfFunds: type: - object - 'null' properties: categories: type: array items: type: string enum: - OPERATING_REVENUE - OWNER_OR_SHAREHOLDER_FUNDS - INVESTMENT_OR_CAPITAL - LOAN_OR_CREDIT - ASSET_SALE - GRANT_OR_DONATION - OTHER minItems: 1 maxItems: 7 explanation: type: - string - 'null' minLength: 1 maxLength: 2000 required: - categories - explanation additionalProperties: false sourceOfWealth: type: - string - 'null' minLength: 1 maxLength: 2000 occupation: type: - string - 'null' minLength: 1 maxLength: 500 additionalProperties: false required: - effectiveAt 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.