Skip to content
Aureus PrimeDocs

Getting started

Create an account and get an API key

1. Sign in

Open the Aureus Desk account area (https://dashboard.getaureusdesk.com) and sign in with your Aureus Prime account (email and password, Google or Facebook): a single sign-in for all Aureus services. The account area opens on your personal account.

2. Have your account verified

To send SMS to other people, you need:

  • individual: your identity verified (KYC);
  • organisation: your business verified (KYB).

Verification takes place in your Aureus Prime account. Until it is done, sending to a third party returns 403 VERIFICATION_REQUIRED.

Before verification, only one kind of sending is allowed: the test SMS to your own number, if it is verified in your Aureus Prime account and is a mobile in an open country. This way you see the SMS arrive before having your account verified.

Based abroad? You can open an account and send to mobiles in open countries. If your own number is not in an open country, it cannot receive a test SMS: have your identity or business verified straight away.

3. Top up

A top-up is made in FCFA, from 10,000: 1 credit = 1 FCFA, with bonus credits on large top-ups (see Balance and top-ups). During the pilot, you request the top-up from the account area, then pay by MTN Mobile Money, Orange Money, cash against a receipt, or through the online payment link we attach to your request (handy from abroad). The credits are added as soon as the payment is received.

4. Create an API key

In the API keys section of the account area:

  1. give the key a name (for example "Website");
  2. copy the key shown — it starts with adk_sms_ and will never be shown again;
  3. store it in your server's environment variables, for example AUREUS_SMS_API_KEY.

You can have 2 active keys at most: the second one lets you change keys without downtime (see Authentication).

Next

Send your first SMS with the quick start.