Skip to main content

Reference tables

Business type codes​

businessTypeCode in Create Business Profile and Update Business Profile accepts one of:

CodeBusiness type
CorporateCorporates: a company or other incorporated body
SoleTraderSole Trader: a business owned and run by one individual
PaymentMtoPayment/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.Invalid, and a business type that is not offered is 400 BusinessType.NotOffered.

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:

ValueName
1UBO
2DIRECTOR
3SHAREHOLDER

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:

purposeUse fordocumentCategory
BusinessDocumentA 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.
beneficiaryA supporting document for a payout beneficiary.Invoice or Contract.
payoutA supporting document a payout cites, such as the invoice it pays.Invoice or Contract.

Any other value, or no purpose, is 400 Document.UnknownPurpose. 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 purpose BusinessDocument it accepts one of application/pdf, image/jpeg, image/png, application/msword or application/vnd.openxmlformats-officedocument.wordprocessingml.document.
  • With purpose beneficiary or payout it accepts one of application/pdf, image/jpeg or 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.

FormatcontentType
pdfapplication/pdf
jpg, jpegimage/jpeg
pngimage/png
docapplication/msword
docxapplication/vnd.openxmlformats-officedocument.wordprocessingml.document

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.monthlyTurnover on Create business profile and Update business profile accepts one of:

ValueMoney moved a month (USD)
UpTo15kUp to 15,000
UpTo50kUp to 50,000
UpTo100kUp to 100,000
UpTo500kUp to 500,000
Above500kAbove 500,000

Send the band, not an amount: "450000" is refused with 400 ValidationControl.Error; send "UpTo500k".

Monthly volume bands​

financials.monthlyVolume accepts one of:

ValueTransactions a month
UpTo100Up to 100
UpTo500Up to 500
UpTo1000Up to 1,000
UpTo5000Up to 5,000
UpTo10000Up to 10,000
Above10000Above 10,000

Transaction value bands​

financials.estimatedTransactionValue accepts one of:

ValueTypical transaction (USD)
UpTo5kUp to 5,000
UpTo15kUp to 15,000
UpTo50kUp to 50,000
UpTo100kUp to 100,000
Above100kAbove 100,000

Sources of funds and account purposes​

financials.primarySourceOfFunds and financials.businessAccountPurpose have no list. They are free text of up to 500 characters; see Create business profile.

Transaction frequencies​

financials.monthlyTransactionFrequency accepts one of:

ValueMeaning
DailyDaily
SeveralTimesAWeekSeveral times a week
WeeklyWeekly
BiWeeklyEvery two weeks
OccasionallyOccasionally, as needed