API docs by Redocly

faire.ai Platform (1.0.0)

Download OpenAPI specification:Download

faire.ai: info@faire.ai URL: https://faire.ai

The following document contains the documentation of faire.ai Platform.

Please, contact us at info@faire.ai if you want to try the Platform and get the credentials to call the API in test or production environments.

persons

Persons operations.

Create a person.

Register a new person to the Platform.

Authorizations:
openId
Request Body schema: application/json
personId
required
string

Unique identifier of a person.

firstName
required
string

First name.

lastName
required
string

Last name.

emailAddress
required
string <email>

Email address.

dateOfBirth
required
string <date>

Date of birth.

required
object (Place of birth)
gender
string
Enum: "MALE" "FEMALE"

Gender.

citizenship
required
string

Citizenship represented with ISO 3166-1 alpha-2 code of the coutry.

fiscalCode
required
string

Fiscal code.

object (Address)
object (Address)
phoneNumber
string

Phone number represented with E.164 standard.

creator
string

Creator of the person. Defaults to the partner identifier.

Responses

Request samples

Content type
application/json
{
  • "personId": "123e4567-e89b-12d3-a456-426614174000",
  • "firstName": "John",
  • "lastName": "Doe",
  • "emailAddress": "john.doe@example.com",
  • "dateOfBirth": "2000-07-21",
  • "placeOfBirth": {
    },
  • "gender": "MALE",
  • "citizenship": "IT",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "homeAddress": {
    },
  • "domicileAddress": {
    },
  • "phoneNumber": "+39XXXXXXXXXX",
  • "creator": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "personId": "123e4567-e89b-12d3-a456-426614174000",
  • "firstName": "John",
  • "lastName": "Doe",
  • "emailAddress": "john.doe@example.com",
  • "dateOfBirth": "2000-07-21",
  • "placeOfBirth": {
    },
  • "gender": "MALE",
  • "citizenship": "IT",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "homeAddress": {
    },
  • "domicileAddress": {
    },
  • "phoneNumber": "+39XXXXXXXXXX",
  • "creator": "123e4567-e89b-12d3-a456-426614174000"
}

Get all persons.

Return all the data of the persons registered by the partner to the Platform.

Authorizations:
openId
query Parameters
creator
string
Example: creator=123e4567-e89b-12d3-a456-426614174000

Creator of the person.

Responses

Response samples

Content type
application/json
{
  • "persons": [
    ]
}

Get a person.

Return the data of a single person registered by the partner to the Platfom.

Authorizations:
openId
path Parameters
personId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Unique identifier of a person.

Responses

Response samples

Content type
application/json
{
  • "personId": "123e4567-e89b-12d3-a456-426614174000",
  • "firstName": "John",
  • "lastName": "Doe",
  • "emailAddress": "john.doe@example.com",
  • "dateOfBirth": "2000-07-21",
  • "placeOfBirth": {
    },
  • "gender": "MALE",
  • "citizenship": "IT",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "homeAddress": {
    },
  • "domicileAddress": {
    },
  • "phoneNumber": "+39XXXXXXXXXX",
  • "creator": "123e4567-e89b-12d3-a456-426614174000"
}

Update a person.

Update the data of an existing person.

Authorizations:
openId
path Parameters
personId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Unique identifier of a person.

Request Body schema: application/json
personId
required
string

Unique identifier of a person.

firstName
required
string

First name.

lastName
required
string

Last name.

emailAddress
required
string <email>

Email address.

dateOfBirth
required
string <date>

Date of birth.

required
object (Place of birth)
gender
string
Enum: "MALE" "FEMALE"

Gender.

citizenship
required
string

Citizenship represented with ISO 3166-1 alpha-2 code of the coutry.

fiscalCode
required
string

Fiscal code.

object (Address)
object (Address)
phoneNumber
string

Phone number represented with E.164 standard.

creator
string

Creator of the person. Defaults to the partner identifier.

Responses

Request samples

Content type
application/json
{
  • "personId": "123e4567-e89b-12d3-a456-426614174000",
  • "firstName": "John",
  • "lastName": "Doe",
  • "emailAddress": "john.doe@example.com",
  • "dateOfBirth": "2000-07-21",
  • "placeOfBirth": {
    },
  • "gender": "MALE",
  • "citizenship": "IT",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "homeAddress": {
    },
  • "domicileAddress": {
    },
  • "phoneNumber": "+39XXXXXXXXXX",
  • "creator": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "personId": "123e4567-e89b-12d3-a456-426614174000",
  • "firstName": "John",
  • "lastName": "Doe",
  • "emailAddress": "john.doe@example.com",
  • "dateOfBirth": "2000-07-21",
  • "placeOfBirth": {
    },
  • "gender": "MALE",
  • "citizenship": "IT",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "homeAddress": {
    },
  • "domicileAddress": {
    },
  • "phoneNumber": "+39XXXXXXXXXX",
  • "creator": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a person.

Delete a person and all its data persisted on the Platform.

Authorizations:
openId
path Parameters
personId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Unique identifier of a person.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

accounts

Accounts operations.

Create new account.

Register a new bank account of a person or business within the Platform.

Authorizations:
openId
Request Body schema: application/json
accountId
string
personId
string

Unique identifier of a person. Only one of personId or businessId must be specified.

businessId
string

Unique identifier of a business. Only one of personId or businessId must be specified.

financialInstitutionName
string
iban
required
string
currency
string
bookedBalance
string

Booked balance.

holders
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accountId": "a1b2c3",
  • "personId": "c6a7fe4e-5fc0-11eb-ae93-0242ac130002",
  • "businessId": "e734f071-2520-4b6b-8d06-a98bed378c32",
  • "financialInstitutionName": "Example Bank",
  • "iban": "BE71096123456769",
  • "currency": "EUR",
  • "bookedBalance": "1500.00",
  • "holders": [
    ]
}

Response samples

Content type
application/json
{
  • "accountId": "a1b2c3",
  • "personId": "c6a7fe4e-5fc0-11eb-ae93-0242ac130002",
  • "businessId": "e734f071-2520-4b6b-8d06-a98bed378c32",
  • "financialInstitutionName": "Example Bank",
  • "iban": "BE71096123456769",
  • "currency": "EUR",
  • "bookedBalance": 1500,
  • "availableBalance": 1500,
  • "holders": [
    ],
  • "operativity": "OPERATIVE"
}

Get accounts of a person or business.

Return all the bank accounts data of a person or business registered on the Platform. Only one of the two parameters personId and businessId must be specified.

Authorizations:
openId
query Parameters
personId
string
Example: personId=123e4567-e89b-12d3-a456-426614174000
businessId
string
Example: businessId=123e4567-e89b-12d3-a456-426614174000

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

Get account.

Return all the data of a bank account.

Authorizations:
openId
path Parameters
accountId
required
string
Example: a1b2c3

Responses

Response samples

Content type
application/json
{
  • "accountId": "a1b2c3",
  • "personId": "c6a7fe4e-5fc0-11eb-ae93-0242ac130002",
  • "businessId": "e734f071-2520-4b6b-8d06-a98bed378c32",
  • "financialInstitutionName": "Example Bank",
  • "iban": "BE71096123456769",
  • "currency": "EUR",
  • "bookedBalance": 1500,
  • "availableBalance": 1500,
  • "holders": [
    ],
  • "operativity": "OPERATIVE"
}

Delete account.

Delete a bank account and all its data.

Authorizations:
openId
path Parameters
accountId
required
string
Example: a1b2c3

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update account operativity.

Set the operativity of the bank account.

Authorizations:
openId
path Parameters
accountId
required
string
Example: a1b2c3
Request Body schema: application/json
operativity
required
string

Describes account operativity.

  • OPERATIVE means the account is operative.
  • NOT_OPERATIVE means the account is not operative.
  • UNKNOWN means that it is unknown if the account is operative.
availableBalance
string

Available balance of the account.

Responses

Request samples

Content type
application/json
{
  • "operativity": "OPERATIVE",
  • "availableBalance": "10.05"
}

Response samples

Content type
application/json
"string"

Add transaction to existing account.

Add a transaction to an existing bank account.

Authorizations:
openId
path Parameters
accountId
required
string
Example: a1b2c3
Request Body schema:
transactionId
required
string
bookingDate
string <date-time>
valueDate
required
string <date-time>
currency
required
string
amount
required
string
description
string
mainCategory
string
Default: "OTHER"
subCategory
string
Default: "OTHER"
recurrenceType
required
string
Enum: "NONE" "UNKNOWN" "DEFINED"

Describes this transaction's recurrence.

  • NONE means that transaction is not recurrent.
  • UNKNOWN means that it is unknown if the transaction is recurrent.
  • DEFINED means that transaction is recurrent and recurrencePeriod can be specified.
recurrencePeriod
string

Can be specified only if recurrenceType is set to DEFINED

merchantName
string
mcc
string = 4 characters

The merchant category code

Responses

Request samples

Content type
{
  • "transactionId": "121212",
  • "bookingDate": "2021-01-21T08:17:06.432Z",
  • "valueDate": "2021-01-21T08:17:06.432Z",
  • "currency": "EUR",
  • "amount": "22.0",
  • "description": "Rent bill",
  • "mainCategory": "BILLS_SUBSCRIPTIONS",
  • "subCategory": "BILLS",
  • "recurrenceType": "DEFINED",
  • "recurrencePeriod": "P1M",
  • "merchantName": "Merchant",
  • "mcc": "0742"
}

Response samples

Content type
application/json
{
  • "accountId": "a1b2c3",
  • "transactionId": "121212",
  • "bookingDate": "2021-01-21T08:17:06.432",
  • "valueDate": "2021-01-21T08:17:06.432",
  • "currency": "EUR",
  • "amount": 150,
  • "description": "Car rent bill",
  • "mainCategory": "BILLS_SUBSCRIPTIONS",
  • "subCategory": "BILLS",
  • "recurrenceType": "DEFINED",
  • "recurrencePeriod": "PT10H",
  • "merchantName": "Merchant",
  • "mcc": "0742"
}

Get transactions by accounts.

Return all the transactions of the bank account(s) specified by accountId parameter.

Authorizations:
openId
path Parameters
accountId
required
Array of strings
Example: a1b2c3

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Update transaction recurrence.

Set/Update the recurrency of a transaction.

Authorizations:
openId
path Parameters
accountId
required
string
Example: a1b2c2
transactionId
required
string
Example: 121212
Request Body schema: application/json
recurrenceType
required
string
Enum: "NONE" "UNKNOWN" "DEFINED"

Describes this transaction's recurrence.

  • NONE means that transaction is not recurrent.
  • UNKNOWN means that it is unknown if the transaction is recurrent.
  • DEFINED means that transaction is recurrent and recurrencePeriod can be specified.
recurrencePeriod
string

Responses

Request samples

Content type
application/json
{
  • "recurrenceType": "DEFINED",
  • "recurrencePeriod": "P1M"
}

Response samples

Content type
application/json
"string"

Update transaction category.

Set/Update the category of a transaction.

Authorizations:
openId
path Parameters
accountId
required
string
Example: a1b2c3
transactionId
required
string
Example: 121212
Request Body schema: application/json
mainCategory
required
string

Main category of the transaction. If both mainCategory and subCategory are not provided, automatic categorisation will be triggered. If only one of mainCategory and subCategory is provided, the request will fail. If both mainCategory and subCategory are provided, the request will succeed and categorisation won't be triggered.

subCategory
required
string

Sub-category of the transaction.

Responses

Request samples

Content type
application/json
{
  • "mainCategory": "BILLS_SUBSCRIPTIONS",
  • "subCategory": "BILLS"
}

Response samples

Content type
application/json
"string"

List all categories.

Return the list of all the categories that can be assigned to a transaction. If no owningEntityId is specified, the operation returns all the categories of a personal account.

Authorizations:
openId
query Parameters
owningEntityId
string
Example: owningEntityId=PERSON,BUSINESS

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

List all personal categories.

Return the list of all the categories that can be assigned to a transaction of a personal account.

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

List all business categories.

Return the list of all the categories that can be assigned to a transaction of a business account.

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

account connection

Account connection operations.

Initialize account connection

Initialize a new account connection for a given person.

Authorizations:
openId
Request Body schema: application/json

Account connection parameters.

personId
string

Identifier of the person

onSuccessUrl
string

Customer redirect link for successful connection

onFailureUrl
string

Customer redirect link for failed connection

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Return all account connections

Return all the account connections.

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "accountConnections": [
    ]
}

Return an account connection

Return an account connection given its identifier.

Authorizations:
openId
path Parameters
id
required
string

Account connection identifier

Responses

Response samples

Content type
application/json
{}

kpis

KPIs analytics operations.

Get person or account KPIs.

Return the KPIs of an account or a person.

By specifying atReferenceDate query parameter, the operation returns all KPIs at reference date.

Note. Either accountId or personId or businessId must be specified in the request.

Authorizations:
openId
query Parameters
personId
string

Unique identifier of the person to retrieve the KPI of.

accountId
string

Unique identifier of the account to retrieve the KPIs of.

businessId
string

Unique identifier of the business to retrieve the KPIs of.

kpi
string
Example: kpi=MONTHLY_TOTAL_OUTFLOW_MEAN

Name of the KPI to filter by.

atReferenceDate
string <date>
Example: atReferenceDate=2021-12-22

Reference date for which the KPIs are requested.

Responses

Response samples

Content type
application/json
{
  • "kpis": [
    ]
}

List all available KPIs.

Return the list of all the KPIs that the Platform provides for persons and accounts grouped by the following categories:

  • person characterization;
  • account characterization;
  • wealth indicators;
  • spending indicators;
  • liabilities indicators;
  • risk indicators;
  • financial health indicators.

To know the list of the KPIs, please, contact us at info@faire.ai.

Authorizations:
openId

Responses

Response samples

Content type
application/json
{
  • "kpis": [
    ]
}

Get monitoring KPIs.

Return the monitoring KPIs of a business.

Authorizations:
openId
query Parameters
businessId
required
string

Identifier of the business to retrieve the monitoring KPIs of.

atReferenceDate
string <date>
Example: atReferenceDate=2021-12-22

Reference date of requested KPIs. Default is the current date.

Responses

Response samples

Content type
application/json
{
  • "kpis": [
    ]
}

loan-products

Loan products operations.

Create a loan product.

Create a new loan product in the Platform.

Authorizations:
openId
Request Body schema: application/json
name
required
string

Loan product name

currency
required
string

Currency of the loan product

status
required
string
Enum: "ACTIVE" "INACTIVE"

Status of the loan product

required
Array of objects (Contition)
Array of objects (Fee)
object (Activation)
tags
Array of strings

Tags of the loan product

financialInstitution
required
string

The name of the financial institution for which the loan product has been created

loanPurposes
Array of strings (Loan purpose)
Items Enum: "INVESTMENT" "LIQUIDITY" "PURCHASE"

Responses

Request samples

Content type
application/json
{
  • "name": "Fast loan",
  • "currency": "EUR",
  • "status": "ACTIVE",
  • "conditions": [
    ],
  • "fees": [
    ],
  • "scheduledActivation": {
    },
  • "tags": [
    ],
  • "financialInstitution": "Faire Bank",
  • "loanPurposes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Fast loan",
  • "currency": "EUR",
  • "status": "ACTIVE",
  • "conditions": [
    ],
  • "fees": [
    ],
  • "scheduledActivation": {
    },
  • "tags": [
    ],
  • "financialInstitution": "Faire Bank",
  • "loanPurposes": [
    ]
}

Get all loan products.

Return all the loan products created by the partner in the Platform.

Authorizations:
openId
query Parameters
loanProductStatus
string
Enum: "ACTIVE" "INACTIVE"
Example: loanProductStatus=ACTIVE

The status of th loan product

tag
Array of strings
Example: tag=tag1,tag2

Specify multiple tags to filter loan products, separating them with commas. Only loan products with all specified tags will be returned.

loanPurposes
Array of strings
Items Enum: "PURCHASE" "LIQUIDITY" "INVESTMENT"
Example: loanPurposes=PURCHASE,LIQUIDITY

List of purposes to filter loan products by purpose. If more than one purpose is specified, then the operation returns the loan products that have at least one of them.

Values are comma-separated.

Responses

Response samples

Content type
application/json
{
  • "loanProducts": [
    ]
}

Get a loan product.

Return a loan product by its unique identifier.

Authorizations:
openId
path Parameters
loanProductId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Unique identifier of a loan product.

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Fast loan",
  • "currency": "EUR",
  • "status": "ACTIVE",
  • "conditions": [
    ],
  • "fees": [
    ],
  • "scheduledActivation": {
    },
  • "tags": [
    ],
  • "financialInstitution": "Faire Bank",
  • "loanPurposes": [
    ]
}

Update loan product.

Update a loan product. The loan product can be updated if is not active or activated in the past.

Authorizations:
openId
path Parameters
loanProductId
required
string <uuid>
Request Body schema: application/json
name
required
string

Loan product name

required
Array of objects (Contition)
Array of objects (Fee)
object (Activation)

Responses

Request samples

Content type
application/json
{
  • "name": "Fast loan",
  • "conditions": [
    ],
  • "fees": [
    ],
  • "scheduledActivation": {
    }
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Fast loan",
  • "currency": "EUR",
  • "status": "ACTIVE",
  • "conditions": [
    ],
  • "fees": [
    ],
  • "scheduledActivation": {
    },
  • "tags": [
    ],
  • "financialInstitution": "Faire Bank",
  • "loanPurposes": [
    ]
}

Change loan product scheduled activation.

Change loan product scheduled activation.

Authorizations:
openId
path Parameters
loanProductId
required
string
Request Body schema: application/json
object (Activation)

Responses

Request samples

Content type
application/json
{
  • "scheduledActivation": {
    }
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Fast loan",
  • "currency": "EUR",
  • "status": "ACTIVE",
  • "conditions": [
    ],
  • "fees": [
    ],
  • "scheduledActivation": {
    },
  • "tags": [
    ],
  • "financialInstitution": "Faire Bank",
  • "loanPurposes": [
    ]
}

Get loan simulation.

Given the amount and/or the number of instalments, return the monthly payments for a loan product.

Authorizations:
openId
path Parameters
loanProductId
required
string
query Parameters
amountValue
required
string
Example: amountValue=1000
numberOfMonthlyInstalments
integer
Example: numberOfMonthlyInstalments=6

Responses

Response samples

Content type
application/json
{
  • "loanSimulations": [
    ]
}

Change loan product status to active or inactive.

Changes the status of a given loan product.

Authorizations:
openId
path Parameters
loanProductId
required
string
Request Body schema: application/json
status
string
Enum: "ACTIVE" "INACTIVE"

Status of the loan product

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Fast loan",
  • "currency": "EUR",
  • "status": "ACTIVE",
  • "conditions": [
    ],
  • "fees": [
    ],
  • "scheduledActivation": {
    },
  • "tags": [
    ],
  • "financialInstitution": "Faire Bank",
  • "loanPurposes": [
    ]
}

loans

Loans operations.

Create a new loan.

Create a new loan.

Authorizations:
openId
Request Body schema: application/json
loanId
required
string <uuid>

Unique identifier of a loan

personId
required
string

Unique identifier of a person

loanProductId
required
string

Unique identifier of a loan product

amount
required
string

The amount of the loan

currency
required
string

The currency of the loan

numberOfInstalments
required
number

The number of the instalments for the loan

Responses

Request samples

Content type
application/json
{
  • "loanId": "4049ab70-7a61-11eb-9439-0242ac130002",
  • "personId": "a1b2c3",
  • "loanProductId": "4049ab70-7a61-11eb-9439-0242ac130011",
  • "amount": "1000",
  • "currency": "EUR",
  • "numberOfInstalments": 6
}

Response samples

Content type
application/json
{
  • "loanId": "4049ab70-7a61-11eb-9439-0242ac130002",
  • "personId": "a1b2c3",
  • "amount": 1000,
  • "numberOfInstalments": 6,
  • "loanStatus": "CREATED",
  • "instalments": [
    ]
}

Retrieve the loans.

Return all the loans created by the partner.

Authorizations:
openId
query Parameters
personId
string
Example: personId=a1b2c3

Unique identifier of a person.

loanStatus
string
Enum: "CLOSED" "REJECTED" "DEFAULTING" "CANCELLED" "DISBURSED" "APPROVED" "CREATED"

Status of the loan.

Responses

Response samples

Content type
application/json
{
  • "loans": [
    ]
}

Retrieve a loan.

Return a loan by its unique identifier.

Authorizations:
openId
path Parameters
loanId
required
string
Example: d4618120-96d1-11eb-a8b3-0242ac130009

Unique identifier of a loan.

Responses

Response samples

Content type
application/json
{
  • "loanId": "4049ab70-7a61-11eb-9439-0242ac130002",
  • "personId": "a1b2c3",
  • "amount": 1000,
  • "numberOfInstalments": 6,
  • "loanStatus": "CREATED",
  • "instalments": [
    ]
}

Update loan.

Update the data of an existing loan.

Authorizations:
openId
path Parameters
loanId
required
string
Example: d4618120-96d1-11eb-a8b3-0242ac130009

Unique identifier of a loan.

Request Body schema: application/json
status
string
Enum: "CLOSED" "REJECTED" "DEFAULTING" "CANCELLED" "DISBURSED" "APPROVED" "CREATED"

The status of the loan

amount
string

The amount of the loan that can be provided only when the status is CREATED.

numberOfInstalments
integer

The number of instalments for the loan that can be provided only when the status is CREATED.

instalmentsDueDates
Array of strings <date>

Instalments due dates of the loan that can be provided only when the status is DISBURSED.

Responses

Request samples

Content type
application/json
{
  • "status": "CREATED",
  • "amount": "1000",
  • "numberOfInstalments": 6,
  • "instalmentsDueDates": [
    ]
}

Response samples

Content type
application/json
{
  • "loanId": "4049ab70-7a61-11eb-9439-0242ac130002",
  • "personId": "a1b2c3",
  • "amount": 1000,
  • "numberOfInstalments": 6,
  • "loanStatus": "CREATED",
  • "instalments": [
    ]
}

Repay instalment.

Change the status of an instalment.

Authorizations:
openId
path Parameters
loanId
required
string
Example: d4618120-96d1-11eb-a8b3-0242ac130009

Unique identifier of a loan.

instalmentReference
required
string
Example: 2031-02-21

Instalment due date.

Request Body schema: application/json
status
required
string
Enum: "NEW" "PENDING" "PAID" "DEFAULT"

The status of the repayment

paid
string <date-time>

Must be provided if status of the loan is PAID

Responses

Request samples

Content type
application/json
{
  • "status": "PAID",
  • "paid": "2022-05-05T12:12:13.124Z"
}

Response samples

Content type
application/json
{
  • "loanId": "4049ab70-7a61-11eb-9439-0242ac130002",
  • "personId": "a1b2c3",
  • "amount": 1000,
  • "numberOfInstalments": 6,
  • "loanStatus": "CREATED",
  • "instalments": [
    ]
}

categories

Transaction categories

Main Category
 Subcategory
 Income
 Expense
BILLS_SUBSCRIPTIONS BILLS false true
INTERNET_PHONE false true
OTHER false true
SUBSCRIPTIONS false true
CREDIT_CARDS CREDIT_CARDS false true
OTHER false true
EATING_OUT COFFEE_SHOPS false true
OTHER false true
RESTAURANTS false true
TAKEAWAY_RESTAURANTS false true
EDUCATION COURSES false true
EDUCATIONAL_MATERIALS false true
KINDERGARTEN false true
OTHER false true
SCHOOLS false true
UNIVERSITIES false true
HEALTH_WELLNESS AID_EXPENSES false true
DRUGS false true
GYMS false true
MEDICAL_EXPENSES false true
OTHER false true
SPORT false true
WELLNESS_RELAX false true
HOUSING_FAMILY APPLIANCES false true
BABY_SITTING false true
CHILDHOOD false true
CONDO_EXPENSES false true
FURNITURE false true
GROCERIES false true
INSURANCES true true
LAUNDRY false true
MAINTENANCE_RENOVATION false true
NOURISHMENT true true
OTHER false true
RENTS false true
SERVANTS false true
VETERINARY false true
LEISURE BOOKS false true
CINEMA false true
CLUB_ASSOCIATIONS false true
GAMBLING false true
MAGAZINES_NEWSPAPERS false true
MOVIES_MUSICS false true
MUSEUMS_PARKS false true
OTHER false true
SPORT_EVENTS false true
THEATERS_CONCERTS false true
VIDEOGAMES false true
MORTGAGES_LOANS INSTALLMENT_PAYMENTS false true
LOANS true true
MORTGAGES false true
OTHER false true
OTHER CASH true true
CHECKS true true
OTHER true true
PROFITS OTHER true false
PROFITS true false
SHOPPING ACCESSORIZE false true
CLOTHING false true
FOOTWEAR false true
HI_TECH false true
JEWELLERY false true
OTHER false true
SPORT_ARTICLES false true
TAXES_SERVICES PROFESSIONAL_ACTIVITY false true
ACCOUNTANT false true
BANK_FEES false true
DEFAULT_PAYMENTS false true
EXPENSE_LEDGER false true
FINES false true
LEGAL_EXPENSES false true
MONEY_ORDERS false true
OFFICE false true
OTHER false true
PROFIT_DEDUCTION false true
TAXES false true
TRANSFERS RENT_INCOMES true false
GIFTS_DONATIONS true true
BANK_TRANSFERS true true
SAVINGS false true
INVESTMENTS false true
REFUNDS true false
OTHER true true
WINNINGS true false
TRAVELS_TRANSPORTATION BUSES false true
CAR_BIKE_SHARING false true
CAR_RENTAL false true
FLIGHTS false true
FUEL false true
HOTELS false true
OTHER false true
PARKING_URBAN_TRANSPORTS false true
SHIP_FERRIES false true
TAXIS false true
TOLLS false true
TRAINS false true
TRAVELS_HOLIDAYS false true
VEHICLE_MAINTENANCE false true
WAGES OTHER true false
PENSION true false
PROFESSIONAL_COMPENSATION true false
SALARY true false

businesses

Create a business.

Register a new business to the Platform.

Authorizations:
openId
Request Body schema: application/json
businessId
required
string

Unique identifier of a business.

name
required
string

Name of the business.

legalForm
string

Legal form of the business.

emailAddress
string <email>

Business email address.

vatNumber
string

Business VAT number.

fiscalCode
string

Business Fiscal Code.

industry
required
string

Industry of the business.

phoneNumber
string

Phone number represented with E.164 standard.

object (Address)
creator
string

Creator of the business. Defaults to the partner identifier.

object (Legal representative)
atecoCode
string

ATECO code of the business.

lastBalanceSheetDate
string <datetime>

Date of the last balance sheet.

equity
string

Equity of the business.

totalAsset
string

Total asset of the business.

netFinancialPosition
string

Net financial position of the business.

turnover
string

Turnover of the business.

ebitda
string

EBITDA of the business.

totalRevenue
string

Total revenue of the business.

personnelExpenses
string

Personnel expenses of the business.

taxesServices
string

Taxes services of the business.

billOverdue
string (Legal event type)
Enum: "NO_NEGATIVE_EVENTS" "NON_RELEVANT_NEGATIVE_EVENT" "RELEVANT_NEGATIVE_EVENT"

Type of a legal event associated to a business.

  • NO_NEGATIVE_EVENTS: no negative events recorded for the business.
  • NON_RELEVANT_NEGATIVE_EVENT: non-relevant negative event recorded for the business.
  • RELEVANT_NEGATIVE_EVENT: relevant negative event recorded for the business.
events
string (Legal event type)
Enum: "NO_NEGATIVE_EVENTS" "NON_RELEVANT_NEGATIVE_EVENT" "RELEVANT_NEGATIVE_EVENT"

Type of a legal event associated to a business.

  • NO_NEGATIVE_EVENTS: no negative events recorded for the business.
  • NON_RELEVANT_NEGATIVE_EVENT: non-relevant negative event recorded for the business.
  • RELEVANT_NEGATIVE_EVENT: relevant negative event recorded for the business.
procedures
string (Legal event type)
Enum: "NO_NEGATIVE_EVENTS" "NON_RELEVANT_NEGATIVE_EVENT" "RELEVANT_NEGATIVE_EVENT"

Type of a legal event associated to a business.

  • NO_NEGATIVE_EVENTS: no negative events recorded for the business.
  • NON_RELEVANT_NEGATIVE_EVENT: non-relevant negative event recorded for the business.
  • RELEVANT_NEGATIVE_EVENT: relevant negative event recorded for the business.

Responses

Request samples

Content type
application/json
{
  • "businessId": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Faire.ai",
  • "legalForm": "SRL",
  • "emailAddress": "example@company.com",
  • "vatNumber": "12345678901",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "industry": "Software development",
  • "phoneNumber": "+39XXXXXXXXXX",
  • "address": {
    },
  • "creator": "123e4567-e89b-12d3-a456-426614174000",
  • "legalRepresentative": {
    },
  • "atecoCode": "62.01",
  • "lastBalanceSheetDate": "2021-12-31T23:59:59Z",
  • "equity": "100000",
  • "totalAsset": "1000000",
  • "netFinancialPosition": "10000",
  • "turnover": "1000000",
  • "ebitda": "100000",
  • "totalRevenue": "1000000",
  • "personnelExpenses": "100000",
  • "taxesServices": "10000",
  • "billOverdue": "NO_NEGATIVE_EVENTS",
  • "events": "NO_NEGATIVE_EVENTS",
  • "procedures": "NO_NEGATIVE_EVENTS"
}

Response samples

Content type
application/json
{
  • "businessId": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Faire.ai",
  • "legalForm": "SRL",
  • "emailAddress": "example@company.com",
  • "vatNumber": "12345678901",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "industry": "Software development",
  • "phoneNumber": "+39XXXXXXXXXX",
  • "address": {
    },
  • "creator": "123e4567-e89b-12d3-a456-426614174000",
  • "legalRepresentative": {
    },
  • "atecoCode": "62.01",
  • "lastBalanceSheetDate": "2021-12-31T23:59:59Z",
  • "equity": "100000",
  • "totalAsset": "1000000",
  • "netFinancialPosition": "10000",
  • "turnover": "1000000",
  • "ebitda": "100000",
  • "totalRevenue": "1000000",
  • "personnelExpenses": "100000",
  • "taxesServices": "10000",
  • "billOverdue": "NO_NEGATIVE_EVENTS",
  • "events": "NO_NEGATIVE_EVENTS",
  • "procedures": "NO_NEGATIVE_EVENTS"
}

Get all businesses.

Return all the data of the businesses registered by the partner to the Platform.

Authorizations:
openId
query Parameters
creator
string
Example: creator=123e4567-e89b-12d3-a456-426614174000

Creator of the business.

vatNumber
string
Example: vatNumber=12345678901

Business VAT number.

Responses

Response samples

Content type
application/json
{
  • "businesses": [
    ]
}

Get a business.

Return the data of a single business registered by the partner to the Platform.

Authorizations:
openId
path Parameters
businessId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Unique identifier of a business.

Responses

Response samples

Content type
application/json
{
  • "businessId": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Faire.ai",
  • "legalForm": "SRL",
  • "emailAddress": "example@company.com",
  • "vatNumber": "12345678901",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "industry": "Software development",
  • "phoneNumber": "+39XXXXXXXXXX",
  • "address": {
    },
  • "creator": "123e4567-e89b-12d3-a456-426614174000",
  • "legalRepresentative": {
    },
  • "atecoCode": "62.01",
  • "lastBalanceSheetDate": "2021-12-31T23:59:59Z",
  • "equity": "100000",
  • "totalAsset": "1000000",
  • "netFinancialPosition": "10000",
  • "turnover": "1000000",
  • "ebitda": "100000",
  • "totalRevenue": "1000000",
  • "personnelExpenses": "100000",
  • "taxesServices": "10000",
  • "billOverdue": "NO_NEGATIVE_EVENTS",
  • "events": "NO_NEGATIVE_EVENTS",
  • "procedures": "NO_NEGATIVE_EVENTS"
}

Update a business.

Update the data of an existing business.

Authorizations:
openId
path Parameters
businessId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Unique identifier of a business.

Request Body schema: application/json
businessId
required
string

Unique identifier of a business.

name
required
string

Name of the business.

legalForm
string

Legal form of the business.

emailAddress
string <email>

Business email address.

vatNumber
string

Business VAT number.

fiscalCode
string

Business Fiscal Code.

industry
required
string

Industry of the business.

phoneNumber
string

Phone number represented with E.164 standard.

object (Address)
creator
string

Creator of the business. Defaults to the partner identifier.

object (Legal representative)
atecoCode
string

ATECO code of the business.

lastBalanceSheetDate
string <datetime>

Date of the last balance sheet.

equity
string

Equity of the business.

totalAsset
string

Total asset of the business.

netFinancialPosition
string

Net financial position of the business.

turnover
string

Turnover of the business.

ebitda
string

EBITDA of the business.

totalRevenue
string

Total revenue of the business.

personnelExpenses
string

Personnel expenses of the business.

taxesServices
string

Taxes services of the business.

billOverdue
string (Legal event type)
Enum: "NO_NEGATIVE_EVENTS" "NON_RELEVANT_NEGATIVE_EVENT" "RELEVANT_NEGATIVE_EVENT"

Type of a legal event associated to a business.

  • NO_NEGATIVE_EVENTS: no negative events recorded for the business.
  • NON_RELEVANT_NEGATIVE_EVENT: non-relevant negative event recorded for the business.
  • RELEVANT_NEGATIVE_EVENT: relevant negative event recorded for the business.
events
string (Legal event type)
Enum: "NO_NEGATIVE_EVENTS" "NON_RELEVANT_NEGATIVE_EVENT" "RELEVANT_NEGATIVE_EVENT"

Type of a legal event associated to a business.

  • NO_NEGATIVE_EVENTS: no negative events recorded for the business.
  • NON_RELEVANT_NEGATIVE_EVENT: non-relevant negative event recorded for the business.
  • RELEVANT_NEGATIVE_EVENT: relevant negative event recorded for the business.
procedures
string (Legal event type)
Enum: "NO_NEGATIVE_EVENTS" "NON_RELEVANT_NEGATIVE_EVENT" "RELEVANT_NEGATIVE_EVENT"

Type of a legal event associated to a business.

  • NO_NEGATIVE_EVENTS: no negative events recorded for the business.
  • NON_RELEVANT_NEGATIVE_EVENT: non-relevant negative event recorded for the business.
  • RELEVANT_NEGATIVE_EVENT: relevant negative event recorded for the business.

Responses

Request samples

Content type
application/json
{
  • "businessId": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Faire.ai",
  • "legalForm": "SRL",
  • "emailAddress": "example@company.com",
  • "vatNumber": "12345678901",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "industry": "Software development",
  • "phoneNumber": "+39XXXXXXXXXX",
  • "address": {
    },
  • "creator": "123e4567-e89b-12d3-a456-426614174000",
  • "legalRepresentative": {
    },
  • "atecoCode": "62.01",
  • "lastBalanceSheetDate": "2021-12-31T23:59:59Z",
  • "equity": "100000",
  • "totalAsset": "1000000",
  • "netFinancialPosition": "10000",
  • "turnover": "1000000",
  • "ebitda": "100000",
  • "totalRevenue": "1000000",
  • "personnelExpenses": "100000",
  • "taxesServices": "10000",
  • "billOverdue": "NO_NEGATIVE_EVENTS",
  • "events": "NO_NEGATIVE_EVENTS",
  • "procedures": "NO_NEGATIVE_EVENTS"
}

Response samples

Content type
application/json
{
  • "businessId": "123e4567-e89b-12d3-a456-426614174000",
  • "name": "Faire.ai",
  • "legalForm": "SRL",
  • "emailAddress": "example@company.com",
  • "vatNumber": "12345678901",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "industry": "Software development",
  • "phoneNumber": "+39XXXXXXXXXX",
  • "address": {
    },
  • "creator": "123e4567-e89b-12d3-a456-426614174000",
  • "legalRepresentative": {
    },
  • "atecoCode": "62.01",
  • "lastBalanceSheetDate": "2021-12-31T23:59:59Z",
  • "equity": "100000",
  • "totalAsset": "1000000",
  • "netFinancialPosition": "10000",
  • "turnover": "1000000",
  • "ebitda": "100000",
  • "totalRevenue": "1000000",
  • "personnelExpenses": "100000",
  • "taxesServices": "10000",
  • "billOverdue": "NO_NEGATIVE_EVENTS",
  • "events": "NO_NEGATIVE_EVENTS",
  • "procedures": "NO_NEGATIVE_EVENTS"
}

Delete a business.

Delete a business and all its data persisted on the Platform.

Authorizations:
openId
path Parameters
businessId
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Unique identifier of a business.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Lookup business data.

Return the data of a business by its VAT number.

Authorizations:
openId
query Parameters
vatNumber
required
string
Example: vatNumber=12345678901

Business VAT number.

Responses

Response samples

Content type
application/json
{
  • "name": "Faire.ai",
  • "legalForm": "SRL",
  • "emailAddress": "example@company.com",
  • "vatNumber": "12345678901",
  • "fiscalCode": "RSSPPP00L21H501U",
  • "industry": "Software development",
  • "phoneNumber": "+39XXXXXXXXXX",
  • "address": {
    },
  • "creator": "123e4567-e89b-12d3-a456-426614174000",
  • "legalRepresentative": {
    },
  • "atecoCode": "62.01",
  • "lastBalanceSheetDate": "2021-12-31T23:59:59Z",
  • "equity": "100000",
  • "totalAsset": "1000000",
  • "netFinancialPosition": "10000",
  • "turnover": "1000000",
  • "ebitda": "100000",
  • "totalRevenue": "1000000",
  • "personnelExpenses": "100000",
  • "taxesServices": "10000",
  • "billOverdue": "NO_NEGATIVE_EVENTS",
  • "events": "NO_NEGATIVE_EVENTS",
  • "procedures": "NO_NEGATIVE_EVENTS"
}