Download OpenAPI specification:Download
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.
The API use OpenID Connect to authenticate and authorize the requests.
Using curl
, getting a token can be done calling the following endpoint with:
curl -X POST https://platform-dev.faire.ai/openid-connect/token \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials&client_id=<CLIENT_ID>&client_secret=<SECRET>
where CLIENT_ID
and SECRET
are the partner credentials provided by faire.ai.
Security Scheme Type | OpenID Connect |
---|---|
Connect URL | https://faireai-platform-docs.s3.eu-central-1.amazonaws.com/openid-dev-configuration.html |
Register a new person to the Platform.
email profile
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 2 characters 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. |
{- "personId": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "John",
- "lastName": "Doe",
- "emailAddress": "john.doe@example.com",
- "dateOfBirth": "2000-07-21",
- "placeOfBirth": {
- "city": "Rome",
- "country": "IT"
}, - "gender": "MALE",
- "citizenship": "IT",
- "fiscalCode": "RSSPPP00L21H501U",
- "homeAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "domicileAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "phoneNumber": "+39XXXXXXXXXX"
}
{- "personId": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "John",
- "lastName": "Doe",
- "emailAddress": "john.doe@example.com",
- "dateOfBirth": "2000-07-21",
- "placeOfBirth": {
- "city": "Rome",
- "country": "IT"
}, - "gender": "MALE",
- "citizenship": "IT",
- "fiscalCode": "RSSPPP00L21H501U",
- "homeAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "domicileAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "phoneNumber": "+39XXXXXXXXXX"
}
Return all the data of the persons registered by the partner to the Platform.
email profile
{- "persons": [
- {
- "personId": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "John",
- "lastName": "Doe",
- "emailAddress": "john.doe@example.com",
- "dateOfBirth": "2000-07-21",
- "placeOfBirth": {
- "city": "Rome",
- "country": "IT"
}, - "gender": "MALE",
- "citizenship": "IT",
- "fiscalCode": "RSSPPP00L21H501U",
- "homeAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "domicileAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "phoneNumber": "+39XXXXXXXXXX"
}
]
}
Return the data of a single person registered by the partner to the Platfom.
email profile
personId required | string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Unique identifier of a person. |
{- "personId": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "John",
- "lastName": "Doe",
- "emailAddress": "john.doe@example.com",
- "dateOfBirth": "2000-07-21",
- "placeOfBirth": {
- "city": "Rome",
- "country": "IT"
}, - "gender": "MALE",
- "citizenship": "IT",
- "fiscalCode": "RSSPPP00L21H501U",
- "homeAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "domicileAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "phoneNumber": "+39XXXXXXXXXX"
}
Update the data of an existing person.
email profile
personId required | string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Unique identifier of a person. |
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 2 characters 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. |
{- "personId": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "John",
- "lastName": "Doe",
- "emailAddress": "john.doe@example.com",
- "dateOfBirth": "2000-07-21",
- "placeOfBirth": {
- "city": "Rome",
- "country": "IT"
}, - "gender": "MALE",
- "citizenship": "IT",
- "fiscalCode": "RSSPPP00L21H501U",
- "homeAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "domicileAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "phoneNumber": "+39XXXXXXXXXX"
}
{- "personId": "123e4567-e89b-12d3-a456-426614174000",
- "firstName": "John",
- "lastName": "Doe",
- "emailAddress": "john.doe@example.com",
- "dateOfBirth": "2000-07-21",
- "placeOfBirth": {
- "city": "Rome",
- "country": "IT"
}, - "gender": "MALE",
- "citizenship": "IT",
- "fiscalCode": "RSSPPP00L21H501U",
- "homeAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "domicileAddress": {
- "line1": "3972 Eagles Nest Drive",
- "line2": "Apt. 123",
- "postalCode": "00152",
- "city": "Placerville",
- "country": "IT",
- "state": "Italy"
}, - "phoneNumber": "+39XXXXXXXXXX"
}
Delete a person and all its data persisted on the Platform.
email profile
personId required | string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 Unique identifier of a person. |
{- "errors": [
- {
- "code": "PERSON_NOT_FOUND",
- "message": "Could not find person '1234'"
}
]
}
Register a new bank account of a person within the Platform.
email profile
accountId | string |
personId | string UUID value |
iban | string |
currency | string |
bookedBalance | string Booked balance. |
holders | Array of strings |
{- "accountId": "a1b2c3",
- "personId": "c6a7fe4e-5fc0-11eb-ae93-0242ac130002",
- "iban": "BE71096123456769",
- "currency": "EUR",
- "bookedBalance": "1500.00",
- "holders": [
- "holder1",
- "holder2"
]
}
{- "accountId": "a1b2c3",
- "personId": "c6a7fe4e-5fc0-11eb-ae93-0242ac130002",
- "iban": "BE71096123456769",
- "currency": "EUR",
- "bookedBalance": "1500.00",
- "holders": [
- "holder1",
- "holder2"
], - "operativity": "OPERATIVE"
}
Return all the bank accounts data of a person registered on the Platform.
email profile
personId required | string Example: personId=123e4567-e89b-12d3-a456-426614174000 |
{- "accounts": [
- {
- "accountId": "a1b2c3",
- "personId": "c6a7fe4e-5fc0-11eb-ae93-0242ac130002",
- "iban": "BE71096123456769",
- "currency": "EUR",
- "bookedBalance": "1500.00",
- "holders": [
- "holder1",
- "holder2"
], - "operativity": "OPERATIVE"
}
]
}
Return all the data of a bank account.
email profile
accountId required | string Example: a1b2c3 |
{- "accountId": "a1b2c3",
- "personId": "c6a7fe4e-5fc0-11eb-ae93-0242ac130002",
- "iban": "BE71096123456769",
- "currency": "EUR",
- "bookedBalance": "1500.00",
- "holders": [
- "holder1",
- "holder2"
], - "operativity": "OPERATIVE"
}
Delete a bank account and all its data.
email profile
accountId required | string Example: a1b2c3 |
{- "errors": [
- {
- "code": "ACCOUNT_NOT_FOUND",
- "message": "Could not find account '1234'"
}
]
}