Skip to content

Europa API (1.0)

API for Schuman's Europa stablecoin platform

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Languages
Servers
Mock server
https://docs.api.schuman.io/_mock/openapi

App

Operations

Transfer

Operations

Customer

Operations

Retrieve all customers created by the superclient

Request

Returns a paginated list of all customers created by the requesting superclient.

Security
api-key-config
Query
pagenumber

Page number (starting from 1)

Example: page=1
limitnumber

Number of customers per page (max 100)

Example: limit=10
curl -i -X GET \
  'https://docs.api.schuman.io/_mock/openapi/customer?page=1&limit=10' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Customers retrieved successfully

Bodyapplication/json
customersArray of objects
paginationobject
Response
application/json
{
  "customers": [
    { … }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}

Create customer via superclient API

Request

Allows superclients to create new customers in the system. The created customer will be automatically linked to the superclient that created it.

Security
api-key-config
Bodyapplication/jsonrequired

Customer creation data

namestringrequired

Customer company name

Example: "Acme Corporation"
physicalAddressstring

Physical address of the customer

Example: "1 Wall Street, New York, USA"
companyTaxIdstring

Company tax ID

Example: "TAX123456"
companyRegistrationNumberstring

Company registration number

Example: "REG789012"
curl -i -X POST \
  https://docs.api.schuman.io/_mock/openapi/customer \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Acme Corporation",
    "physicalAddress": "1 Wall Street, New York, USA",
    "companyTaxId": "TAX123456",
    "companyRegistrationNumber": "REG789012"
  }'

Responses

Customer created successfully

Bodyapplication/json
idstring(uuid)

Customer unique identifier

namestring

Customer company name

physicalAddressstring

Physical address of the customer

companyTaxIdstring

Company tax ID

companyRegistrationNumberstring

Company registration number

defaultChainstring

Default blockchain

defaultChainAddressstring

Default blockchain address

defaultBankAddressstring

Default bank IBAN address

balancenumber

Customer balance

createdAtstring(date-time)

Creation timestamp

updatedAtstring(date-time)

Last update timestamp

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "physicalAddress": "string",
  "companyTaxId": "string",
  "companyRegistrationNumber": "string",
  "defaultChain": "string",
  "defaultChainAddress": "string",
  "defaultBankAddress": "string",
  "balance": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieve customer information

Request

Allows superclients to retrieve customer information by customer ID. Only customers created by the requesting superclient can be accessed.

Security
api-key-config
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X GET \
  https://docs.api.schuman.io/_mock/openapi/customer/550e8400-e29b-41d4-a716-446655440000 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Customer retrieved successfully

Bodyapplication/json
idstring(uuid)

Customer unique identifier

namestring

Customer company name

physicalAddressstring

Physical address of the customer

companyTaxIdstring

Company tax ID

companyRegistrationNumberstring

Company registration number

defaultChainstring

Default blockchain

defaultChainAddressstring

Default blockchain address

defaultBankAddressstring

Default bank IBAN address

balancenumber

Customer balance

createdAtstring(date-time)

Creation timestamp

updatedAtstring(date-time)

Last update timestamp

addressesArray of objects

Customer addresses

vibansArray of objects

Customer virtual IBANs

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "physicalAddress": "string",
  "companyTaxId": "string",
  "companyRegistrationNumber": "string",
  "defaultChain": "string",
  "defaultChainAddress": "string",
  "defaultBankAddress": "string",
  "balance": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "addresses": [
    {}
  ],
  "vibans": [
    {}
  ]
}

Get superclient info

Request

Retrieves the information about the authenticated superclient.

Security
api-key-config
curl -i -X GET \
  https://docs.api.schuman.io/_mock/openapi/customer/superclient/info \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Superclient information retrieved successfully

Bodyapplication/json
idstring(uuid)

Superclient unique identifier

namestring

Superclient name

createdAtstring(date-time)

Account creation timestamp

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}

Address

Operations

1P3P (PoC)

Operations