Skip to content

Schuman API (1.0)

API for Schuman's 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
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
Bodyapplication/jsonrequired

Customer creation data

namestringrequired

Customer company name

Example: "Acme Corporation"
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"
  }'

Responses

Customer created successfully

Bodyapplication/json
idstring(uuid)

Customer unique identifier

namestring

Customer company name

companyIcostring

Company ICO/registration number

defaultChainstring

Default blockchain

defaultChainAddressstring

Default blockchain address

defaultBankAddressstring

Default bank IBAN address

kycVerifiedboolean

KYC verification status

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",
  "companyIco": "string",
  "defaultChain": "string",
  "defaultChainAddress": "string",
  "defaultBankAddress": "string",
  "kycVerified": true,
  "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
Path
idstring(uuid)required

Customer ID (UUID)

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

Responses

Customer retrieved successfully

Bodyapplication/json
idstring(uuid)

Customer unique identifier

namestring

Customer company name

companyIcostring

Company ICO/registration number

defaultChainstring

Default blockchain

defaultChainAddressstring

Default blockchain address

defaultBankAddressstring

Default bank IBAN address

kycVerifiedboolean

KYC verification status

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",
  "companyIco": "string",
  "defaultChain": "string",
  "defaultChainAddress": "string",
  "defaultBankAddress": "string",
  "kycVerified": true,
  "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
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