Skip to content
/
Generate virtual IBAN for...

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

Address

Operations

Generate virtual IBAN for customer

Request

Allows superclients to generate a VIBAN for a specific customer. Only customers created by the requesting superclient can have VIBANs generated.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired

VIBAN generation data

aliasstring<= 30 characters

Optional alias for the VIBAN (max 30 characters)

Example: "Primary Account"
curl -i -X POST \
  https://docs.api.schuman.io/_mock/openapi/address/550e8400-e29b-41d4-a716-446655440000/viban \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "alias": "Primary Account"
  }'

Responses

VIBAN generated successfully

Bodyapplication/json
listCOBOArray of strings

List of COBO VIBANs

listPOBOArray of strings

List of POBO VIBANs

statusstring

Generation status

Enum"success""pending"
Response
application/json
{
  "listCOBO": [
    "string"
  ],
  "listPOBO": [
    "string"
  ],
  "status": "success"
}

Add blockchain wallet address for customer

Request

Allows superclients to add a blockchain wallet address for a specific customer. Supports RIPPLE, ETHEREUM, POLYGON, and AVALANCHE.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired

Wallet address data

addressstring[ 15 .. 34 ] charactersrequired

Blockchain wallet address

Example: "rN7n7otQDd6FczFgLdlqtyMVrn3HMfXEEQ"
addressTypestringrequired

Blockchain type

Enum"RIPPLE""ETHEREUM""POLYGON""AVALANCHE"
Example: "RIPPLE"
aliasstring<= 30 characters

Optional alias for the wallet (max 30 characters)

Example: "Main Wallet"
curl -i -X POST \
  https://docs.api.schuman.io/_mock/openapi/address/550e8400-e29b-41d4-a716-446655440000/wallet \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "address": "rN7n7otQDd6FczFgLdlqtyMVrn3HMfXEEQ",
    "addressType": "RIPPLE",
    "alias": "Main Wallet"
  }'

Responses

Wallet address added successfully

Bodyapplication/json
statusnumber
Example: 200
messagestring
Example: "Address added"
Response
application/json
{
  "status": 200,
  "message": "Address added"
}

Set default blockchain or bank address type

Request

Sets which address type should be the default for the customer. The address of that type must already exist.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired

Address type to set as default

addressTypestringrequired

Address type to set as default

Enum"RIPPLE""ETHEREUM""POLYGON""AVALANCHE""BANK"
Example: "ETHEREUM"
curl -i -X POST \
  https://docs.api.schuman.io/_mock/openapi/address/550e8400-e29b-41d4-a716-446655440000/default-address \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "addressType": "ETHEREUM"
  }'

Responses

Default address updated successfully

Bodyapplication/json
statusnumber
Example: 200
messagestring
Example: "Default address updated"
Response
application/json
{
  "status": 200,
  "message": "Default address updated"
}

Set default IBAN to receive and send money

Request

Sets which IBAN should be the default for the customer to receive money on and send money from. The IBAN must already exist for this customer.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/jsonrequired

IBAN to set as default

ibanstringrequired

IBAN to set as default

Example: "DE89370400440532013000"
curl -i -X POST \
  https://docs.api.schuman.io/_mock/openapi/address/550e8400-e29b-41d4-a716-446655440000/default-iban \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "iban": "DE89370400440532013000"
  }'

Responses

Default IBAN updated successfully

Bodyapplication/json
statusnumber
Example: 200
messagestring
Example: "Default IBAN updated"
Response
application/json
{
  "status": 200,
  "message": "Default IBAN updated"
}

Get blockchain addresses and IBANs

Request

Retrieves all blockchain addresses and IBANs (VIBANs) for the customer, including which ones are set as default.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

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

Responses

Addresses retrieved successfully

Bodyapplication/json
addressListArray of objects

List of blockchain addresses

vibansArray of objects

List of VIBANs

defaultChainstring or null

Default blockchain type

Enum"RIPPLE""ETHEREUM""POLYGON""AVALANCHE"
defaultChainAddressstring or null

Default blockchain address

defaultIbanstring or null

Default IBAN (can be a VIBAN or custom IBAN set by user)

Response
application/json
{
  "addressList": [
    { … }
  ],
  "vibans": [
    { … }
  ],
  "defaultChain": "RIPPLE",
  "defaultChainAddress": "string",
  "defaultIban": "string"
}

Get blockchain redemption addresses

Request

Retrieves the redemption addresses for all supported blockchains where the customer can send tokens to convert to fiat.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

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

Responses

Redemption addresses retrieved successfully

Bodyapplication/json
RIPPLEstring

Ripple redemption address

ETHEREUMstring

Ethereum redemption address

POLYGONstring

Polygon redemption address

AVALANCHEstring

Avalanche redemption address

Response
application/json
{
  "RIPPLE": "string",
  "ETHEREUM": "string",
  "POLYGON": "string",
  "AVALANCHE": "string"
}

Get allowed blockchains

Request

Retrieves the list of blockchain networks that the customer is allowed to use.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

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

Responses

Allowed chains retrieved successfully

Bodyapplication/json
allowedChainsArray of strings

List of allowed blockchain networks

Items Enum"RIPPLE""ETHEREUM""POLYGON""AVALANCHE"
Response
application/json
{
  "allowedChains": [
    "RIPPLE"
  ]
}