Page cover

Request Corporate Account

Endpoint

POST {{base_url}}/v1/accounts/request-corporate-account

Description

This endpoint is used to request a corporate account.

Request Body

The request body should be a form-data object containing the following fields:

  • countryShort: "NG" Acceptable country shorts are ; UK, FR, DE, IT, ES, NG, BJ, ML, TG, CI, US. See more

  • companyName: "PrunePayments Ltd"

  • director_1_idType: "passport"

  • director_1_idFile: passport.jpg

  • director_1_poaType: "utilityBill"

  • director_1_poaFile: utilityBill.jpg

  • shareholder_1_idType: "passport"

  • shareholder_1_idFile: passport.pdf

  • shareholder_1_poaType: "utilityBill"

  • shareholder_1_poaFile: utilityBill.pdf

  • certificateOfIncorporation: cac.pdf

  • mermat: mermat.pdf

  • currency: GBP

Click here to see the full list of acceptable ID and POA types

circle-info

Important Notes:

  • ID and POA type identifiers are case-sensitive. Click here to learn more.

  • Non-passport ID types (identity card, driving license, and residence permit) require an "idFileBack" field for a successful request.

  • File upload size limit is 500KB

  • Acceptable file extensions are: ".jpeg", ".jpg", ".png", ".pdf"

Example Request

Field
Value
Type
Required

countryShort

NG

string

True

companyName

PrunePayments LTD

string

True

director_1_idType

passport

string

True

director_1_idFile

passport.jpg

file

True

director_1_poaType

utilityBill

string

True

director_1_poaFile

utilityBill.pdf

file

True

shareholder_1_idType

passport

string

True

shareholder_1_idFile

passport.png

file

True

shareholder_1_poaType

utilityBill

string

True

shareholder_1_poaFile

utilityBill.jpeg

file

True

certificateOfIncorporation

cac.pdf

file

True

mermat

mermat.pdf

file

True

currency

GBP

string

True

Response

The API will return a JSON object containing the details of the requested business account. The response reflects the current verification status of the account and typically falls into one of two categories:

Trusted Business Response

  • Indicates the issuing organisation is recognized as trusted.

  • The initial requestStatus will be INPROGRESS, meaning the account is Process to be APPROVED.

Untrusted Business Response

  • Indicates the business is either new, unverified, or under manual review.

  • The requestStatus will be PENDING, meaning the account is awaiting full verification. While in this state, certain features may be restricted until the review is completed.

  • If the request fails the verification process, the Admin will reject it, and the status will update to REJECTED.

Below are sample responses:

Error Responses

Include common error responses and their meanings.

  • 400 Bad Request: One or more fields are missing or invalid.

  • 500 Internal Server Error: An error occurred on the server.

Last updated