ConnectRequest

Starts connection process for a business registry

This API starts the connection process for a business registry. During this process the user will be redirected to a page where it will be possible to choose the bank to connect to.

SecurityBearer
Request
path Parameters
fiscalId
required
string
Request Body schema: application/json
required

The new ConnectRequest resource

locale
string or null

A valid ISO 639-1 locale code, 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.

(string or null)

A valid ISO-3166-1 Alpha-2 code (https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) plus the fake XF country for tests in sandbox

days
integer or null [ 1 .. 180 ]

Number of days for which to grant consent (between 1 and 180). If you omit this parameter the maximum value will be assumed.

returnUrl
string or null <uri>

Optional URL for the customer to return to after a connection

http://schema.org/url
bankManagerEmail
string or null <email>

Optional email of the bank manager that will connect bank accounts to this Business Registry

http://schema.org/email
Responses
201

ConnectRequest resource created

400

Invalid input

422

Unprocessable entity

post/business-registry/{fiscalId}/connect
Request samples
application/json
{
  • "locale": "it",
  • "country": "IT",
  • "days": 180,
  • "returnUrl": "http://example.com",
  • "bankManagerEmail": "accounting@example.com"
}
Response samples
application/json
{
  • "connectUrl": "string"
}