POST /v1/channel-partner/create-business
Payload
This is a sample payload required to create a customer partner account.
{
"channel_partner_id": "abc123dc3rgff434", // will be provided
"email": "[email protected]",
"first_name": "Johm",
"last_name": "Doe",
"country_name": "Nigeria",
"country_short_name": "NG",
"business_name": "Apple",
"company_description": "",
"industry": "Logistics",
"company_size": "1-5",
"sector": "lender", // ["lender", "market-place", "aggregator"]
"years_of_operations": "2+ Years",
"tax_identification_number": "1234567890",
"company_name": "Apple Inc",
"support_email": "[email protected]",
"phone_number": "2348000000001",
"website": "www.apple.co",
"registered_country": "Nigeria",
"registered_state": "Lagos",
"registered_city": "Yaba",
"registered_street": "229 Herbert Macaulay road"
}
The payload object
payload objectAll fields are compulsory
channel_partner_id string
A reference to the channel partner
email string
Email address of the customer partner
first_name string
First name of a representative of the customer partner
last_name string
Last name of a representative of the customer partner
country string
Short name of the country that the customer partner operates in
business_name string
Name of the customer partner's business
company_description string
A description of the company
industry string
The industry the customer partner is in. E.g: "Agriculture", "Commerce", "Education", "Financial Services", "Gaming", "Hospitality", "Health", "Leisure & Entertainment", "Logistics", "Travel", "Utilities"
company_size string
Size of the company. E.g: "1-5", "6-20", "21-50", "50+"
sector string
Sector of the customer partner's business. E.g: "lender", "market-place", "payment-aggregator"
years_of_operations string
How long the cusomter partner's business has been in operation. E.g: "0-2 Years", "2+ Years"
tax_identification_number string
The customer partner's tax id number
company_name string
Registered name of the customer partner's name
support_email string
Customer partner's support email
phone_number string
Customer partner's phone number
website string
Customer partner's official website
registered_country string
Address of the customer partner's company. Eg: Nigeria
registered_state string
Address of the customer partner's company. Eg: Lagos
registered_city string
Address of the customer partner's company. Eg: Yaba
registered_street string
Address of the customer partner's company. Eg: 229 Herbert Macaulay road
Response
This is the expected response if the request is successful.
{
"status": "success",
"message": "Customer partner created successfully",
"data": {
"partner": {
"name": "Apple",
"street": "229 Herbert Macaulay road",
"city": "Yaba",
"state": "Lagos",
"email": "[email protected]",
"contact_number": "2348000000001",
"user": "jWdnQ9ARTPgVrGJS",
"tin": "1234567890",
"legal_name": "Apple Inc",
"business_email": "[email protected]",
"support_email": "[email protected]",
"country": "BmR31Of0hnPCkva2",
"country_id": "BmR31Of0hnPCkva2",
"customer_partner_account_id": "o19TwJiaCO2aB4Mw",
"app_key": "$2a$10$PhD3HkCH.j.pHB/caFAhIu33L4IevJzcq7eejs17vfTZxKkrLgG7K",
"slug": "apple-ng-0-1",
"id": "WgqBgFfSqhhT5rUH",
"created_at": "2024-06-07T13:46:20.000Z",
"updated_at": "2024-06-07T13:46:20.000Z",
"data_sharing_webhook_url": "http://localhost:4021/webhooks/WgqBgFfSqhhT5rUH"
},
"compliance": {
"partner_id": "WgqBgFfSqhhT5rUH",
"partner_type": "customer partner",
"root_user": "jWdnQ9ARTPgVrGJS",
"credit_assessment_status": "not-started",
"id": "pBGTuy0GCAUEs26P",
"created_at": "2024-06-07T13:46:20.000Z",
"updated_at": "2024-06-07T13:46:20.000Z"
}
}
}