Create User Invite

POST /api/v1/users/public/invite

Description

Create a user invite for users.

URL:

/api/v1/users/public/invite?invitedByName=<string>&invitedByEmail=<string>&platformLink=<string>&invitation=SABI

Headers:

• Content-Type: application/json
• ApiKey: The platform api key is required to use this endpoint - {{platformApiKey}}

Request Body: JSON data containing user information.

Roles: Among the user informations that can be passed is role the table below describes supported roles. When a role is not provided the default user role is CUSTOMER.

Gender: The request body should also include the new user's gender which can be either Male or Female.

URL: /api/v1/users/public/invite?invitedByName=&invitedByEmail=&platformLink=&invitation=SABI

Query Parameters: invitedByName (Required): URL to the platform invitation is sent for. invitedByEmail (Required): URL to the platform invitation is sent for. platformLink (Required): URL to the platform invitation is sent for. invitation (Required): Any one of MERCHANT, SUPPLIER, TRACE, AGENCY, CUSTOMER, AGENT, SABI, MANAGEMENT

Response: The response is a "Created" status with a code of 201.

Supported Roles:

Role	Description
CUSTOMER	This is the default role. An individual or entity purchasing goods or services from a business or seller.
MERCHANT	A business or individual that sells goods or services to customers.
SUPPLIER	An entity providing goods or services to another business or individual.
AGENCY_BANKING	A financial institution that offers banking services through third-party agents.
SABI_AGENT	An agent involved in facilitating transactions or services within the Sabi platform.
SABI_OWN	An entity or individual with ownership or administrative rights within the Sabi platform.
TRACE_BUYER	A user responsible for tracking or monitoring purchasing activities.
TRACE_SELLER	A user responsible for tracking or monitoring selling activities.
TENANT_SUPER_ADMIN	An individual with elevated administrative privileges overseeing multiple aspects within a tenant or organizational structure.
TENANT_ADMIN	An individual responsible for administrative tasks within a specific tenant or organizational unit.

Supported Gender:

• MALE,
• FEMALE

Params

invitedByName type - string (Required)

invitedByEmail string

(Required) URL to the platform invitation is sent for.

platformLink string

(Required) URL to the platform invitation is sent for.

invitation SABI

(Required) Any one of MERCHANT,SUPPLIER,TRACE,AGENCY,CUSTOMER,AGENT,SABI

Example Body:

{
  "tenantId": "<string>",
  "role": "SUPPLIER",
  "username": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "address": "<string>",
  "country": {
    "name": "<string>",
    "code": "<string>",
    "currency": "<string>"
  },
  "state": {
    "name": "<string>",
    "code": "<string>"
  },
  "city": {
    "name": "<string>",
    "code": "<string>"
  },
  "photo": "<string>",
  "actionBy": "<string>",
  "dob": "<string>",
  "gender": "MALE",
  "phone": "<string>",
  "companyName": "<string>",
  "bvn": "<string>",
  "nin": "<string>"
}

Example Request

curl --location -g '/api/v1/users/public/invite?invitedByName=%3Cstring%3E&invitedByEmail=%3Cstring%3E&platformLink=%3Cstring%3E&invitation=SABI'

Untitled Response

--header 'Content-Type: application/json' \
--data '{
  "tenantId": "<string>",
  "role": "SUPPLIER",
  "username": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "address": "<string>",
  "country": {
    "name": "<string>",
    "code": "<string>",
    "currency": "<string>"
  },
  "state": {
    "name": "<string>",
    "code": "<string>"
  },
  "city": {
    "name": "<string>",
    "code": "<string>"
  },
  "photo": "<string>",
  "actionBy": "<string>",
  "dob": "<string>",
  "gender": "MALE",
  "phone": "<string>",
  "companyName": "<string>",
  "bvn": "<string>",
  "nin": "<string>"
}'

• 201 CREATED