× Docs Platform Dashboard Extensions Wallets Merchants Sign in

Quick guide

To get started with the API you have a couple options:

  1. You can choose to use one of the Rehive supported SDKs or
  2. Integrate the API manually in your choice of language.

To use one of the SDKs check for you language in the “references list” in the sidebar. If you instead want to use a language that does not have a Rehive supported SDK, a custom implementation should be trivial as the platform uses standard HTTP which is widely supported.

Using the API

The easiest way to get started with the API is to use cURL to make a login request:

curl https://api.rehive.com/3/auth/login/
  -H "Content-Type: application/json"
  -d '{"user": "[email protected]",
       "company": "rehive"
       "password": "joe1234"}'

Once you have your own user you can replace the placeholder data in the example JSON object and then fire off the above request. If successful, you should get a response like this:

    "status": "success",
    "data": {
        "token": "{token}",
        "user": {
            "id": "00000000-0000-0000-0000-000000000000",
            "first_name": "Joe",
            "last_name": "Soap",
            "email": "[email protected]",
            "username": "",
            "id_number": null,
            "birth_date": null,
            "profile": null,
            "currency": null,
            "company": "rehive",
            "language": "en",
            "nationality": "ZA",
            "metadata": {},
            "mobile": "+00000000000",
            "timezone": null,
            "verified": false,
            "status": "pending",
            "kyc": {
                "updated": 1509539801040,
                "status": "pending"
            "verification": {
                "email": true,
                "mobile": true
            "groups": [
                    "name": "test",
                    "label": "Test"
            "permissions": [],
            "settings": {
                "allow_transactions": true,
                "allow_debit_transactions": true,
                "allow_credit_transactions": true
            "created": 1464912953000,
            "updated": 1464912953000,

And there you have it, a successful login! The user was validated and authenticated on the platform and an authentication token returned.

Usin the token returned in the login response you can perform actions, as that user, on endpoints that require authentication. For example, you may want to get a list of emails associated to a user:

curl https://api.rehive.com/3/user/emails/
  -X GET
  -H "Authorization: Token {token}"
  -H "Content-Type: application/json"

If you used the token you previously retrieved you should get a successful response containing a list of user emails:

    "status": "success",
    "data": [
            "id": 1,
            "email": "[email protected]",
            "primary": true,
            "verified": true