Documentation
kompliant.com

Documentation Versions

Suggest Edits

Our documentation follows semantic versioning independent of the API releases.

2.4 - Current

This version documents new endpoints for webhooks, and all the events send by the Kompliant API.

New methods documented:

  • webhook.config.list
  • webhook.config.get
  • webhook.config.update
  • webhook.config.delete
  • webhook.config.create

SYSTEM_RULE_VIOLATION error changes:

  • Added MAX_WEBHOOK_URL_LIMIT_EXCEEDED and URL_ALREADY_EXISTS sub-codes to SYSTEM_RULE_VIOLATION error for the following method:
    • webhook.config.create
    • webhook.config.update

Webhook Section Updates

  • Added the following documentation for the webhook system (including the documentation for the webhook event content):
    • Webhook Events & Paylods
    • Webhook Structure: Version 1.0
      • DECISION_DOCUMENT_GENERATED Event
      • HEARTLAND_CREDENTIALS_RECEIVED Event
      • MBTRUST_SUCCESS Event
      • MBTRUST_FAILURE Event
      • PROPAY_SUCCESS Event
      • PROPAY_FAILURE Event
      • SUBJECT_RECORD_DATA_UPDATED Event
      • SUBJECT_RECORD_UNDERWRITING_STATUS_UPDATED Event
      • VERIFICATION_STATUS_UPDATED Event
      • WORKFLOW_COMPLETED Event
      • WORKFLOW_CREATED Event
      • WORKFLOW_STARTED Event

Webhook configuration guide:

  • Configure webhook endpoints

2.3

This version documents new endpoints for locations, person issued identifiers and workflow defense documents, propay and upcoming webhooks. Also, integration guides and a new section for webhooks have been added.

New methods documented:

  • business.addLocation
  • business.getLocation
  • business.listLocation
  • business.removeLocation
  • location.create
  • location.get
  • location.list
  • location.update
  • location.delete
  • location.addBankAccount
  • location.getBankAccount
  • location.listBankAccount
  • location.removeBankAccount
  • metadata.create
  • metadata.update
  • metadata.get
  • metadata.list
  • metadata.links.add
  • metadata.links.get
  • metadata.links.remove
  • metadata.type.define
  • person.issuedIdentifiers.create
  • person.issuedIdentifiers.get
  • person.issuedIdentifiers.list
  • person.issuedIdentifiers.update
  • person.issuedIdentifiers.delete
  • propay.create
  • propay.get
  • propay.canExecute
  • propay.execute
  • workflow.update
  • workflow.defenseDocument.generate
  • workflow.defenseDocument.list
  • workflow.defenseDocument.getDownload
  • workflow.agreement.list
  • workflow.agreement.getDownload
  • workflow.applicationSummary.getDownload
  • workflow.pricing.calculate
  • workflow.pricing.get
  • webhook.key.activate
  • webhook.key.create
  • webhook.key.get

New enums documented:

  • LOCATION_TYPES
  • LOCATION_OWNER_TYPES
  • LOCATION_BANK_ACCOUNT_PURPOSES
  • PRICING_TYPES
  • PRICING_ITEM_CODES
  • PRICING_ITEM_TYPES
  • WEBHOOK_KEY_STATUSES

New Error Type

  • Added System Exceptions error type

Methods updated:

  • workflow.canComplete and workflow.complete
    • Added STARTED_WORKFLOW_REQUIRED and SALES_INFO_REQUIRED for workflow requirement types
  • subjectRecord.list
    • Removed verbose and show_sensitive_data flags from request.

SYSTEM_RULE_VIOLATION error changes:

  • Added DAILY_LIMIT_EXCEEDED sub-code to SYSTEM_RULE_VIOLATION error for the following method:
    • webhook.key.create
  • Added KEY_ALREADY_ACTIVE and KEY_DELETED sub-codes to SYSTEM_RULE_VIOLATION error for the following method:
    • webhook.key.activate

Webhook integration guides

  • Webhook integration guide
  • Receiving and decryption webhooks

Webhook section

  • Added webhook section documenting the webhook schema versions and payloads

2.2

This version documents a variety of new methods across different entities including account provisioning, document, and workflow.

New methods documented:

  • account.documentType.list
  • bankAccount.update
  • business.getBankAccount
  • business.getOwner
  • business.salesInfo.update
  • business.update
  • business.updateBankAccount
  • business.updateOwner
  • document.create
  • document.delete
  • document.get
  • document.getDownload
  • document.list
  • mbtrust.canExecute
  • mbtrust.create
  • mbtrust.execute
  • mbtrust.get
  • person.update
  • subjectRecord.delete
  • subjectRecord.get
  • subjectRecord.list
  • workflow.delete
  • workflow.list
  • workflow.requiredDocument.batchAdd
  • workflow.requiredDocument.batchRequestDocument
  • workflow.requiredDocument.calculate
  • workflow.requiredDocument.eventsList
  • workflow.requiredDocument.fulfillment.addComment
  • workflow.requiredDocument.fulfillment.batchAdd
  • workflow.requiredDocument.fulfillment.delete
  • workflow.requiredDocument.fulfillment.list
  • workflow.requiredDocument.fulfillment.update
  • workflow.requiredDocument.list

New enums documented:

  • ACCOUNT_DOCUMENT_TYPE_STATUSES
  • ACCOUNT_PROVISIONING_ENTITY_STATUSES
  • ACCOUNT_PROVISIONING_OPERATION_STATUSES
  • ACCOUNT_PROVISIONING_OPERATIONS
  • ACCOUNT_PROVISIONING_SPONSORS
  • DOCUMENT_EVENT_NAMES
  • DOCUMENT_FILE_TYPES
  • DOCUMENT_TYPE_CODES
  • DOCUMENT_UPLOAD_STATUSES
  • FULFILLMENT_DECISION_STATUSES
  • FULFILLMENT_STATUSES
  • MBTRUST_MISSING_REQUIREMENTS
  • REQUIRED_DOCUMENT_CATEGORIES
  • REQUIRED_DOCUMENT_MISSING_REQUIREMENTS
  • REQUIRED_DOCUMENT_STATUSES

Methods updated:

  • business.create
    • Added email field business parameters in the request body
  • business.get
    • Added verbose field to request body
    • Added business_bank_accounts, business_owners and sales_info to the response body
  • business.listBankAccounts
    • Added show_sensitive_data and verbose fields to the request body
    • Added bank_accountfield to the response body
  • business.listOwners
    • Added show_sensitive_data and verbose fields to the request body
    • Added person field to the response body
  • workflow.get
    • Added started_at, ended_at, created_at, and updated_at fields to the response body

SYSTEM_RULE_VIOLATION error changes:

  • Added ESTABLISHED_DATE_AFTER_OWNERSHIP and SOLE_PROPRIETORSHIP_OWNERSHIP_PERCENTAGE sub-codes to SYSTEM_RULE_VIOLATION error for the following method:
    • business.update

ACCOUNT_CONFIGURATION_VIOLATION error changes:

  • Added DOCUMENT_TYPE_NOT_ASSIGNABLE sub-code for RequiredDocument entity for the following method:
    • workflow.requiredDocument.batchAdd

INVALID_ENDPOINT_REQUEST error changes

  • Updated the description to include more reasons the error can be thrown
  • Updated the example JSON response to correspond to current message text

WORKFLOW_TYPES changes:

  • Added ACCOUNT_PROVISIONING workflow

Core Concepts changes:

  • Updated the "Workflow: Business-Application" page
  • Added the "Workflow: Account-Provisioning" and "Relationships" documents

Integration Patterns changes:

  • Included three new patterns: "Uploading Documents via API", "Account Provisioning After Application", and "Direct Account Provisioning"

Reference changes:

  • Included "MBTrust Validation Reference" to provide help on requirements and common validation errors

Grouping changes:

  • Grouped methods together by parent object to make it easier to navigate

Quick Start Guide changes:

  • Added Python and JavaScript examples to signing the API Key and the example request.

2.1

This version documents new methods related to the Workflow and the Business entity. It also includes non-breaking updates to some existing methods in order to support more capabilities.

New methods documented:

  • business.salesInfo.create
  • business.salesInfo.get
  • business.salesInfo.delete
  • workflow.canComplete
  • workflow.complete
  • workflow.start

New enums documented:

  • CARD_BRANDS
  • CURRENCIES
  • PRICING_ITEM_TYPES
  • PRICING_TYPES
  • SALES_AMOUNT_TYPES
  • WORKFLOW_REQUIREMENTS

SYSTEM_RULE_VIOLATION error changes:

  • Removed WORKFLOW_ENDED sub-code for SYSTEM_RULE_VIOLATION error for the following methods:

    • bankAccount.create
    • bankAccount.delete
    • business.addBankAccount
    • business.addOwner
    • business.create
    • business.get
    • business.delete
    • business.removeBankAccount
    • business.removeOwner
    • person.create
    • person.delete

  • Added SOLE_PROPRIETORSHIP_OWNERSHIP_TYPE and SOLE_PROPRIETORSHIP_OWNERSHIP_PERCENTAGE sub-codes to SYSTEM_RULE_VIOLATION error for the following method:

    • business.addOwner

Other method updates:

  • workflow.create

    • Added state field to request body
    • Added support for a new Workflow type: ACCOUNT_PROVISIONING
    • Added support for configuration to allow multiple applications per applying user

  • business.create

    • Added support for additional fields parameters

  • business.get

    • Added support for additional fields parameters
    • Added sales_info_id to response body

2.0

This version represents a complete overhaul of our developer documentation, designed to provide comprehensive guidance for the 2025-03-24 API release. The documentation has been restructured from the ground up to include:

  • Detailed API Method Documentation: Complete reference for all available methods with request/response formats, examples, and error handling
  • Core Concepts: Foundational explanations of Subject Records, Workflows, Businesses, Persons, and Bank Accounts
  • Authentication Framework: Comprehensive guide to our new signature-based authentication system
  • Integration Patterns: Step-by-step approaches for common implementation scenarios
  • Standard Response Formats: Consistent patterns for handling data, errors, and batch operations
  • HTTP Status Codes and Error Handling: Systematic approach to error identification and troubleshooting

Everything has been redesigned with a focus on developer experience, providing both high-level conceptual guidance and detailed technical specifications. The only element carried forward from the previous documentation is information about the Digital Application UI integration.

1.0

This is the original version of our documentation which included minimal information to help one get started using Kompliant's APIs.

Updated 18 days ago