UMA Invitations Setup

Before starting your Lightspark UMA invitations integration, you need to register your VASP with Lightspark.

Joining the Invite Program

If you are interested in becoming a VASP listed on UMA.ME invitations, please contact us.

You will need to provide:

A name and a logo to be displayed in the invitation page.
A list of countries you operate UMA in.
An onboarding URL for people who want to create an account with you (this URL must support UMA.ME invitation codes). Example: http://vasp.com/uma?code=INVITATION_CODE
A webhook URL to get notified when your invitations get claimed.

SDKs

UMA invites are created and claimed using the Lightspark SDK. The SDK is available in multiple languages and can be used in your backend to create and claim UMA invites.

You can select your preferred language below and add the SDK to your backend.

// npm:
$ npm install --save @lightsparkdev/lightspark-sdk
// yarn:
$ yarn add @lightsparkdev/lightspark-sdk

All of our SDKs are open source and you can audit their source code on their Github Repository.

You can then create a client and start using the API! Check out the Lightspark SDK's "Authentication" section to get your API Token.

import { AccountTokenAuthProvider, LightsparkClient } from "@lightsparkdev/lightspark-sdk";

const API_TOKEN_CLIENT_ID = <your api token id>;
const API_TOKEN_CLIENT_SECRET = <your api token secret>;

const client = new LightsparkClient(
  new AccountTokenAuthProvider(API_TOKEN_CLIENT_ID, API_TOKEN_CLIENT_SECRET)
);

// Create an invitation with incentives:
const invitation = await client.createUmaInvitationWithIncentives(
  /* inviterUma */ "$alice@testvasp1.com",
  /* inviterPhoneNumberE164 */ "+15555557890",
  /* inviterRegion */ RegionCode.Us
);

See the Lightspark SDK for more information about using the SDK.