POST
/
api
/
v1
/
customers
/
corporate-customers
/
create
Create a new corporate customer.
curl --request POST \
  --url https://demoapi.saasphereltd.com/api/v1/customers/corporate-customers/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_name": "Acme Corp",
  "office_address": "1 Business St",
  "city": "Lagos",
  "lga": 1,
  "state": 25,
  "country": "Nigeria",
  "office_phone": "08012345678",
  "company_email": "info@acme.com",
  "commencement_date": "2020-01-01",
  "sector_id": 5,
  "business_nature": "Trading",
  "annual_revenue": "1000000",
  "annual_turnover": "1200000",
  "form_field": [
    {
      "1": "Field Value 1"
    },
    {
      "2": "Field Value 2"
    }
  ],
  "directors": [
    1,
    2
  ],
  "new_shareholders": [
    {
      "uid": "frontend-auto-generated-id",
      "first_name": "John",
      "surname": "Doe",
      "gender": "male",
      "mobile_1": "08012345678",
      "means_of_id": "national_id",
      "id_card_number": "12345",
      "id_issue_date": "2020-01-01",
      "id_expiry_date": "2020-01-01",
      "nationality": "Nigerian",
      "bvn": "12345678901",
      "personal_email": "example@example.com",
      "official_email": "official@example.com"
    }
  ],
  "documents": [
    {
      "1": "document1.pdf"
    },
    {
      "2": "document2.pdf"
    }
  ]
}
'
{
  "status": "00",
  "message": "Customer has been created successfully with Customer ID: CUST001",
  "data": []
}

Authorizations

​
Authorization
string
header
required

Paste only the token (no "Bearer " prefix).

Body

application/json
​
company_name
string
required

Company name.

Example:

"Acme Corp"

​
office_address
string
required

Office address.

Example:

"1 Business St"

​
city
string
required

City.

Example:

"Lagos"

​
lga
integer
required

LGA ID from LGA list.

Example:

1

​
state
integer
required

State ID from State list.

Example:

25

​
country
string
required

Country.

Example:

"Nigeria"

​
office_phone
string
required

Office phone (digits:11).

Example:

"08012345678"

​
company_email
string
required

Company email.

Example:

"info@acme.com"

​
commencement_date
string
required

Commencement date.

Example:

"2020-01-01"

​
sector_id
integer
required

Sector id from sector list.

Example:

5

​
business_nature
string
required

Business nature.

Example:

"Trading"

​
annual_revenue
string
required

Annual revenue.

Example:

"1000000"

​
annual_turnover
string
required

Annual turnover.

Example:

"1200000"

​
form_field
object[]

optional Array of custom form fields. Each object has a dynamic key (the form_field_id gotten from fetch form field endpoint) with the value.

Example:
[
  { "1": "Field Value 1" },
  { "2": "Field Value 2" }
]
​
directors
integer[]

optional Array of existing director IDs

Example:
[1, 2]
​
new_shareholders
object[]

optional Array of new shareholder objects

Example:
[
  {
    "uid": "frontend-auto-generated-id",
    "first_name": "John",
    "surname": "Doe",
    "gender": "male",
    "mobile_1": "08012345678",
    "means_of_id": "national_id",
    "id_card_number": "12345",
    "id_issue_date": "2020-01-01",
    "id_expiry_date": "2020-01-01",
    "nationality": "Nigerian",
    "bvn": "12345678901",
    "personal_email": "example@example.com",
    "official_email": "official@example.com"
  }
]
​
documents
object[]

optional Documents (file uploads). Each object has a dynamic key (the document_id gotten from fetch document_type endpoint) with the uploaded file.

Example:
[
  { "1": "document1.pdf" },
  { "2": "document2.pdf" }
]

Response

201 - application/json
​
status
string
Example:

"00"

​
message
string
Example:

"Customer has been created successfully with Customer ID: CUST001"

​
data
object