fetchdocs.io - Fetch API documentation version v1

https://api.fetchdocs.io/fetch/v1

Overview

fetchdocs.io - Fetch API can be used for the API-Based integration of document fetching as well as for the UI Plug&Play Integration. All access is restricted by API Key.

Content-Type of all requests should be application/json. You can also download the API documentation in RAML-Format.

SDK

You can also see our official SDK for details how to use the API.

PHP: https://github.com/fetchdocs/fetchdocs-api-php

SAMPLE PHP CODE
====================================
$data_string = json_encode(array(
  "api_key" => "XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX"   // This is the default fetchdocs.io API Test-Key. Please put your personal key here.
));
$ch = curl_init("https://api.fetchdocs.io/fetch/v1/createCustomer");
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  "Content-Type: application/json",
  "Content-Length: ".strlen($data_string))
);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
$return_data = curl_exec($ch);
curl_close($ch);

// Return data will have a json data like
{
  "success": true,
  "data": {
      "prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents.
      "customer_secret": "this_is_the_customer_secret_token", // a secret token you have to use to get data for the customer that was just created
      "access_token": "customer_access_token" // Access token used to authenticate the ui dialogs if they are used. It is valid for 24 hours and should be removed as soon as the user is redirected back to your application. /destroyCustomerSession should be used to remove a access token.
  }
}

General Pointers

HTTPS only: All requests are done over HTTPS.
UTF-8 encoding: All strings are sent and received in UTF-8.
JSON in, JSON out: Data is sent and received as JSON (although some endpoints might return binary documents).
Schemas: We're using the JSON schema format to document the endpoints.
ISO Date format: Dates are in ISO 8601 format: 2013-07-18

API-Urls:

Production: https://api.fetchdocs.io
Stage: https://api.stage.fetchdocs.io

Please note that the api key provided is only valid for either stage or production.

Data Type Relations

Wording

Supplier
A supplier is a source where we can fetch documents from. For example: Amazon
Customer
A customer is a relation record. It is a representation of your user in our system
Customer Supplier
A customer supplier is a credential that contains all required data to login into a supplier
Input Request
A input request can be mutiple things. It is whenever we need input. For example: A 2FA code or a answer to a security question

Getting started with the Integration

The service can be used with a API only integration and a mixed integration of API and our UI. This short guide covers the basics with both integrations. We suggest the mixed integration as in this integration our UI covers some of the most complicated parts. Also without a PSD2 license european banks can only be used with our UI. For the initial integration we highly suggest to only use the supplier "Test Portal" until all cases like input requests and notifications are covered by your side.

To start you need to setup a environment. For the stage system every developer can add his own environment so that working parallel is possible.
After that for both types of integration it is required to setup a customer with the /createCustomer API call. This request is needed once only for each of your accounts. You need to store the returned customer ID along with the "customer_secret". The secret is required to get the users documents and also for some other endpoints like /deleteCustomer.

Based on the type of integration you can now choose between UI and API to store a customer supplier:
- UI: You can now redirect the user to the Add Customer Supplier Page of our UI. For this you need the "access_token" from /createCustomer or /getCustomerSession and a "supplier_uid" from /listSuppliers.
  
  Here the user can now enter the credentials and connect the supplier. The UI will handle every special case and for many suppliers it will validate the credentials in real time or within 24 hours if a real time validation is not possible. After the customer supplier was created the page will redirect to the url defined in the environment with some additional information about the newly created customer supplier.
  
  After that we suggest to destroy the access token with /destroyCustomerSession.
- API: The creation of a customer supplier with API functions is not as easy as the UI version. It requires handling of multiple things. When you want to use the API you need to fill all required data for /createCustomerSupplier. This includes the correct encryption of the password, handling all supplier fields. If you plan to use the real time validation this also requires the handling of /getQuickFeedback and /fillQuickFeedbackRequest.
After the customer supplier was created successfully the download will start and try to download documents. It is required now to have a working push endpoint for the notification push. With the help of the notification push you will get details if a download was successfully, failed or is stuck because of a pending user action. The type of notifications and what needs to be done is explained in the notifications part.
Those documents can be sent to you via "pushDocuments" or fetched with /getDocumentsQueue and /getDocument.

Test Portal

On the Stage installation we have a portal named "Test Portal". This can be used to test all login flows even the special cases. Based on the username you will recieve different responses from the test portal. There is also a "Test Portal - Old Flow" that does not support quick feedback. The password is always: 1234

Username "success" will return "LOGIN_SUCCESS"
Username "failed" will return "LOGIN_FAILED"
Username "noinvoice" will return "NO_DOCUMENTS"
Username "maintenance" will return "TEMP_TECHNICAL_ISSUE"
Username "noperm" will return "NO_PERMISSION"
Username "notready" will return "ACCOUNT_NOT_READY"
Username "2fa" will return "INPUT_REQUESTED"
Username "longrun" will return "LOGIN_SUCCESS" but takes 90 seconds before portal responds, so you can do testings for timeouts in your UI

Push Endpoints

You can decide whether you want to pull the downloaded documents or get them pushed. This is configurable in your customer center. If you want to pull the documents, the endpoint on our side is "/getDocumentsQueue". In case we should push documents to your system, you need to set up an endpoint on your own and configure it in the customer center.

pushDocuments:
The data pushed by this push endpoint is similar to the /getDocument API.

{
"prim_uid": 173,
"customer_prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents. Same as in /createCustomer
"customer_supplier_prim_uid": 13, // Our unique customer supplier id created in /createCustomerSupplier
"supplier_prim_uid": 307, // Our unique supplier id from /listSuppliers
"filename": "receipt-1708171523.pdf",
"file_size": "136.75", // File size is always in KB
"file_content_checksum": "", // md5 hash of file content (raw content, not base64 encoded content)
"file_content": "", // base64 encoded file content
"secret": "" // The push_endpoint_secret from the environment of the customer. Null if not set at the environment
}

If push was successful and endpoint returned json '{"success": true}" we will remove the document from the push queue and will not try to send it again. The pushDocuments endpoint will only send one document at a time and will wait for response before sending the next one.

However, two other endpoints are required in any case:

pushNotification:
User notifications like "Login failed" or any other information for user is sent as a notification to your system.

{
"customer_prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents. Same as in /createCustomer
"customer_supplier_prim_uid": 13, // Our unique customer supplier id created in /createCustomerSupplier . Can also be null in case it is not related to a specific customer supplier
"notification_key": "SCBdoCCDTCEsr1RoYjMHm6GS9nwmfrXfo8yCyUyg", // unique string for that notification
"notification_type": "LOGIN_FAILED", // The type of notification
"supplier_prim_uid": 307, // Can also be null in case it is not related to a specific supplier
"title": "Login failed",
"text": "Login for supplier amazon.co.uk failed.",
"expiry_datetime": "2013-07-18 08:17:13", // Date until the notification is valid. Can be null if no expiry date
"secret": "", // The push_endpoint_secret from the environment of the customer. Null if not set at the environment
"created": "2013-07-18 08:17:13", // Date when the notification was created
"credential_status_screenshot": "--BASE64 ENCODED content of PNG screenshot--"
}

Possible values for "notification_type":

LOGIN_SUCCESS
The credential has been verified and download engine able to login.
LOGIN_FAILED
The credential has been entered wrong or the user has changed its credentials meanwhile and needs to update them.
NO_DOCUMENTS
The download engine has been able to log into the website, but did not find any new documents.
NO_PERMISSION
The download engine has been able to log into the website, but the user account is not allowed to access the billing page.
ACCOUNT_NOT_READY
When the system tried to log into the account, the website requested some action from the user. The engine cannot complete this itself. The user must login and solve the blocker. Examples: Accepting changes of Terms, Confirming address is still valid, Account Status Migration
TEMP_TECHNICAL_ISSUE
This could happen when the actual website was down, had a maintenance window or it takes time to solve a captcha in the website. No user action required, the engine will simply retry it later.

If push was successful and endpoint returned json '{"success": true}" we will remove the notification from the push queue and will not try to send it again.

pushInputRequest:
In case the fetching engine requires user input, for example for security questions (What was your first pet?) or 2-factor codes, those requests are pushed to this endpoint in your system.

{
"input_request_prim_uid": 585, // This is the unique input request id
"customer_prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents. Same as in /createCustomer
"customer_supplier_prim_uid": 13, // Our unique customer supplier id created in /createCustomerSupplier . Can also be null in case it is not related to a specific customer supplier
"notification_key": "SCBdoCCDTCEsr1RoYjMHm6GS9nwmfrXfo8yCyUyg", // unique string for that notification
"notification_type": "INPUT_REQUESTED", // The type of notification
"supplier_prim_uid": 307, // Can also be null in case it is not related to a specific supplier
"title": "Input required",
"text": "Input fur supplier amazon.co.uk required. Answer to security question missing.",
"expiry_datetime": "2013-07-18 08:17:13", // Date until the notification is valid. Can be null if no expiry date
"input_request": true,
"secret": "", // The push_endpoint_secret from the environment of the customer. Null if not set at the environment
"created": "2013-07-18 08:17:13", // Date when the input request was created
}

Possible values for "notification_type":

INPUT_REQUESTED = Any kind of user input is required, for example an answer to a security question (Example: What was your first pet?) or a 2-factor code. The actual input question can be found by the "input_request_id" which has been pushed to your system.

If push was successful and endpoint returned json '{"success": true}" we will remove the notification from the push queue and will not try to send it again.

Documents Fetch Interval

Here are some details about when a download is started how how long does it usually take:

After a customer supplier is created: It is immediately added to the download queue. Processed within 15-30 minutes depending on load in download queue. On failure a notification is created, on success we download documents and if documents are found they will be added to the documents queue.
Recurrend every 7 days: If a customer supplier is active we process it again every 7 days. As we only check for new invoices it should be ready within some hours. On failure a notification is created, on success we download documents and if documents are found they will be added to the documents queue.
After a customer supplier is updated: It is immediately added to the download queue. Processed within 15-30 minutes depending on load in download queue. On failure a notification is created, on success we download documents and if documents are found they will be added to the documents queue.
After a input request is submitted: The customer supplier is immediately added to the download queue. Processed within 15-30 minutes depending on load in download queue. On failure a notification is created, on success we download documents and if documents are found they will be added to the documents queue.

All intervals are per customer supplier and not per customer. In very rare cases it can take up to 24 hours to process a customer supplier depending on load in the download queue.

One example how intervals work:

1.) The customer adds a customer supplier for "supplier ABC" where he has 10 documents on january 1st. We start the download on january 1st. and fetch all possible documents. After fetch the 10 documents are added - one after another - to the documents queue and become available for fetch or push. After 7 days we check that customer supplier again to check for new documents.
2.) The same customer adds a customer supplier for "supplier XYZ" where he has 15 documents on january 2nd. We start the download on january 2nd. and fetch all possible documents. For some reason the supplier XYZ returns 14 pdfs and a html error page for one document. In this case we would fetch the 14 documents that are possible and add them - one after another - to the documents queue where they become available for fetch or push. After 7 days we check that customer supplier again and will try to get the missing document incl. looking for new documents.
3.) The same customer adds a customer supplier for "supplier DEF" with invalid credentials on february 1st. We start the download on february 1st. and detect the invalid credentials. A notification will be created and pushed. Two days later on february 3rd. the customer updates the credentials and the download is started on same day. In case it was successful we will start the 7 day interval and will try again on february 10th. In case the credentials are still invalid the notification flow will start again.

Document Push Details

After creation of a customer supplier this record is added to our download queue. On first fetch we check for all documents and download them. On later regularly check we only download documents not downloaded yet. After download the documents are added to the documents queue.

A background task will check every minute if there are documents in the documents queue. If documents are avilable in this queue one after the other are pushed to the documents push endpoint. If a document is pushed and we get the response {success: true} the document is removed from documents queue and not pushed again. In other cases we will try to push the document again in the next run.

Document Pull Details

You have to send requests to the API /getDocumentsQueue to check if documents are available for download. With API call /getDocument you are able to get the documents content. As the /getDocumentsQueue is limited to 100 records you have to use /removeDocumentFromQueue to remove the fetched documents from the documents queue in order to to get more documents.

Quick Feedback Flow

For some portals we are supporting the option to return an immediate feedback about the login status in under 60 seconds (in best case). This feature is not available for all portals. Portals which support it are flagged with "quick_feedback_supported" in the /listSuppliers API call.

To start the flow you use the /createCustomerSupplier API call and set the parameter "quick_feedback" to "true". It will return you a "feedback_process_uid". Using this ID you can query the function /getQuickFeedback to receive realtime information accordingly.

Password Encryption

When you are using the UI this part is not releavant. Any password that you submit to the API must be sent encrypted. The password should be encrypted using AES-256-CTR encryption algorithm. The encrypted password should then be base64 encoded afterwards.

Example:

$iv = openssl_random_pseudo_bytes(openssl_cipher_iv_length('aes-256-ctr'));
$encrypted_password = base64_encode(openssl_encrypt($password, 'aes-256-ctr', $encryption_key), true, $iv));

FAQ

Download Queue
The Download Queue is used internally to handle the document downloads from suppliers. For example: For some suppliers we can not download document from different customer suppliers parallel. Therefor we have a "Download Queue" where we have all customer suppliers that needs to be checked for documents so we can process those suppliers one after another.
Documents Queue
The Documents Queue is used to list all documents downloaded. It contains information regarding the meta data of a document and the document itself. Documents from this queue can be fetched via API call or can be pushed to you via documents push.
Supplier IDs
The supplier IDs will be different between the stage and the production system. Using cached data from stage on production will lead to invalid results.

Activate customer

Activate a customer that is currently deactivated.

/activateCustomer post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
customer_secret: required(string)
The customer_secret from api /createCustomer.
Example:
```
this_is_the_customer_secret_token
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: activateCustomer#1)
Customer does not exist. (Failure code: activateCustomer#2)
Customer secret does not match. (Failure code: activateCustomer#3)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "activateCustomer#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Service Unavailable The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. (Error code: general#503)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Create customer

Create a new customer.

/createCustomer post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

language: (string - default: en)
Set a language that is used in the dialogs for this customer.
Example:
```
de
```
timezone: (string - default: Europe/Berlin)
Set a timezone that is used in the dialogs for this customer. Does not affect the date values in this api. See list from api /listTimezones
Example:
```
Europe/Berlin
```
date_format: (string - default: m/d/Y)
Set a date format that is used in the dialogs for this customer. Does not affect the date values in this api. See list from api /listDateFormats
Example:
```
m/d/Y
```
default_download_start_date: (string)
Set a default download start date. Documents older than this date will not be downloaded. Can be overwritten in the /createCustomerSupplier api for a specific credential. System default is: Customer creation date minus 3 months.
Example:
```
2013-07-18
```
environment_prim_uid: (integer)
Our unique environment id. If not set the default environment is used.
Example:
```
144
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": {
        "prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents.
        "customer_secret": "this_is_the_customer_secret_token", // A secret token you have to use to get data for this customer.
        "access_token": "customer_access_token" // Access token used to authenticate the ui dialogs if they are used. It is valid for 24 hours and should be removed as soon as the user is redirected back to your application. <a href='#destroycustomersession_post'>/destroyCustomerSession</a> should be used to remove a access token.
    }
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Environment not found. (Failure code: createCustomer#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/createCustomerSupplier post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

customer_prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
supplier_prim_uid: required(integer)
Our unique supplier id from /listSuppliers.
Example:
```
200
```
active: required(boolean)
Set entry to active or not.
Example:
```
false
```
quick_feedback: (boolean)
Verify credential in realtime before saving.
Example:
```
false
```
download_start_date: (string)
Documents older than this date will not be downloaded. This overwrites the default_download_start_date from the /createCustomer api.
Example:
```
2013-07-18
```
download_interval: (integer - default: 7)
Interval in days where fetchdocs will automatically look for new documents. 0 will use the default interval for the supplier set by fetchdocs. -1 will disable the automated lookup.
Example:
```
7
```
notes: (string)
Set notes for the entry.
Example:
```
Notes for the entry
```
fields: required(string)
Json formatted string which contains data for suppliers extra fields from api call /getSupplierFields. See Password Encryption details on how to encrypt the password.
Example:
```
{"USERNAME": "client.username", "PASSWORD": "client.password"}
```
iv: required(string)
Initialization Vector for encrypted passwords. The initialization vector should then be base64 encoded afterwards.
Example:
```
abcdefghijklmnop
```
questions: (string)
Json formatted key-pair value which contains question id and answer for relevant questions from api call /getSupplierQuestions.
Example:
```
{"1000": "Answer", "1200": "Ansswer"}
```
return_url_system: (string)
Set entry to get return url for specific platform(Ex. Web or App). Possible values: web, ios, android
Example:
```
web
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "customer_supplier_prim_uid": 13,
}

If quick_feedback parameter is set as true
{
    "success": true,
    "quick_feedback_started": true,
    "feedback_process_uid": 12 // Will be required in other API call for Quick Feedback
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer prim uid not found. (Failure code: createCustomerSupplier#1)
Customer is not active. (Failure code: createCustomerSupplier#2)
Please provide supplier prim uid. (Failure code: createCustomerSupplier#3)
Supplier prim uid not found. (Failure code: createCustomerSupplier#4)
Supplier not active. (Failure code: createCustomerSupplier#5)
Fields is not a valid json string. (Failure code: createCustomerSupplier#6)
Unknown error while storing the customer supplier data. (Failure code: createCustomerSupplier#7)
Missing mandatory field "%field_key%". (Failure code: createCustomerSupplier#8)
IV is empty. (Failure code: createCustomerSupplier#9)
Missing required fields. (Failure code: createCustomerSupplier#10)
Supplier does not support Quick Feedback. (Failure code: createCustomerSupplier#11)
Answer should not be empty. (Failure code: createCustomerSupplier#12)
Invalid question prim_uid. (Failure code: createCustomerSupplier#13)
Supplier locked to UI as PSD2 license is required for API. (Failure code: createCustomerSupplier#14)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/createEnvironment post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

name: required(string)
Set a name for the environment so it can be identified easily.
Example:
```
Stage Environment
```
push_notification_url: required(string)
URL where the API pushes notification to.
Example:
```
https://push.domain.tld/notifications/
```
push_input_request_url: required(string)
URL where the API pushes input requests to.
Example:
```
https://push.domain.tld/input_request/
```
push_document_url: (string)
URL where the API pushes documents to. Only required when using document push.
Example:
```
https://push.domain.tld/documents/
```
ui_redirect_url: (string)
URL where the UI Plug&Play Integration redirects after adding a new customer supplier or updating one. Only required when using UI Plug&Play Integration.
Example:
```
https://app.domain.tld/back_from_ui_dialog/
```
ios_redirect_url: (string)
URL where the iOS App redirects after adding a new customer supplier or updating one. Only required when using iOS App.
Example:
```
https://app.domain.ios/back_from_app_dialog/
```
android_redirect_url: (string)
URL where the Android App redirects after adding a new customer supplier or updating one. Only required when using Android App.
Example:
```
https://app.domain.android/back_from_app_dialog/
```
default_environment: (boolean)
Is default environment. The API needs one default environment to map all customers to one if not set explicit in the /createCustomer call. If set to true it will be the new default environment.
Example:
```
false
```
shared_key: (string)
Shared key used in the checksum generation inside the hashed string when redirecting from UI. Only required when using UI Plug&Play Integration.
Example:
```
this_is_my_shared_key
```
shared_hash_key: (string)
Shared hash key used in the checksum generation as key to hash the string when redirecting from UI. Only required when using UI Plug&Play Integration.
Example:
```
this_is_my_shared_hash_key
```
push_endpoint_secret: (string)
A secret that can be set to any string and that will be pushed in all push endpoints.
Example:
```
this_is_my_push_endpoint_secret
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": {
        "prim_uid": 144, // Our unique environment id
    }
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Invalid url provided. (Failure code: createEnvironment#1)
Default environment is locked. (Failure code: createEnvironment#2)
Limit of 10 environments reached. (Failure code: createEnvironment#3)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Deactivate customer

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

/deactivateCustomer post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
customer_secret: required(string)
The customer_secret from api /createCustomer.
Example:
```
this_is_the_customer_secret_token
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer does not exist. (Failure code: deactivateCustomer#1)
Customer secret does not match. (Failure code: deactivateCustomer#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Delete customer

Delete a customer and all connected data.

/deleteCustomer post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
customer_secret: required(string)
The customer_secret from api /createCustomer.
Example:
```
this_is_the_customer_secret_token
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer does not exist. (Failure code: deleteCustomer#1)
Customer secret does not match. (Failure code: deleteCustomer#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/deleteEnvironment post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique environment id.
Example:
```
144
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Environment does not exist. (Failure code: deleteEnvironment#1)
Default environment can not be deleted. (Failure code: deleteEnvironment#2)
Environment with assigned customers can not be deleted. (Failure code: deleteEnvironment#3)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/destroyCustomerSession post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

access_token: required(string)
The access_token from api /createCustomer or /getCustomerSession
Example:
```
this_is_the_customer_secret_token
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using UI Plug&Play Integration. Following error codes reflect this:

This API not available on API integration (Error code: general#405#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#1",
    "detail": "This API not available on API integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Access token does not exist. (Failure code: destroyCustomerSession#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Delete customer supplier

Delete a customer supplier entry created by /createCustomerSupplier.

/deleteCustomerSupplier post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer supplier id from /createCustomerSupplier.
Example:
```
13
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer supplier does not exist. (Failure code: deleteCustomerSupplier#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Fill input request

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

/fillInputRequest post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique input request uid. This id is pushed to your system or available in /listCustomerSuppliers.
Example:
```
1
```
input_value: required(string)
The value for the input request.
Example:
```
abcdef
```
return_url_system: (string)
Set entry to get return url for specific platform(Ex. Web or App). Possible values: web, ios, android
Example:
```
web
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Input request expired. (Failure code: fillInputRequest#1)
Invalid customer supplier credential. (Failure code: fillInputRequest#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Fill Quick Feedback Request

Fill input request triggered by quick feedback process

/fillQuickFeedbackRequest post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

feedback_process_uid: required(integer)
Our unique quick feedback process id from /createCustomerSupplier.
Example:
```
1
```
two_fa_code: required(string)
Input Request value.
Example:
```
abcdef
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Missing required parameters. (Failure code: general#403)
Input request expired. (Failure code: getQuickFeedback#1)
No input request found. (Failure code: getQuickFeedback#2)
Quick Feedback is already completed. (Failure code: getQuickFeedback#3)
Invalid feedback process. (Failure code: getQuickFeedback#4)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/getCustomerAccountOverview post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": {
        "customer_data": {
            "prim_uid": 1, // Our unique customer id
            "language": "en", // The default customer language.
            "timezone": "Europe/Berlin", // The default timezone of the customer. See list from api /listTimezones
            "date_format": "m/d/Y" // The default date format of the customer. See list from api /listDateFormats
        },
        "customer_suppliers": [{ // list of suppliers where the customer account has set any credentials. Created by /createCustomerSupplier
            "prim_uid": 307,
            "name": "1&1.de"
        }]
    }
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#422)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#422"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/getCustomerSession post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
customer_secret: required(string)
The customer_secret from api /createCustomer.
Example:
```
this_is_the_customer_secret_token
```
language: (string - default: en)
Set a language that is used in the dialogs for this customer. If not set the langauge set in /createCustomer is used.
Example:
```
de
```
timezone: (string - default: Europe/Berlin)
Set a timezone that is used in the dialogs for this customer. Does not affect the date values in this api. Use list from api /listTimezones. If not set the timezone set in /createCustomer is used.
Example:
```
Europe/Berlin
```
date_format: (string - default: m/d/Y)
Set a date format that is used in the dialogs for this customer. Does not affect the date values in this api. Use list from api /listDateFormats. If not set the date format set in /createCustomer is used.
Example:
```
m/d/Y
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": {
        "prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents.
        "access_token": "customer_access_token" // Access token used to authenticate the ui dialogs. It is valid for 24 hours and should be removed as soon as the user is redirected back to your application. <a href='#destroycustomersession_post'>/destroyCustomerSession</a> should be used to remove a access token.
    }
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using UI Plug&Play Integration. Following error codes reflect this:

This API not available on API integration (Error code: general#405#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#1",
    "detail": "This API not available on API integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Missing required data. (Failure code: getCustomerSession#1)
Customer does not exist. (Failure code: getCustomerSession#2)
Customer secret does not match. (Failure code: getCustomerSession#3)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Get customer supplier

Get one customer supplier for a customer.

/getCustomerSupplier post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer supplier id.
Example:
```
1
```
with_supplier_logos: (boolean - default: false)
Set to true if result should contain base64 encoded supplier logo.
Example:
```
false
```
return_url_system: (string)
Set entry to get return url for specific platform(Ex. Web or App). Possible values: web, ios, android
Example:
```
web
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": {
        "prim_uid": 2355,
        "name": "1&1.de",
        "supplier_prim_uid": 307,
        "supplier_logo": "", // contains logo image base64 encoded
        "supplier_logo_url": "", // contains url to the supplier logo
        "active": true,
        "maintenance": true, // Maintenance period may vary depending on the supplier and issue. For this reason our support team can not give you any information about the duration of the maintenance.
        "input_request_prim_uid": 585, // is 0 in case that there is no imput request for this entry
        "download_start_date": "2013-07-18", // Documents older than this date will not be downloaded. Can be set in /createCustomer, /updateCustomer, /createCustomerSupplier, /updateCustomerSupplier or in the UI
        "download_interval": 7, // Interval in days. 0 is the default interval for the supplier set by fetchdocs. -1 is disable automated lookup.
        "last_started": "2013-07-18 08:17:13", // Last time the engine has checked for documents. Null if no process for this customer supplier has finished yet.
        "next_planned_run": "2013-07-18 10:00:00", // Next time the engine will automatically check for documents.
        "last_status_key": "PENDING", // Possible values: PENDING, LOGIN_SUCCESS, LOGIN_FAILED, INPUT_REQUESTED, NO_DOCUMENTS, NO_PERMISSION, ACCOUNT_NOT_READY, TEMP_TECHNICAL_ISSUE, NO_DOCUMENTS
        "username": "admin", // The username entered so customer can identify the customer supplier
        "document_type": "invoice" // currently "invoice" and "bank_statement" are supported
    }
}

Possible values for "last_status_key":
- PENDING = The engine is going to execute the fetch process for this credential for the first time soon.
- LOGIN_SUCCESS = The credential has been verified and download engine able to login.
- LOGIN_FAILED = The credential has been entered wrong or the user has changed its credentials meanwhile and needs to update them.
- INPUT_REQUESTED = Any kind of user input is required, for example an answer to a security question (Example: What was your first pet?) or a 2-factor code. The actual input question can be found by the "input_request_id" which has been pushed to your system.
- NO_DOCUMENTS = The download engine has been able to log into the website, but did not find any new documents.
- NO_PERMISSION = The download engine has been able to log into the website, but the user account is not allowed to access the Billing Page.
- ACCOUNT_NOT_READY = When the system tried to log into the account, the website requested some action from the user. The engine cannot complete this itself. The user must login and solve the blocker. Examples: Accepting changes of Terms, Confirming address is still valid, Account Status Migration
- TEMP_TECHNICAL_ISSUE = This could happen when the actual website was down, had a maintenance window or it takes time to solve a captcha in the website. No user action required, the engine will simply retry it later.

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Missing required data. (Failure code: getCustomerSupplier#1)
Customer supplier does not exist. (Failure code: getCustomerSupplier#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Get document

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

/getDocument post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique document id from /getDocumentsQueue.
Example:
```
173
```
customer_secret: required(string)
The customer_secret from api /createCustomer
Example:
```
this_is_the_customer_secret_token
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": {
        "prim_uid": 173,
        "customer_prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents. Same as in /createCustomer
        "customer_supplier_prim_uid": 13, // Our unique customer supplier id created in /createCustomerSupplier
        "supplier_prim_uid": 307, // Our unique supplier id from /listSuppliers
        "filename": "receipt-1708171523.pdf",
        "file_size": "136.75", // File size is always in KB
        "file_content_checksum": "", // md5 hash of file content (raw content, not base64 encoded content)
        "file_content": "", // base64 encoded file content
        "document_type": "invoice" // currently "invoice" and "bank_statement" are supported
    }
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using document push integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#405#4)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#4",
    "detail": "This API is not available on document push integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer does not exist. (Failure code: getDocument#1)
Customer secret does not match. (Failure code: getDocument#2)
Document does not exist. (Failure code: getDocument#3)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/getDocumentsQueue post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

environment_prim_uid: (integer)
Our unique environment id. The response is limited to the default environment in case nothing is set.
Example:
```
144
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": {
        "count": 100,
        "total": 2345,
        "documents": [{
            "prim_uid": 173, // Our unique document id that is required in api /getDocument
            "customer_prim_uid": 1, // Our unique customer id. This is needed to update the customer or assign any downloaded documents. Same as in /createCustomer
            "customer_supplier_prim_uid": 13, // Our unique customer supplier id created in /createCustomerSupplier
            "supplier_prim_uid": 307, // Our unique supplier id from /listSuppliers
            "filename": "receipt-1708171523.pdf",
            "file_size": 136.75, // File size is always in KB
            "file_content_checksum": "", // md5 hash of file content (raw content, not base64 encoded content)
            "document_type": "invoice" // currently "invoice" or "bank_statement" or "sales_invoice" are supported
        }]
    }
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using document push integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#405#4)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#4",
    "detail": "This API is not available on document push integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Environment does not exist. (Failure code: getDocumentsQueue#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Get supplier fields

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

/getSupplierFields post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique supplier id.
Example:
```
1
```
language: (string - default: en)
Set a language that is used for label and help text.
Example:
```
de
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": [
        {
            "field_key": "USERNAME",
            "label": "Username",
            "help_text": "Here can be any string that can be shown as a help text for the field",
            "mandatory": true,
            "type": "text", // Possible values: text, email, password, date, number, integer, single_select
            "dependency": ""
        }, {
            "field_key": "PASSWORD",
            "label": "Password",
            "help_text": "Here can be any string that can be shown as a help text for the field",
            "mandatory": true,
            "type": "password",
            "dependency": "USERNAME" // if not empty this field is required if field USERNAME is filled
        }, {
            "field_key": "LANG",
            "label": "Language",
            "help_text": "",
            "mandatory": false,
            "type": "dropdown",
            "dependency": "",
            "options": "{\"de_de\":\"Deutsch\",\"en_us\":\"English\"}"
        }
    ]
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Supplier does not exist. (Failure code: getSupplierFields#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Get supplier questions

Get all security questions for a supplier.

/getSupplierQuestions post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique supplier id.
Example:
```
1
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": [
        {
            "prim_uid": "1000",
            "question": "City your mother was born in?"
        }, {
            "prim_uid": "1200",
            "question": "First name of your first girlfriend?"
        }
    ]
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Supplier does not exist. (Failure code: getSupplierQuestions#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Get Quick Feedback

Get realtime infomration about quick feedback process. Client must wait for 30seconds before sending another request for same credential

/getQuickFeedback post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

feedback_process_uid: required(integer)
Our unique quick feedback process id from /createCustomerSupplier.
Example:
```
1
```
return_url_system: (string)
Set entry to get return url for specific platform(Ex. Web or App). Possible values: web, ios, android
Example:
```
web
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "state": "COMPLETED", // Possible Values: COMPLETED, RUNNING
    "customer_supplier_prim_uid": 1212, // Customer supplier prim uid only when process is completed
    "login_failed": false, // Optional: After process is completed, Credential is wrong.
    "login_success": true, // Optional: After process is completed, Credential validated successfully.
    "input_request": false, // Optional: If Two Factor Authorization code is required.
    "temp_technical_issue": false, // Optional: Some temporary technical issue. Credential will be stored and will be tried in background.
    "account_not_ready": false, // Optional: Credential validated, but further action is required from user.
    "no_permission": false, // Optional: Credential validated, but further action is required from user.
    "input_request_msg": false // Optional: If input_request 1, then it will contain input request message displayed on portal.
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Missing required parameters. (Failure code: general#403)
Invalid feedback process. (Failure code: getQuickFeedback#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

List customer accounts

List all customer accounts.

/listCustomerAccounts post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

environment_prim_uid: (integer)
Our unique environment id.
Example:
```
144
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": [{
        "prim_uid": 1, // Our unique customer id
        "language": "en", // The default customer language.
        "timezone": "Europe/Berlin", // The default timezone of the customer. See list from api /listTimezones
        "date_format": "m/d/Y", // The default date format of the customer. See list from api /listDateFormats
        "environment": 144 // The environment id the customer is assigned to
    }]
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Environment does not exist. (Failure code: listCustomerAccounts#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

List customer suppliers

List all customer suppliers for a customer.

/listCustomerSuppliers post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
with_supplier_logos: (boolean - default: false)
Set to true if result should contain base64 encoded supplier logos.
Example:
```
false
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": [
        {
            "prim_uid": 2355,
            "supplier_name": "1&1.de",
            "supplier_prim_uid": 307,
            "supplier_logo": "", // contains logo image base64 encoded
            "supplier_logo_url": "", // contains url to the supplier logo
            "active": true,
            "input_request_prim_uid": 585, // is 0 in case that there is no imput request for this entry
            "download_start_date": "2013-07-18", // Documents older than this date will not be downloaded. Can be set in /createCustomer, /updateCustomer, /createCustomerSupplier, /updateCustomerSupplier or in the UI
            "download_interval": 7, // Interval in days. 0 is the default interval for the supplier set by fetchdocs. -1 is disable automated lookup.
            "last_started": "2013-07-18 08:17:13", // Last time the engine has checked for documents. Null if no process for this customer supplier has finished yet.
            "next_planned_run": "2013-07-18 10:00:00", // Next time the engine will automatically check for documents.
            "last_status_key": "PENDING", // Possible values: PENDING, LOGIN_SUCCESS, LOGIN_FAILED, INPUT_REQUESTED, NO_DOCUMENTS, NO_PERMISSION, ACCOUNT_NOT_READY, TEMP_TECHNICAL_ISSUE
            "username": "admin", // The username entered so customer can identify the customer supplier
            "document_type": "invoice" // currently "invoice" and "bank_statement" are supported
        }
    ]
}

Possible values for "last_status_key":
- PENDING = The engine is going to execute the fetch process for this credential for the first time soon.
- LOGIN_SUCCESS = The credential has been verified and download engine able to login.
- LOGIN_FAILED = The credential has been entered wrong or the user has changed its credentials meanwhile and needs to update them.
- INPUT_REQUESTED = Any kind of user input is required, for example an answer to a security question (Example: What was your first pet?) or a 2-factor code. The actual input question can be found by the "input_request_id" which has been pushed to your system.
- NO_DOCUMENTS = The download engine has been able to log into the website, but did not find any new documents.
- NO_PERMISSION = The download engine has been able to log into the website, but the user account is not allowed to access the Billing Page.
- ACCOUNT_NOT_READY = When the system tried to log into the account, the website requested some action from the user. The engine cannot complete this itself. The user must login and solve the blocker. Examples: Accepting changes of Terms, Confirming address is still valid, Account Status Migration
- TEMP_TECHNICAL_ISSUE = This could happen when the actual website was down, had a maintenance window or it takes time to solve a captcha in the website. No user action required, the engine will simply retry it later.

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#422)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#422"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

List date formats

List all available date formats.

/listDateFormats post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": ["d.m.Y", "m/d/Y", "d/m/Y"]
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#422)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#422"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

List environments

List all environments.

/listEnvironments post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": [{
        "prim_uid": 1, // Our unique environment id
        "name": "Environment 1",
        "push_document_url": "",
        "push_notification_url": "",
        "push_input_request_url": "",
        "ui_redirect_url": "",
        "ios_redirect_url": "",
        "android_redirect_url": "",
        "default_environment": true
    }]
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#422)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#422"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

List suppliers

Get list of all suppliers.

/listSuppliers post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

with_supplier_logos: (boolean - default: false)
Set to true if result should contain base64 encoded supplier logos.
Example:
```
false
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": [{
        "prim_uid": 307,
        "name": "1&1.de",
        "created": "2018-02-12 12:52:38", // date when the supplier was added
        "supplier_login_url": "",
        "supplier_logo_url": "", // contains url to the supplier logo
        "supplier_logo": "", // contains logo image base64 encoded
        "document_type": "invoice", // currently "invoice" and "bank_statement" are supported
        "quick_feedback_supported": true,
        "script_implemented": true // details if the script is ready for download
    }]
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#422)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#422"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

List timezones

List all available timezones.

/listTimezones post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "data": ["Africa/Abidjan", "Africa/Accra", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Djibouti", "Africa/Douala", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Aruba", "America/Asuncion", "America/Barbados", "America/Belem", "America/Belize", "America/Bogota", "America/Boise", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/Fortaleza", "America/Godthab", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Vevay", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Lima", "America/Maceio", "America/Managua", "America/Manaus", "America/Martinique", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Miquelon", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/Nipigon", "America/Nome", "America/Noronha", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Recife", "America/Regina", "America/Santiago", "America/Scoresbysund", "America/Tegucigalpa", "America/Thule", "America/Tijuana", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Syowa", "Antarctica/Vostok", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Katmandu", "Asia/Krasnoyarsk", "Asia/Kuching", "Asia/Kuwait", "Asia/Magadan", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Faeroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Darwin", "Australia/Hobart", "Australia/Lindeman", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "CST6CDT", "EST", "EST5EDT", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Helsinki", "Europe/Istanbul", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/Simferopol", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vienna", "Europe/Vilnius", "Europe/Warsaw", "Europe/Zaporozhye", "Europe/Zurich", "HST", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "MST", "MST7MDT", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Ponape", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis"]
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#422)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#422"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Remove document from queue

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

/removeDocumentFromQueue post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique document id from /getDocumentsQueue.
Example:
```
173
```
customer_secret: required(string)
The customer_secret from api /createCustomer
Example:
```
this_is_the_customer_secret_token
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using document push integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#405#4)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#4",
    "detail": "This API is not available on document push integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer does not exist. (Failure code: removeDocumentFromQueue#1)
Customer secret does not match. (Failure code: removeDocumentFromQueue#2)
Document does not exist. (Failure code: removeDocumentFromQueue#3)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Set Quick Feedback Process As Background

Force Quick Feedback process to run in background and save credential

/setQuickFeedbackAsBackground post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

feedback_process_uid: required(integer)
Our unique quick feedback process id from /createCustomerSupplier.
Example:
```
1
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Missing required parameters. (Failure code: general#403)
Quick Feedback is already completed. (Failure code: setQuickFeedbackAsBackground#1)
Invalid feedback process. (Failure code: setQuickFeedbackAsBackground#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Start customer download process

Start adhoc download process for a customer supplier credential.

/startCustomerDownloadProcess post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer supplier credential id created in /createCustomerSupplier
Example:
```
13
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer supplier credential deactivated. (Failure code: startCustomerDownloadProcess#1)
Input request must be filled or triggered. (Failure code: startCustomerDownloadProcess#2)
Customer supplier does not exist. (Failure code: startCustomerDownloadProcess#3)
System is already running a process. (Failure code: startCustomerDownloadProcess#4)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Stop Quick Feedback Process

Stop quick feedback process

/stopQuickFeedback post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

feedback_process_uid: required(integer)
Our unique quick feedback process id from /createCustomerSupplier.
Example:
```
1
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Missing required parameters. (Failure code: general#403)
Quick Feedback is already completed. (Failure code: stopQuickFeedback#1)
Invalid feedback process. (Failure code: stopQuickFeedback#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Suggest supplier

Suggest a supplier that is not yet available.

/suggestSupplier post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

supplier_name: required(string)
The name of the supplier.
Example:
```
Amazon DE
```
supplier_url: required(string)
The url of the supplier.
Example:
```
http://amazon.de
```
comment: (string)
Optional comment.
Example:
```
Please add this supplier
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#422)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#422"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/test2FA post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer supplier id.
Example:
```
13
```
expiry_datetime: (string)
A date when the input request should expire. If not set the input request will never expire.
Example:
```
2013-07-18 08:17:13
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer supplier does not exist. (Failure code: test2FA#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/testNotification post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer supplier id.
Example:
```
13
```
status: required(string)
Notification status. Possible values: LOGIN_FAILED, NO_PERMISSION, ACCOUNT_NOT_READY, TEMP_TECHNICAL_ISSUE
Example:
```
LOGIN_FAILED
```
expiry_datetime: (string)
A date when the input request should expire. If not set the input request will never expire.
Example:
```
2013-07-18 08:17:13
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer supplier does not exist. (Failure code: testNotification#1)
Notification status invalid. (Failure code: testNotification#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Test Password Encryption

This endpoint can be used to test the password encryption.

/testPasswordEncryption post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

password_encrypted: required(string)
The encrypted password. Base64 encoded
iv: required(string)
The IV used in the password encryption. Base64 encoded.
password_compare: required(string)
The password that we should validate. Not encrypted but base64 encoded
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true,
    "detail": "Encrypted password matches the compare password.",
    "password_decrypted": "" // In error case this will contain the decrypted password as bas64 encoded string
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/testQueue post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
customer_supplier_uid: (integer)
Our unique customer supplier id. Can be set if you want to connect the test document to a specific customer supplier.
Example:
```
13
```
supplier_uid: (integer)
Our unique supplier id. Can be set if you want to connect the test document to a specific supplier.
Example:
```
1337
```
document_type: (string - default: pdf)
Type of the test document that should be generated. Possible values: pdf, html, csv
Example:
```
pdf
```
document_content_type: (string - default: invoice)
Content type of the test document that should be generated. Possible values: invoice, bank_statement, sales_invoice
Example:
```
invoice
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer does not exist. (Failure code: testQueue#1)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Trigger input request

Trigger a input request.

/triggerInputRequest post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer supplier credential id created in /createCustomerSupplier
Example:
```
13
```
input_request_prim_uid: required(integer)
Our unique input request id for example provided in /getCustomerSupplier
Example:
```
585
```
return_url_system: (string)
Set entry to get return url for specific platform(Ex. Web or App). Possible values: web, ios, android
Example:
```
web
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer supplier credential deactivated. (Failure code: triggerInputRequest#1)
Customer supplier credential invalid. (Failure code: triggerInputRequest#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

Update customer

Update a customer.

/updateCustomer post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
customer_secret: required(string)
The customer_secret from api /createCustomer.
Example:
```
this_is_the_customer_secret_token
```
language: (string - default: en)
Set a language that is used in the dialogs for this customer.
Example:
```
de
```
timezone: (string - default: Europe/Berlin)
Set a timezone that is used in the dialogs for this customer. Does not affect the date values in this api. See list from api /listTimezones
Example:
```
Europe/Berlin
```
date_format: (string - default: m/d/Y)
Set a date format that is used in the dialogs for this customer. Does not affect the date values in this api. See list from api /listDateFormats
Example:
```
m/d/Y
```
default_download_start_date: (string)
Set a default download start date. Documents older than this date will not be downloaded. Can be overwritten in the /createCustomerSupplier api for a specific credential. System default is: Customer creation date minus 3 months.
Example:
```
2013-07-18
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer not found. (Failure code: updateCustomer#1)
Customer secret do not match. (Failure code: updateCustomer#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/updateCustomerSupplier post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique customer supplier id.
Example:
```
13
```
customer_prim_uid: required(integer)
Our unique customer id.
Example:
```
1
```
active: required(boolean)
Set entry to active or not.
Example:
```
false
```
download_start_date: (string)
Documents older than this date will not be downloaded. This overwrites the default_download_start_date from the /createCustomer api.
Example:
```
2013-07-18
```
download_interval: (integer - default: 7)
Interval in days where fetchdocs will automatically look for new documents. 0 will use the default interval for the supplier set by fetchdocs. -1 will disable the automated lookup.
Example:
```
7
```
notes: (string)
Set notes for the entry.
Example:
```
Notes for the entry
```
fields: required(string)
Json formatted string which contains data for suppliers extra fields from api call /getSupplierFields. See Password Encryption details on how to encrypt the password.
Example:
```
{"USERNAME": "client.username", "PASSWORD": "client.password"}
```
iv: required(string)
Initialization Vector for encrypted passwords. The initialization vector should then be base64 encoded afterwards.
Example:
```
abcdefghijklmnop
```
questions: (string)
Json formatted key-pair value which contains question id and answer for relevant questions from api call /getSupplierQuestions.
Example:
```
{"1000": "Answer", "1200": "Ansswer"}
```
return_url_system: (string)
Set entry to get return url for specific platform(Ex. Web or App). Possible values: web, ios, android
Example:
```
web
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 405

Method Not Allowed

This API is only available when using API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#405#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#405#2",
    "detail": "This API is not available on UI Plug&Play Integration"
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Customer id not found. (Failure code: updateCustomerSupplier#1)
Customer supplier id is not connected with the customer id. (Failure code: updateCustomerSupplier#2)
Fields is not a valid json string. (Failure code: updateCustomerSupplier#3)
Unknown error while storing the customer supplier data. (Failure code: updateCustomerSupplier#4)
Missing mandatory field "%field_key%". (Failure code: updateCustomerSupplier#5)
IV is empty. (Failure code: updateCustomerSupplier#6)
Missing required fields. (Failure code: updateCustomerSupplier#7)
Answer should not be empty. (Failure code: updateCustomerSupplier#8)
Invalid question prim_uid. (Failure code: updateCustomerSupplier#9)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

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.

/updateEnvironment post

post

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

Request
Response

Body

Media type: application/json

Type: object

Properties

prim_uid: required(integer)
Our unique environment id.
Example:
```
144
```
name: (string)
Set a name for the environment so it can be identified easily.
Example:
```
Stage Environment
```
push_notification_url: (string)
URL where the API pushes notification to.
Example:
```
https://push.domain.tld/notifications/
```
push_input_request_url: (string)
URL where the API pushes input requests to.
Example:
```
https://push.domain.tld/input_request/
```
push_document_url: (string)
URL where the API pushes documents to. Only required when using document push.
Example:
```
https://push.domain.tld/documents/
```
ui_redirect_url: (string)
URL where the UI Plug&Play Integration redirects after adding a new customer supplier or updating one. Only required when using UI Plug&Play Integration.
Example:
```
https://app.domain.tld/back_from_ui_dialog/
```
ios_redirect_url: (string)
URL where the iOS App redirects after adding a new customer supplier or updating one. Only required when using iOS App.
Example:
```
https://app.domain.ios/back_from_app_dialog/
```
android_redirect_url: (string)
URL where the Android App redirects after adding a new customer supplier or updating one. Only required when using Android App.
Example:
```
https://app.domain.android/back_from_app_dialog/
```
default_environment: (boolean)
Is default environment. The API needs one default environment to map all customers to one if not set explicit in the /createCustomer call. If set to true it will be the new default environment.
Example:
```
false
```
shared_key: (string)
Shared key used in the checksum generation inside the hashed string when redirecting from UI. Only required when using UI Plug&Play Integration.
Example:
```
this_is_my_shared_key
```
shared_hash_key: (string)
Shared hash key used in the checksum generation as key to hash the string when redirecting from UI. Only required when using UI Plug&Play Integration.
Example:
```
this_is_my_shared_hash_key
```
push_endpoint_secret: (string)
A secret that can be set to any string and that will be pushed in all push endpoints.
Example:
```
this_is_my_push_endpoint_secret
```
api_key: required(string)
Your unique API Key to access & authenticate against the API Service.
Example:
```
XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
```
api_checksum: (string)
A checksum of all request parameters. Only required and needed if this feature is activated. Pre-Shared key will be used to validate the checksum.
Example:
```
730f85ef247a6c30eeab440b8893a0ee
```

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
    "success": true
}

HTTP status code 403

Possible API errors:

Missing required parameters. (Error code: general#403)
API Key does not exist. (Error code: general#403#1)
API Key is blocked. (Error code: general#403#2)
Access of API key is restricted by selected IPs (Error code: general#403#3)
API Checksum missing. (Error code: general#403#4)
API Checksum could not be validated. (Error code: general#403#5)

Some APIs are only available when using UI Plug&Play Integration and some only when using ony API integration. Following error codes reflect this:

This API is not available on UI Plug&Play Integration (Error code: general#403#4)
This API is not available on API integration (Error code: general#403#5)

Some APIs are only available when using document push or document queue integration. Following error codes reflect this:

This API is not available on document push integration (Error code: general#403#6)
This API is not available on document queue integration (Error code: general#403#7)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#403",
    "detail": "Missing required parameters."
}

HTTP status code 415

Content-Type of all requests should be application/json (Error code: general#415)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#415",
    "detail": "Content-Type of all requests should be application/json"
}

HTTP status code 422

Request could not be processed. Details will be provided within the response which also contains an unique error code for this API call.

Possible failures:

An unexpected error occourd. (Failure code: general#1)
Invalid url provided. (Failure code: updateEnvironment#1)
Environment not found. (Failure code: updateEnvironment#2)
Default environment is locked. (Failure code: createEnvironment#3)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "detail": "An unexpected error occourd.",
    "code": "general#1"
}

HTTP status code 429

API limits exceeded:

Daily limit is exceeded (Error code: general#429#1)
Requests per minute limit is exceeded (Error code: general#429#2)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#429#1",
    "detail": "Daily limit is exceeded"
}

HTTP status code 501

Either request does not have any valid required parameters or invalid action. (Error code: general#501)

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#501",
    "detail": "Either request does not have any valid required parameters or invalid action."
}

HTTP status code 503

Body

Media type: application/json

Type: any

Example:

{
    "success": false,
    "code": "general#503",
    "detail": "Service Unavailable"
}

fetchdocs.io - Fetch API documentation version v1

Activate customer

post /activateCustomer

Body

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 415

Body

HTTP status code 422

Body

HTTP status code 429

Body

HTTP status code 501

Body

HTTP status code 503

Body

Create customer

post /createCustomer

Body

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 415

Body

HTTP status code 422

Body

HTTP status code 429

Body

HTTP status code 501

Body

HTTP status code 503

Body

Create customer supplier

post /createCustomerSupplier

Body

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 405

Body

HTTP status code 415

Body

HTTP status code 422

Body

HTTP status code 429

Body

HTTP status code 501

Body

HTTP status code 503

Body

Create environment

post /createEnvironment

Body

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 415

Body

HTTP status code 422

Body

HTTP status code 429

Body

HTTP status code 501

Body

HTTP status code 503

Body

Deactivate customer

post /deactivateCustomer

Body

HTTP status code 200

Body

HTTP status code 403

Body

HTTP status code 415

Body