BusinessRegistry

Retrieves the collection of BusinessRegistry resources.

Retrieves the collection of BusinessRegistry resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses
200

BusinessRegistry collection

get/business-registry
Request samples 
Response samples 
[
  • {
    }
]
Creates a new Business Registry (a fee will be charged)
Creates a new Business Registry (a fee will be charged).
                Please note that the default value of the enabled is false. Add an explicit setting to the payload if you prefer to create an enabled entity.


SecurityBearer 
Request 
Request Body schema: 
required
The new BusinessRegistry resource


fiscalId
required
string  [ 1 .. 32 ] characters 
 
businessName
required
string
Business name, it cannot be omitted when creating data


 
email
required
string <email> 
It is not possible to use the same email for two different business registries


 
http://schema.org/email
emailAlerts
boolean or null
If set to true an email will be sent automatically to this business registry when a connect URL is requested and every time a reconnect will be necessary


 
locale
string or null
A valid ISO 639-1 locale code. It will be used as a default language for presenting data to the user. Possible values are: bg, cz, de, en, es-MX, es, fi, fr, he, hr, hu, it, nl, pl, pt-BR, pt, ro, ru, si, sk, tr, uk, zh-HK(Traditional), zh(Simplified). Defaults to en.


 
country
string or null
A valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes). Financial institutions listed during connection will be filtered using this parameter.


 
enabled
boolean or null
 
Responses 
201
BusinessRegistry resource created


400
Invalid input


422
Unprocessable entity


post/business-registry
Request samples 
{
  • "fiscalId": "string",
  • "businessName": "string",
  • "email": "user@example.com",
  • "emailAlerts": true,
  • "locale": "it",
  • "country": "IT",
  • "enabled": true
}
Response samples 
{
  • "fiscalId": "string",
  • "email": "string",
  • "businessName": "string",
  • "enabled": false,
  • "emailAlerts": true,
  • "locale": "string",
  • "country": "string",
  • "subAccountId": 0
}
Retrieves a BusinessRegistry resource.
Retrieves a BusinessRegistry resource.


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
 
Responses 
200
BusinessRegistry resource


404
Resource not found


get/business-registry/{fiscalId}
Request samples 
Response samples 
{
  • "fiscalId": "string",
  • "email": "string",
  • "businessName": "string",
  • "enabled": false,
  • "emailAlerts": true,
  • "locale": "string",
  • "country": "string",
  • "subAccountId": 0
}
Changes a Business Registry (with the exception of e-mail).
Changes a Business Registry. Please note that it is not possible to replace the e-mail


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
 
Request Body schema: 
required
The updated BusinessRegistry resource


businessName
string
Business name, it can be omitted when updating data


 
emailAlerts
boolean or null
If set to true an email will be sent automatically to this business registry when a connect URL is requested and every time a reconnect will be necessary


 
locale
string or null
A valid ISO 639-1 locale code. It will be used as a default language for presenting data to the user. Possible values are: bg, cz, de, en, es-MX, es, fi, fr, he, hr, hu, it, nl, pl, pt-BR, pt, ro, ru, si, sk, tr, uk, zh-HK(Traditional), zh(Simplified). Defaults to en.


 
country
string or null
A valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes). Financial institutions listed during connection will be filtered using this parameter.


 
enabled
boolean or null
 
Responses 
200
BusinessRegistry resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/business-registry/{fiscalId}
Request samples 
{
  • "businessName": "string",
  • "emailAlerts": true,
  • "locale": "it",
  • "country": "IT",
  • "enabled": true
}
Response samples 
{
  • "fiscalId": "string",
  • "email": "string",
  • "businessName": "string",
  • "enabled": false,
  • "emailAlerts": true,
  • "locale": "string",
  • "country": "string",
  • "subAccountId": 0
}
Removes a Business registry
Removal of a business registry involves deletion of data on his accounts and transactions, as well as withdrawal of consent to access the data.


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
 
Responses 
204
BusinessRegistry resource deleted


404
Resource not found


delete/business-registry/{fiscalId}
Request samples 
Lists all the Bank Managers linked to the Business Registry
Lists all the Bank Managers linked to the Business Registry, having permissions to assign Accounts to it.


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
 
query Parameters
page
integer
 Default:  1
The collection page number


 
itemsPerPage
integer  [ 0 .. 100 ] 
 Default:  30
The number of items per page


 
Responses 
200
BusinessRegistry collection


get/business-registry/{fiscalId}/bank-managers
Request samples 
Response samples 
[
  • {
    }
]
Link a new Bank Manager the Business Registry
Link a new Bank Manager the Business Registry, hereby granting them permission to assign Accounts to it.


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
 
Request Body schema: 
required
The new BusinessRegistry resource


email
required
Responses 
204
BusinessRegistry resource created


400
Invalid input


422
Unprocessable entity


post/business-registry/{fiscalId}/bank-managers
Request samples 
{
  • "email": "user@example.com"
}
Response samples 
null
Gets branding data for a Business Registry
Gets branding data for a Business Registry


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
BusinessRegistry identifier


 
Responses 
200
BusinessRegistry resource


404
Resource not found


get/business-registry/{fiscalId}/branding
Request samples 
Response samples 
{
  • "brandName": "string",
  • "contactEmail": "user@example.com",
  • "contactPhone": "string"
}
Updates branding data for a Business Registry
Updates branding data for a Business Registry..


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
BusinessRegistry identifier


 
Request Body schema: 
required
The updated BusinessRegistry resource


brandName
string or null
Brand name, it can be omitted when updating data


 
contactEmail
string or null <email> 
E-mail that will be displayed on documents


 
http://schema.org/email
contactPhone
string or null
Contact phone, it can be omitted when updating data


 
Responses 
200
BusinessRegistry resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/business-registry/{fiscalId}/branding
Request samples 
{
  • "brandName": "string",
  • "contactEmail": "user@example.com",
  • "contactPhone": "string"
}
Response samples 
{
  • "brandName": "string",
  • "contactEmail": "user@example.com",
  • "contactPhone": "string"
}
Displays status of auto-renew for subscriptions
Displays status of auto-renew for subscriptions.


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
BusinessRegistry identifier


 
Responses 
200
BusinessRegistry resource


404
Resource not found


get/business-registry/{fiscalId}/subscription
Request samples 
Response samples 
{
  • "autoRenew": true
}
Enables or disables auto-renew of subscriptions
Enables or disables auto-renew of subscriptions. This feature cannot be performed by sub-accounts.


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
BusinessRegistry identifier


 
Request Body schema: 
required
The updated BusinessRegistry resource


autoRenew
boolean
 
Responses 
200
BusinessRegistry resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/business-registry/{fiscalId}/subscription
Request samples 
{
  • "autoRenew": true
}
Response samples 
{
  • "autoRenew": true
}
Creates a new user sub account for the business registry
Creates a new user sub account for the business registry. 
                See also the authentication documentation


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
BusinessRegistry identifier


 
Request Body schema: 
required
The new BusinessRegistry resource


password
required
string^((?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[!@#\...
The new user password


 
Responses 
204
BusinessRegistry resource created


400
Invalid input


422
Unprocessable entity


post/business-registry/{fiscalId}/user
Request samples 
{
  • "password": "string"
}
Response samples 
null
Removes the user sub account assignment for the business registry
Removes the user sub account assignment for the business registry


SecurityBearer 
Request 
path Parameters
fiscalId
required
string
BusinessRegistry identifier


 
Responses 
204
BusinessRegistry resource deleted


404
Resource not found


delete/business-registry/{fiscalId}/user
Request samples