# Schuman API

API for Schuman's stablecoin platform.

Version: 1.0

## Security

### api-key

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[Schuman API](https://docs.api.schuman.io/_bundle/openapi.yaml)

## App

### Get App Health

 - [GET /health](https://docs.api.schuman.io/openapi/app/appcontroller_gethealth.md)

### Get App Version

 - [GET /version](https://docs.api.schuman.io/openapi/app/appcontroller_getversion.md)

## Transfer

### Get all transfer history

 - [GET /transfer/{customerId}/history](https://docs.api.schuman.io/openapi/transfer/transfercontroller_gettransferhistory.md): Retrieves all transfer history (deposits, withdrawals, mints, redemptions) for the customer.

### Get bank transfer history

 - [GET /transfer/{customerId}/bank-transfers](https://docs.api.schuman.io/openapi/transfer/transfercontroller_getbanktransfers.md): Retrieves all bank transfers (SEPA, internal, deposits, withdrawals) for the customer.

### Get crypto transfer history

 - [GET /transfer/{customerId}/crypto-transfers](https://docs.api.schuman.io/openapi/transfer/transfercontroller_getcryptotransfers.md): Retrieves all crypto transfers (mints and redemptions) for the customer.

## Customer

### Retrieve all customers created by the superclient

 - [GET /customer](https://docs.api.schuman.io/openapi/customer/customercontroller_getallcustomers.md): Returns a paginated list of all customers created by the requesting superclient.

### Create customer via superclient API

 - [POST /customer](https://docs.api.schuman.io/openapi/customer/customercontroller_createcustomer.md): Allows superclients to create new customers in the system. The created customer will be automatically linked to the superclient that created it.

### Retrieve customer information

 - [GET /customer/{customerId}](https://docs.api.schuman.io/openapi/customer/customercontroller_getcustomerbyid.md): Allows superclients to retrieve customer information by customer ID. Only customers created by the requesting superclient can be accessed.

### Get superclient info

 - [GET /customer/superclient/info](https://docs.api.schuman.io/openapi/customer/customercontroller_getsuperclientinfo.md): Retrieves the information about the authenticated superclient.

## Address

### Generate virtual IBAN for customer

 - [POST /address/{customerId}/viban](https://docs.api.schuman.io/openapi/address/addresscontroller_generateviban.md): Allows superclients to generate a VIBAN for a specific customer. Only customers created by the requesting superclient can have VIBANs generated.

### Add blockchain wallet address for customer

 - [POST /address/{customerId}/wallet](https://docs.api.schuman.io/openapi/address/addresscontroller_addwalletaddress.md): Allows superclients to add a blockchain wallet address for a specific customer. Supports RIPPLE, ETHEREUM, POLYGON, and AVALANCHE.

### Set default blockchain or bank address type

 - [POST /address/{customerId}/default-address](https://docs.api.schuman.io/openapi/address/addresscontroller_setdefaultaddress.md): Sets which address type should be the default for the customer. The address of that type must already exist.

### Set default IBAN to receive and send money

 - [POST /address/{customerId}/default-iban](https://docs.api.schuman.io/openapi/address/addresscontroller_setdefaultiban.md): 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.

### Get blockchain addresses and IBANs

 - [GET /address/{customerId}/list](https://docs.api.schuman.io/openapi/address/addresscontroller_getaddresses.md): Retrieves all blockchain addresses and IBANs (VIBANs) for the customer, including which ones are set as default.

### Get blockchain redemption addresses

 - [GET /address/{customerId}/redemption-addresses](https://docs.api.schuman.io/openapi/address/addresscontroller_getredemptionaddresses.md): Retrieves the redemption addresses for all supported blockchains where the customer can send tokens to convert to fiat.

### Get allowed blockchains

 - [GET /address/{customerId}/allowed-chains](https://docs.api.schuman.io/openapi/address/addresscontroller_getallowedchains.md): Retrieves the list of blockchain networks that the customer is allowed to use.