Create a new tenant

POST /api/v1/tenants

Description

Create a new tenant.

Request

• Authentication:

  • Type: Bearer Token

  • Token: {{bearerToken}} (Replace with the actual bearer token)

• URL:

  • Raw URL: /api/v1/tenants

  • Host:

  • Path: /api/v1/tenants

Response:

• Status: Created (201)

/api/v1/tenants

Headers

Content-Type	Value
Content-Type	application/json

Body (raw)

{
  "userId": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "aboutMe": "<string>",
  "address": "<string>",
  "photo": "<string>",
  "actionBy": "<string>"
}

🔑 Authentication bearer

Param	value	Type
Auth	{{tenantSupAdminAccessToken}}	string

Response: 201

{
  "code": "{{$randomCode}}",
  "name": "{{$randomTenantName}}",
  "tenantHandle": "{{$randomTenantHandle}}",
  "phone": "{{randomNumberAdmin}}",
  "kycDetails": {
    "businessDetails": {
      "metadata": {
        "isBusinessDeliveryPerformance": false,
        "isKickBackPromised": false,
        "isCompanyRegulated": false,
        "isSharesListed": false,
        "isCompanySubjectToInvestigation": false,
        "isShareholderPoliticallyExposed": false
      },
      "isProofOfBusinessAddressVerified": "PENDING",
      "isTaxIdentificationNumberVerified": "PENDING",
      "isIncorporationNumberVerified": "PENDING",
      "isCacStatusReportVerified": "PENDING",
      "isProofOfBankAccountVerified": "PENDING",
      "isProofOfBankStatementVerified": "PENDING",
      "isProofOfVatCertificateVerified": "PENDING",
      "isCertificateOfIncorporationVerified": "PENDING",
      "isArticlesOfAssociationVerified": "PENDING",
      "directorsProofOfAddress": [],
      "isDirectorsProofOfAddressVerified": "PENDING",
      "shareHoldersProofOfAddress": [],
      "isShareHoldersProofOfAddressVerified": "PENDING",
      "directorsProofOfIdentification": [],
      "status": "PENDING",
      "additionalShareholdersDetails": [],
      "guarantorDetails": []
    }
  },
  "wallet": {
    "virtualBankCode": "035",
    "virtualBankName": "Wema Bank",
    "createdAt": null,
    "accounts": []
  },
  "_id": "{{$randomId}}",
  "createdAt": "{{$timestamp}}",
  "updatedAt": "{{$timestamp}}",
  "__v": 0
}