Class: MoneriumWhitelabelClient

Server-side client containing operations that require client secrets. Must never be used in a browser context.

Extends

• MoneriumServerClient

Constructors

new MoneriumWhitelabelClient()

new MoneriumWhitelabelClient(options: MoneriumApiClientOptions): MoneriumWhitelabelClient

Parameters

Parameter	Type
options	MoneriumApiClientOptions

Returns

MoneriumWhitelabelClient

Inherited from

MoneriumServerClient.constructor

Properties

Property	Modifier	Type	Inherited from
env	protected	Environment	MoneriumServerClient.env
options	protected	MoneriumApiClientOptions	MoneriumServerClient.options
transport	protected	Transport	MoneriumServerClient.transport

Methods

clientCredentialsGrant()

clientCredentialsGrant(clientId: string, clientSecret: string): Promise<BearerProfile>

Get an access token using client credentials. Server-side only. clientSecret must never be used in a browser context.

Parameters

Parameter	Type
clientId	string
clientSecret	string

Returns

Promise<BearerProfile>

Inherited from

MoneriumServerClient.clientCredentialsGrant

---

createProfile()

createProfile(input: CreateProfileInput): Promise<Profile>

Creates a new profile.

Parameters

Parameter	Type
input	CreateProfileInput

Returns

Promise<Profile>

See

API Documentation

---

getAddress()

getAddress(address: string): Promise<Address>

Get details for a single address after it has been linked to Monerium.

Parameters

Parameter	Type	Description
address	string	The public key of the blockchain account.

Returns

Promise<Address>

See

API Documentation

Inherited from

MoneriumServerClient.getAddress

---

getAddresses()

getAddresses(params?: AddressesQueryParams): Promise<AddressesResponse>

Get a list of all addresses linked to the profile.

Parameters

Parameter	Type
params?	AddressesQueryParams

Returns

Promise<AddressesResponse>

See

API Documentation

Inherited from

MoneriumServerClient.getAddresses

---

getAuthContext()

getAuthContext(): Promise<AuthContext>

Get the current auth context.

Returns

Promise<AuthContext>

See

API Documentation

Inherited from

MoneriumServerClient.getAuthContext

---

getBalances()

getBalances(params: GetBalancesParams): Promise<Balances>

Get the balances for a given address on a specific chain.

Parameters

Parameter	Type
params	GetBalancesParams

Returns

Promise<Balances>

See

API Documentation

Inherited from

MoneriumServerClient.getBalances

---

getIban()

getIban(iban: string): Promise<IBAN>

Fetch details about a single IBAN.

Parameters

Parameter	Type	Description
iban	string	The IBAN to fetch.

Returns

Promise<IBAN>

See

API Documentation

Inherited from

MoneriumServerClient.getIban

---

getIbans()

getIbans(params?: IbansParams): Promise<IBANsResponse>

Fetch all IBANs for the profile.

Parameters

Parameter	Type
params?	IbansParams

Returns

Promise<IBANsResponse>

See

API Documentation

Inherited from

MoneriumServerClient.getIbans

---

getOrder()

getOrder(orderId: string): Promise<Order>

Get an order by its ID.

Parameters

Parameter	Type
orderId	string

Returns

Promise<Order>

See

API Documentation

Inherited from

MoneriumServerClient.getOrder

---

getOrders()

getOrders(params?: OrderParams): Promise<OrdersResponse>

Get a list of orders.

Parameters

Parameter	Type
params?	OrderParams

Returns

Promise<OrdersResponse>

See

API Documentation

Inherited from

MoneriumServerClient.getOrders

---

getProfile()

getProfile(profileId: string): Promise<Profile>

Get a profile by its id.

Parameters

Parameter	Type	Description
profileId	string	The id of the profile to fetch.

Returns

Promise<Profile>

See

API Documentation

Inherited from

MoneriumServerClient.getProfile

---

getProfiles()

getProfiles(params?: GetProfilesParams): Promise<ProfilesResponse>

Get all profiles.

Parameters

Parameter	Type
params?	GetProfilesParams

Returns

Promise<ProfilesResponse>

See

API Documentation

Inherited from

MoneriumServerClient.getProfiles

---

getSignatures()

getSignatures(params?: SignaturesParams): Promise<SignaturesResponse>

Get pending signatures for the authenticated user.

Parameters

Parameter	Type
params?	SignaturesParams

Returns

Promise<SignaturesResponse>

See

API Documentation

Inherited from

MoneriumServerClient.getSignatures

---

getToken()

protected getToken(): Promise<undefined | string>

Returns

Promise<undefined | string>

Inherited from

MoneriumServerClient.getToken

---

getTokens()

getTokens(): Promise<Token[]>

Get Monerium tokens with contract addresses and chain details.

Returns

Promise<Token[]>

See

API Documentation

Inherited from

MoneriumServerClient.getTokens

---

linkAddress()

linkAddress(body: LinkAddressInput): Promise<LinkAddressResponse | AcceptedResponse>

Add a new address to the profile.

Parameters

Parameter	Type
body	LinkAddressInput

Returns

Promise<LinkAddressResponse | AcceptedResponse>

• The address was linked successfully or an accepted response if the address is being processed asynchronously.

See

API Documentation

Inherited from

MoneriumServerClient.linkAddress

---

moveIban()

moveIban(input: MoveIbanInput): Promise<AcceptedResponse>

Move an IBAN to a different address and chain.

Parameters

Parameter	Type
input	MoveIbanInput

Returns

Promise<AcceptedResponse>

See

API Documentation

Inherited from

MoneriumServerClient.moveIban

---

placeOrder()

placeOrder(input: PlaceOrderInput): Promise<Order | AcceptedResponse>

Place a new order.

Note: For multi-signature orders, the API returns a 202 Accepted response with { status: 202, statusText: "Accepted" } instead of the full Order object.

Parameters

Parameter	Type
input	PlaceOrderInput

Returns

Promise<Order | AcceptedResponse>

Order for regular orders; AcceptedResponse for multi-sig orders.

See

API Documentation

Inherited from

MoneriumServerClient.placeOrder

---

request()

protected request<T>(method: string, path: string, body?: unknown, contentType?: string): Promise<T>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Default value
method	string	undefined
path	string	undefined
body?	unknown	undefined
contentType?	string	'application/json'

Returns

Promise<T>

Inherited from

MoneriumServerClient.request

---

requestFormData()

protected requestFormData<T>(method: string, path: string, form: FormData): Promise<T>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
method	string
path	string
form	FormData

Returns

Promise<T>

Inherited from

MoneriumServerClient.requestFormData

---

requestIban()

requestIban(input: RequestIbanInput): Promise<AcceptedResponse>

Request an IBAN for the profile.

Parameters

Parameter	Type
input	RequestIbanInput

Returns

Promise<AcceptedResponse>

See

API Documentation

Inherited from

MoneriumServerClient.requestIban

---

updateProfileDetails()

updateProfileDetails(input: UpdateProfileDetailsInput): Promise<AcceptedResponse>

Submit the compliance details for a profile. Updates only the details section without affecting other sections.

KYC reliance model only. Most integrations should use shareProfileKYC() to populate details via Sumsub instead.

Parameters

Parameter	Type
input	UpdateProfileDetailsInput

Returns

Promise<AcceptedResponse>

The applicant details have been received and will be processed by Monerium.

See

API Documentation

---

updateProfileForm()

updateProfileForm(input: UpdateProfileFormInput): Promise<AcceptedResponse>

Submit additional data for a profile used for risk calculations (e.g. purpose of account, source of funds). Updates only the form section without affecting other sections.

Parameters

Parameter	Type
input	UpdateProfileFormInput

Returns

Promise<AcceptedResponse>

The profile form has been received and will be processed by Monerium.

See

API Documentation

---

updateProfileVerifications()

updateProfileVerifications(input: UpdateProfileVerificationsInput): Promise<AcceptedResponse>

Submit verifications for a profile. Only the verifications provided are updated. sourceOfFunds is submitted here by all partners when required; other verification kinds are populated automatically when using the Sumsub share flow.

Parameters

Parameter	Type
input	UpdateProfileVerificationsInput

Returns

Promise<AcceptedResponse>

The verification data has been received and will be processed by Monerium.

See

API Documentation

---

uploadSupportingDocument()

uploadSupportingDocument(file: ArrayBuffer | Uint8Array | Blob, filename?: string): Promise<FilesResponse>

Upload a supporting document for KYC onboarding or order support using multipart/form-data.

Accepts binary data in multiple formats and normalizes it to a Blob internally before sending the request.

Parameters

Parameter	Type	Description
file	ArrayBuffer | Uint8Array | Blob	The document to upload. Can be a Blob, Uint8Array, or ArrayBuffer.
filename?	string	Optional filename to associate with the uploaded file. If not provided, a default name will be inferred when possible, otherwise "document" is used.

Returns

Promise<FilesResponse>

See

API Documentation

Remarks

This method constructs a FormData payload internally and sends it to the POST /files endpoint. Consumers do not need to manually create or manage multipart form data.

Inherited from

MoneriumServerClient.uploadSupportingDocument

Webhooks

createSubscription()

createSubscription(input: CreateWebhookSubscriptionInput): Promise<WebhookSubscription>

Create webhook subscription.

Parameters

Parameter	Type
input	CreateWebhookSubscriptionInput

Returns

Promise<WebhookSubscription>

See

API Documentation

Inherited from

MoneriumServerClient.createSubscription

---

getSubscriptions()

getSubscriptions(): Promise<WebhookSubscriptionsResponse>

List all webhook subscriptions for the authenticated user.

Returns

Promise<WebhookSubscriptionsResponse>

See

API Documentation

Inherited from

MoneriumServerClient.getSubscriptions

---

updateSubscription()

updateSubscription(input: UpdateWebhookSubscriptionInput): Promise<WebhookSubscription>

Update an existing webhook subscription.

Parameters

Parameter	Type
input	UpdateWebhookSubscriptionInput

Returns

Promise<WebhookSubscription>

See

API Documentation

Inherited from

MoneriumServerClient.updateSubscription