User Profile

On this page, we'll dive into the different profile endpoints you can use to manage user profiles programmatically. Here, you can create, update, and view profile information for any Supesa user.

The profile model

The profile model contains all the essential information about the Supesa users, which includes their basic details and addresses.

Properties

Name
first_name
Type
string
Description
The first name of the user
Name
last_name
Type
string
Description
The last name of the user
Name
dob
Type
string
Description
Date of birth of the user
Name
phone_number
Type
string
Description
Contact number of the user
Name
address_l1
Type
string
Description
Address line 1 of the user
Name
address_l2
Type
string
Description
Address line 2 of the user
Name
address_postcode
Type
string
Description
Postal code of the user's address
Name
ccy_iso_default
Type
string
Description
Default currency ISO code

POST/account/profile/create

Create a new profile

This endpoint allows you to create a new user profile in Supesa.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id
Name
first_name
Type
string
Description
The first name of the user
Name
last_name
Type
string
Description
The last name of the user
Name
dob
Type
string
Description
The birthday datetime in the format of YYYY-MM-DD
Name
last_name
Type
string
Description
The last name of the user
Name
phone_number
Type
string
Description
User's phone number
Name
supatag
Type
string
Description
The user's unique @supatag
Name
address_l1
Type
string
Description
First line of the user's address
Name
address_l2
Type
string
Description
Second line of the user's address
Name
address_postcode
Type
string
Description
User's address postcode
Name
ccy_iso_default
Type
string
Description
The user's default currency (i.e. NGN, GHS etc.)
Name
entropy
Type
string
Description
The provided alphanumeric string used whilst creating the user's wallets

Request

POST

/account/profile/create

curl -X POST https://api.supesa.io/account/profile/create \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID",
      "first_name": "Adewale",
      "last_name": "Oluwa",
      "phone_number": "+234693930303",
      "supatag": "oluwa",
      "address_l1": "123 Upstreet",
      "address_l2": "Downtown",
      "address_postcode": "1234 AB",
      "ccy_iso_default": "NGN",
      "entropy": "92Xj20-wkw-2ls0as2"
    }'

Response

{
  "code": 201,
  "message": {
      "user_id": "YOUR_USER_ID",
      "first_name": "Adewale",
      "last_name": "Oluwa",
      "phone_number": "+234693930303",
      "supatag": "oluwa",
      "address_l1": "123 Upstreet",
      "address_l2": "Downtown",
      "address_postcode": "1234 AB",
      "ccy_iso_default": "NGN",
      "entropy": "92Xj20-wkw-2ls0as2"
    },
  "ref": "a6252318-9348-4c4f-b1df-66809a7cd7bb"
}

PUT/account/profile/update

Update an existing profile

This endpoint allows you to update an existing user profile in Supesa.

Important Notes

Only the access_token and user_id are mandatory. You can supply other fields that need to be updated.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id

Optional Attributes

Name
first_name
Type
string
Description
The first name of the user
Name
last_name
Type
string
Description
The last name of the user
Name
dob
Type
string
Description
Date of birth of the user
Name
phone_number
Type
string
Description
Contact number of the user
Name
address_l1
Type
string
Description
Address line 1 of the user
Name
address_l2
Type
string
Description
Address line 2 of the user
Name
address_postcode
Type
string
Description
Postal code of the user's address
Name
ccy_iso_default
Type
string
Description
Default currency ISO code

Request

PUT

/account/profile/update

curl -X PUT https://api.supesa.io/account/profile/update \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID",
      "phone_number": "+2345959595",
      // ... (other attributes that need to be updated) ...
    }'

Response

{
  "code": 200,
  "message": {
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID",
      "first_name": "Adewale",
      "last_name": "Oluwa",
      "phone_number": "+2345959595",
      "supatag": "oluwa",
      "address_l1": "123 Upstreet",
      "address_l2": "Downtown",
      "address_postcode": "1234 AB",
      "ccy_iso_default": "NGN",
      "entropy": "92Xj20-wkw-2ls0as2"
    },
  "ref": "df53f1b2-ade3-4e4e-bf0d-2c72edf45678"
}

POST/account/profile/view

View a profile

This endpoint allows you to view the user profile details in Supesa.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id

Request

POST

/account/profile/view

curl -X POST https://api.supesa.io/account/profile/view \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID"
    }'

Response

{
  "code": 200,
  "message": "Profile fetched successfully",
  "data": {
      "profile": [
        {
          "id": 89,
          "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
          "created_at": "2023-10-16T20:30:22.904909+00:00",
          "first_name": "Lagos",
          "last_name": "Test",
          "dob": "2023-10-16",
          "phone_number": "07948282822",
          "address_l1": "",
          "address_l2": "",
          "address_postcode": "",
          "ccy_iso_default": "NGN"
        }
      ],
      "supatag": [
        {
          "id": 40,
          "created_at": "2023-10-16T20:30:22.977586+00:00",
          "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
          "supatag": "lagos"
        }
      ]
    }
}

POST/account/profile/alias/create

Create an alias

This endpoint allows you to create an alias for your supatag.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id

Request

POST

/account/profile/alias/create

curl -X POST https://api.supesa.io/account/profile/alias/create \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID"
    }'

Response

{
  "code": 201,
  "message": [
    {
      "id": 63,
      "created_at": "2023-11-01T09:42:47.647191+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "supatag": "lagos",
      "alias": "become-entire-night",
      "alias_uuid": "7f5552fb-85dc-4efc-b8fc-729f0a62bbce"
    }
  ],
  "ref": "6c0fd306-a3aa-48f4-9cdd-10a7502cbf35"
}

POST/account/profile/alias/view

View aliases

This endpoint allows you to view all existing aliases.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id

Request

POST

/account/profile/alias/view

curl -X POST https://api.supesa.io/account/profile/alias/view \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID"
    }'

Response

{
  "code": 200,
  "message": [
    {
      "id": 53,
      "created_at": "2023-10-17T14:18:11.392908+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "supatag": "lagos",
      "alias": "say-difficult-money",
      "alias_uuid": "30152453-2734-40c7-8ba9-3b331a6b5641"
    },
    {
      "id": 55,
      "created_at": "2023-10-18T15:05:15.474851+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "supatag": "lagos",
      "alias": "may-long-number",
      "alias_uuid": "d15164b5-94ee-4298-867a-23c158eb249e"
    },
    {
      "id": 56,
      "created_at": "2023-10-18T15:06:19.033992+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "supatag": "lagos",
      "alias": "build-national-day",
      "alias_uuid": "2ee4d75c-b7f3-4a38-a38c-90b9cb37eff4"
    },
    {
      "id": 60,
      "created_at": "2023-10-20T11:44:09.705262+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "supatag": "lagos",
      "alias": "open-clear-word",
      "alias_uuid": "6a89de28-09b9-4ae7-aa67-04cb4b5fe72d"
    },
    {
      "id": 63,
      "created_at": "2023-11-01T09:42:47.647191+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "supatag": "lagos",
      "alias": "become-entire-night",
      "alias_uuid": "7f5552fb-85dc-4efc-b8fc-729f0a62bbce"
    }
  ],
  "ref": "3c74d5ca-bba2-4fed-9c2d-5ccd787ad33c"
}

POST/account/profile/alias/delete

Delete aliase

This endpoint allows you to delete one of the existing aliases.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id
Name
alias_uuid
Type
string
Description
The unique alias identifier

Request

POST

/account/profile/alias/delete

curl -X POST https://api.supesa.io/account/profile/alias/delete \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID",
      "alias_uuid": "YOUR_ALIAS_UUID"
    }'

Response

{
  "code": 201,
  "message": [
    {
      "id": 63,
      "created_at": "2023-11-01T09:42:47.647191+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "supatag": "lagos",
      "alias": "become-entire-night",
      "alias_uuid": "7f5552fb-85dc-4efc-b8fc-729f0a62bbce"
    }
  ],
  "ref": "c8c2c27e-7ee9-4ad1-9b56-154ecf7b6571"
}