Introduction

The Kompliant Web API provides a comprehensive set of methods to interact with our platform. These methods allow you to manage entities like Businesses, Persons, Bank Accounts, and Workflows throughout the compliance lifecycle.

How to Read Method Documentation

Each method page follows a consistent structure to help you understand and implement the API correctly:

Method Overview: At the top of each page, you'll see a brief description in bold that explains the purpose of the method.
Usage Info: This section provides context on when and why you would use this method, including common use cases and considerations.
Request: Details about the required and optional parameters for the method call, including:
- Authentication requirements
- Parameter tables with names, types, requirements, and descriptions
- Example request in JSON format
Response: Information about what the method returns, including:
- Data structure description
- All possible fields and their meanings
- Example response in JSON format
Errors: Each method page includes an Errors section that highlights the most significant errors you might encounter when using that method. These typically include:
- Method-specific validation errors
- Entity relationship constraints
- System rules particularly relevant to the method
  
  Note: Standard errors like BAD_REQUEST for malformed JSON may apply to all methods but might not be explicitly listed on every page. For a comprehensive list of all possible errors, refer to the Standard Errors documentation.

Available Methods

Method	Description
account.documentType.list	Retrieve a list of the available Document Types for the Account
bankAccount.create	Create a Bank Account entity to capture financial account details.
bankAccount.delete	Remove a Bank Account entity from a Subject Record.
bankAccount.get	Retrieve comprehensive details about a specific Bank Account entity.
bankAccount.list	Retrieve a comprehensive list of all Bank Account entities within a Subject Record.
bankAccount.update	Update a Bank Account entity to modify its financial account details.
business.addBankAccount	Associate a Bank Account entity with a specific Business entity.
business.addOwner	Associate a Person entity as an owner of a specific Business entity.
business.create	Create a Business entity to capture essential information about a company.
business.delete	Remove a Business entity from a Subject Record.
business.get	Retrieve comprehensive details about a specific Business entity.
business.getBankAccount	Retrieve comprehensive details of a specific Business Bank Account entity.
business.getOwner	Retrieve comprehensive details about a specific Business Owner entity.
business.listBankAccounts	Retrieve a comprehensive list of all Bank Accounts associated with a specific Business entity.
business.listOwners	Retrieve a comprehensive list of all owners associated with a specific Business entity.
business.removeBankAccount	Remove the association between a Bank Account and a Business entity.
business.removeOwner	Remove an ownership relationship between a Person and a Business entity.
business.salesInfo.create	Create a Sales Information entity to capture financial account details about a Business.
business.salesInfo.delete	Remove the Sales Info entity from a Business.
business.salesInfo.get	Retrieve comprehensive details about a specific Business Sales Information entity.
business.salesInfo.update	Update a Sales Information entity for a Business.
business.update	Update a Business entity to modify essential information about a company.
business.updateBankAccount	Update a specific Business Bank Account entity.
business.updateOwner	Update a specific Business Owner entity.
business.addLocation	Associate a Location entity with a specific Business entity.
business.getLocation	Retrieve comprehensive details about a specific Location associated with a Business entity.
business.listLocations	Retrieve a comprehensive list of all Locations associated with a specific Business entity.
business.removeLocation	Remove the association between a Location and a Business entity.
document.create	Create a Document entity to store file information and metadata.
document.delete	Soft delete a Document entity from a Subject Record.
document.get	Retrieve comprehensive details about a specific Document entity.
document.getDownload	Get a presigned download URL for a Document file.
document.list	Retrieve a comprehensive list of all Document entities within a Subject Record.
location.create	Create a Location entity for a SubjectRecord entity.
location.get	Retrieve comprehensive details of a Location entity.
location.list	Retrieve a comprehensive list of all Location entities within a Subject Record.
location.update	Update a Location entity to modify its details.
location.delete	Remove a Location entity from a Subject Record.
location.addBankAccount	Associate a BankAccount entity with a specific Location entity.
location.getBankAccount	Retrieve comprehensive details of a LocationBankAccount entity.
location.listBankAccounts	Retrieve a comprehensive list of all LocationBankAccounts entities associated with location.
location.removeBankAccount	Remove the association between a BankAccount and a Location entity.
mbtrust.create	Create an account provisioning entity for MBTrust.
mbtrust.execute	Initiate MBTrust account provisioning execution.
mbtrust.canExecute	Validate that a MBTrust account provisioning entity has all the required information to execute provisioning operations.
mbtrust.get	Retrieve details of the MBTrust account provisioning entity.
metadata.type.define	Create a fields definition for a metadata type
metadata.create	Create a metadata entity to capture metadata type details.
metadata.update	Create a metadata entity to capture metadata type details.
metadata.get	Retrieve details of the metadata entity of a certain metadata type.
metadata.list	Retrieve comprehensive list of the all metadata details entities belonging to a SubjectRecord.
metadata.links.add	Link a metadata entity to a Business, Person, Bank Account or Location entity.
metadata.links.get	Retrieves the Business, Person, Bank Account or Location entity ids linked to a metadata entity.
metadata.links.remove	Remove a link from a metadata entity and a Business, Person, Bank Account or Location entity.
person.create	Create a Person entity to capture detailed information about an individual.
person.delete	Remove a Person entity from a Subject Record.
person.get	Retrieve comprehensive details about a specific Person entity.
person.list	Retrieve a comprehensive list of all Person entities within a Subject Record.
person.update	Update a Person entity to modify essential information about an individual.
person.issuedIdentifier.create	Create an Issued Identifier entity to associate with a Person.
person.issuedIdentifier.delete	Remove an Issued Identifier entity from a Person.
person.issuedIdentifier.get	Retrieve comprehensive details about a specific Issued Identifier entity.
person.issuedIdentifier.list	Retrieve a comprehensive list of all Issued Identifiers associated with a Person.
person.issuedIdentifier.update	Update an Issued Identifier entity within a Person.
propay.create	Create a new provisioning entity with Global Payments
propay.get	Returns information about a Propay account provisioning entity
propay.canExecute	Validate that a Propay account provisioning entity has all the required information to execute provisioning operations.
propay.execute	Initiate Propay account provisioning
subjectRecord.create	Create a Subject Record to serve as a container for related entity information.
subjectRecord.delete	Remove a Subject Record entity.
subjectRecord.get	Retrieve comprehensive information about a specific Subject Record.
subjectRecord.list	Retrieve a comprehensive list of all Subject Record entities within an account.
workflow.canComplete	Check Workflow data against account configured required information.
workflow.complete	Complete a Workflow and finalize processing.
workflow.create	Create a Workflow to enable structured processing of data in a Subject Record.
workflow.update	Update a Workflow of type Business Application.
workflow.delete	Remove the Workflow entity.
workflow.get	Retrieve comprehensive information about a specific Workflow.
workflow.list	Retrieve a comprehensive list of all Workflow entities within a Subject Record.
workflow.requiredDocument.batchAdd	Add multiple required documents to a Workflow.
workflow.requiredDocument.calculate	Calculate required documents for a Workflow.
workflow.requiredDocument.eventsList	List events for Workflow required documents.
workflow.requiredDocument.fulfillment.batchAdd	Add multiple fulfillments to required documents.
workflow.requiredDocument.fulfillment.addComment	Add a comment to a required document fulfillment.
workflow.requiredDocument.fulfillment.delete	Delete a required document fulfillment.
workflow.requiredDocument.fulfillment.list	List fulfillments for a required document.
workflow.requiredDocument.fulfillment.update	Update a required document fulfillment.
workflow.requiredDocument.list	List required documents for a Workflow.
workflow.start	Update a Workflow state to STARTED triggering any processes related to this specific state.
workflow.defenseDocument.generate	Generate a defense document for a completed Workflow.
workflow.defenseDocument.getDownload	Get a presigned download URL for a Workflow defense document.
workflow.defenseDocument.list	Retrieve a comprehensive list of all defense documents for a Workflow.
workflow.applicationSummary.getDownload	Get a presigned download URL for a Workflow application summary.
workflow.agreement.list	Retrieve a comprehensive list of all signed Agreements associated with a Workflow.
workflow.agreement.getDownload	Retrieve a download url for a signed workflow agreement.
workflow.pricing.calculate	Calculate pricing for the workflow.
workflow.pricing.get	Retrieve a pricing information for the workflow.
webhook.key.activate	Activates a webhook key for encrypting webhook payloads.
wekhook.key.create	Creates a new encryption key for securing webhook payloads.
webhook.key.get	Returns information about a specific webhook key.
wekhook.config.create	Creates a webhook configuration to setup receivers.
wekhook.config.update	Updates an existing webhook configuration.
wekhook.config.list	List existing webhook configurations.
wekhook.config.get	Gets an specific webhook configuration.
wekhook.config.delete	Deletes a webhook configuration.

Common Patterns

Our API methods follow consistent patterns that make them intuitive to use:

Entity Creation: Methods like create establish new entities in the system.
Entity Retrieval: Methods like get and list retrieve information about existing entities.
Entity Deletion: Methods like delete remove entities from the system.
Relationship Management: Methods like addOwner, removeBankAccount, etc. manage relationships between entities.

Additional Resources

For more detailed information about working with our API, refer to these resources:

Authentication: Understanding the authentication process
Responses: How to interpret API responses
HTTP Status Codes: List of possible status codes and their meanings
Standard Errors: Common error patterns across all APIs