Activate customer

Activate a customer that is currently deactivated.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Create customer

Create a new customer.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Create customer supplier

Create a customer supplier credential. Notes: Adding a customer supplier will not instantly validate the credentials. They will be validated later during download and a notification is created in case that they are invalid.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Create environment

Create a new environment. Environments can be used for production to setup push urls and redirect urls and for testing with different push or redirect urls.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Deactivate customer

Deactivate an active customer. This will not remove any data.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Delete customer

Delete a customer and all connected data.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Delete environment

Delete a environment. You can only delete environments that have no customers assigned. In case there are customers you have to delete them first. You can use /listCustomerAccounts to get a list of customers of a environment.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Destroy customer session

Destroy a customer session that was created by /createCustomer or /getCustomerSession. This does not remove any customer data. This function is only used if you use the UI Plug&Play Integration.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Delete customer supplier

Delete a customer supplier entry created by /createCustomerSupplier.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Fill input request

Fill an input request for either user information or 2-Factor-Codes.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Get customer account overview

Get a customer account overview. This lists all stored information about a customer account. Information could be used to fulfil EU-data-privacy (DSGVO) requirements.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Get customer session

Get a session for a existing customer that was created by /createCustomer. This function is only used if you use the UI Plug&Play Integration.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Get customer supplier

Get one customer supplier for a customer.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Get document

Get one document content and meta data from queue. This is not available if push for documents is activated.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Get documents queue

Get documents meta data for all customers / customer suppliers from documents queue. Response is limited for 100 documents. You can get the document in api /getDocument. This is not available if push for documents is activated.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Get supplier fields

Get all fields for a supplier. This is required for Add/Edit Credential dialogs, so that your sytem knows what UI fields must be rendered dynamically for user input.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

List customer accounts

List all customer accounts.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

List customer suppliers

List all customer suppliers for a customer.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

List date formats

List all available date formats.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

List environments

List all environments.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

List suppliers

Get list of all suppliers.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

List timezones

List all available timezones.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Remove document from queue

Remove one document from queue. This is not available if push for documents is activated.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Start customer download process

Start adhoc download process for a customer supplier credential.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Suggest supplier

Suggest a supplier that is not yet available.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Test 2FA

Add a input request to input request push queue and the push server will send the input request back to the push url after some short time.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Test Notification

Add a notification to notification push queue and the push server will send the notification back to the push url after some short time.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Test Password Encryption

This endpoint can be used to test the password encryption.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Test queue

Add a test document to the documents queue or documents push queue. Will add a document to push queue instead if push for documents is active and push will send document back to push url after some short time.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Trigger input request

Trigger a input request.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Update customer

Update a customer.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Update customer supplier

Update a customer supplier entry. Notes: Updating a customer supplier will not instantly validate the credentials. They will be validated later during download and a notification is created in case that they are invalid.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.

Update environment

Update a environment. Environments can be used for production to setup push urls and redirect urls and for testing with different push or redirect urls.

post

Usage of API is restricted by API Key. Additional security layer with api_checksum has to be enabled manually.