Reference tables
Business type codes
businessTypeCode in Create Business Profile and Update Business Profile accepts one of:
SoleProprietor, Partnership, Llc, Corporation, NonProfit, Cooperative, Trust, FinancialInstitution, Other
Sent as a string naming the value, e.g. "businessTypeCode": "Llc". Matching is case-insensitive, so "llc" is also accepted, but underscored spellings (SOLE_PROPRIETOR, NON_PROFIT) are not — see the changelog.
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).
Document type codes
documentType in Request a Document Upload Link accepts one of:
| Value | Name | Use for |
|---|---|---|
1 | UboIdentity | An identity document backing a person's identities[] entry (requires uboId). |
2 | BusinessDocument | A business-level document (e.g. proof of address, incorporation certificate). |
Send the string name ("UboIdentity" or "BusinessDocument"), not the number, in the request body.
Upload content types
contentType in Request a Document Upload Link accepts exactly one of:
application/pdf, image/jpeg, image/png
The upload PUT must send the same value as its Content-Type header, and the file must be of that type.