Skip to main content
POST
https://devapi.withedge.co/gateway/api/v1
/
customer
/
profile
/
business
Profile Business
curl --request POST \
  --url https://devapi.withedge.co/gateway/api/v1/customer/profile/business \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'requestId: <requestid>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "otherName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "salutation": "<string>",
  "gender": "<string>",
  "dateOfBirth": "<string>",
  "bvn": "<string>",
  "nationality": "<string>",
  "address": {
    "address": "<string>",
    "street": "<string>",
    "localGovernment": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "businessName": "<string>",
  "countryOfResidence": "<string>",
  "dateOfIncorporation": "<string>",
  "taxId": "<string>",
  "stateOfResidence": "<string>",
  "stateOfRegistration": "<string>",
  "rcNumber": "<string>",
  "directorFullName": "<string>",
  "directorBvn": "<string>",
  "directorIdDocumentType": "<string>",
  "directorIdDocumentNumber": "<string>",
  "directorPoliticalAffiliationRelationship": "<string>",
  "shareholderShareholderBvn": "<string>",
  "shareholderPercentShareholder": "<string>",
  "shareholderIdDocumentType": "<string>",
  "shareholderIdDocumentNumber": "<string>",
  "shareholderPoliticalAffiliationRelationship": "<string>"
}
'
{
    "statuscode": "00",
    "message": "Customer successfully profiled",
    "data": {
      "customerId": "7120739910",
    }
    "errors": [],
}

​
Profile Business

Use this endpoint to profile a business by providing detailed business and personal information.

​
Request Parameters

​
requestId
string
required
A unique identifier for the request, used for idempotency.
Example: e0b9f8d0-7a57-4a67-a8b2-4d7c7b5a37c9
​
firstName
string
required
The first name of the customer.
Example: John
​
lastName
string
required
The last name of the customer.
Example: Doe
​
otherName
string
required
Any other names of the customer.
Example: Michael
​
email
string
required
The customer’s email address.
Example: [email protected]
​
phone
string
required
The customer’s phone number.
Example: 08012345678
​
salutation
string
required
The salutation of the customer.
Example: Mr
​
gender
string
required
The gender of the customer.
Example: Male
​
dateOfBirth
string
required
The customer’s date of birth in YYYY-MM-DD format.
Example: 1980-01-01
​
bvn
string
required
The customer’s Bank Verification Number.
Example: 12345678901
​
nationality
string
required
The nationality of the customer.
Example: NGA
​
address
object
required
​
address
string
required
The address details of the customer.
Example: 123 Main Street
​
street
string
required
The street of the address.
Example: Main Street
​
localGovernment
string
required
The local government of the address.
Example: Ikeja
​
city
string
required
The city of the address.
Example: Lagos
​
country
string
required
The country of the address.
Example: NGA
​
businessName
string
required
The name of the business.
Example: Doe Enterprises
​
countryOfResidence
string
required
The country where the business resides.
Example: NGA
​
dateOfIncorporation
string
required
The date the business was incorporated in YYYY-MM-DD format.
Example: 2020-01-01
​
taxId
string
required
The tax identification number of the business.
Example: TX12345
​
stateOfResidence
string
required
The state where the business resides.
Example: Lagos
​
stateOfRegistration
string
required
The state where the business is registered.
Example: Ogun
​
rcNumber
string
required
The RC (Registration Certificate) number of the business.
Example: RC12345
​
directorFullName
string
required
The full name of the director.
Example: John Doe
​
directorBvn
string
required
The BVN of the director.
Example: 98765432101
​
directorIdDocumentType
string
required
The ID document type of the director (e.g., CAC).
Example: CAC
​
directorIdDocumentNumber
string
required
The ID document number of the director.
Example: ID12345
​
directorPoliticalAffiliationRelationship
string
required
The political affiliation relationship of the director.
Example: None
​
shareholderShareholderBvn
string
required
The BVN of the shareholder.
Example: 12345678901
​
shareholderPercentShareholder
string
required
The percentage of shares held by the shareholder.
Example: 10
​
shareholderIdDocumentType
string
required
The ID document type of the shareholder (e.g., CAC).
Example: CAC
​
shareholderIdDocumentNumber
string
required
The ID document number of the shareholder.
Example: ID67890
​
shareholderPoliticalAffiliationRelationship
string
required
The political affiliation relationship of the shareholder.
Example: None
{
    "statuscode": "00",
    "message": "Customer successfully profiled",
    "data": {
      "customerId": "7120739910",
    }
    "errors": [],
}