Reference tables
Business type codes
businessTypeCode in Create Business Profile and Update Business Profile accepts one of:
| Code | Business type |
|---|---|
Corporate | Corporates: a company or other incorporated body |
SoleTrader | Sole Trader: a business owned and run by one individual |
PaymentMto | Payment/MTO: a payment service provider or money transfer operator |
Sent as a string naming the value, e.g. "businessTypeCode": "Corporate". Matching is case-insensitive, so "corporate" is also accepted.
Send the name, not a number. Any other value is refused: a name the API does not know is 400 Request., and a business type that is not offered is 400 BusinessType..
Industry codes
industry in Create Business Profile and Update Business Profile is sent as a string naming one of:
Retail, FinancialServices, Health, Agriculture, Logistics, Education, Construction, Hospitality, Manufacturing, InformationTechnology, Legal, Media, Telecommunications, MiningAndEnergy, NonProfit, Government, Wholesale, FoodAndBeverage, Automotive, ArtsAndCulture, Other
Identity type codes
idTypeCode on an identity accepts one of the codes below. Each person can only use the codes accepted for their country of residence.
NATIONAL_ID, PASSPORT, DRIVING_LICENCE, IDENTITY_CARD, RESIDENCE_CARD, VOTER_CARD, BVN, OTHERS, NIN, SSN, TIN
Ownership types
ownershipType array entries on a business person are integers:
| Value | Name |
|---|---|
1 | UBO |
2 | DIRECTOR |
3 | SHAREHOLDER |
A person can hold more than one role at once (e.g. [1, 2] for a UBO who is also a director).
Upload purposes
purpose in Request a Document Upload Link is required and accepts one of these, not case-sensitive:
purpose | Use for | documentCategory |
|---|---|---|
BusinessDocument | A KYB document for the business's onboarding, such as proof of address or a certificate of incorporation. | A document type code from Get document requirements. |
beneficiary | A supporting document for a payout beneficiary. | Invoice or Contract. |
payout | A supporting document a payout cites, such as the invoice it pays. | Invoice or Contract. |
Any other value, or no purpose, is 400 Document.. Identity documents for a business's people are not uploaded through the API.
Upload content types
contentType in Request a Document Upload Link is matched exactly, in lower case.
- With
purposeBusinessDocumentit accepts one ofapplication/,pdf image/,jpeg image/,png application/ormsword application/.vnd. openxmlformats-officedocument. wordprocessingml. document - With
purposebeneficiaryorpayoutit accepts one ofapplication/,pdf image/orjpeg image/.png
Which business document formats a document accepts is set per document: allowedFormats in Get document requirements for a document the customer's configuration lists, otherwise defaultAllowedFileFormats in List document types.
| Format | contentType |
|---|---|
pdf | application/ |
jpg, jpeg | image/ |
png | image/ |
doc | application/ |
docx | application/ |
The upload PUT must send the same value as its Content-Type header, and the file must be of that type.
Monthly turnover bands
financials. on Create business profile and Update business profile accepts one of:
| Value | Money moved a month (USD) |
|---|---|
UpTo15k | Up to 15,000 |
UpTo50k | Up to 50,000 |
UpTo100k | Up to 100,000 |
UpTo500k | Up to 500,000 |
Above500k | Above 500,000 |
Send the band, not an amount: "450000" is refused with 400 ValidationControl.; send "UpTo500k".
Monthly volume bands
financials. accepts one of:
| Value | Transactions a month |
|---|---|
UpTo100 | Up to 100 |
UpTo500 | Up to 500 |
UpTo1000 | Up to 1,000 |
UpTo5000 | Up to 5,000 |
UpTo10000 | Up to 10,000 |
Above10000 | Above 10,000 |
Transaction value bands
financials. accepts one of:
| Value | Typical transaction (USD) |
|---|---|
UpTo5k | Up to 5,000 |
UpTo15k | Up to 15,000 |
UpTo50k | Up to 50,000 |
UpTo100k | Up to 100,000 |
Above100k | Above 100,000 |
Sources of funds and account purposes
financials. and financials. have no list. They are free text of up to 500 characters; see Create business profile.
Transaction frequencies
financials. accepts one of:
| Value | Meaning |
|---|---|
Daily | Daily |
SeveralTimesAWeek | Several times a week |
Weekly | Weekly |
BiWeekly | Every two weeks |
Occasionally | Occasionally, as needed |