Products and fields

Reference for all verification products, product codes, UGX prices, required fields, and selection values in the MasterID catalog.

GET /catalog is the authoritative source for the current product list, required fields, allowed selections, and wallet charges. All listed fields are required for submission. Date fields use the format YYYY-MM-DD. There are no file uploads in v1. This page summarises every product and the fields you must supply, with illustrative example bodies for each check.

Bank names for the bank-account product are returned in the catalog response. Always fetch the latest allowed selections from GET /catalog before building submission forms.

Product summary

Product	Code	Price (UGX)	Required fields
National ID Verification	nin	2,500	nin, cardNumber, surname, givenNames, dateOfBirth
Individual TIN Verification	tin	1,500	tin
Business TIN Verification	business-tin	3,000	tin
Business Verification	business	55,000	registrationNumber
KCCA Trading Licence Verification	kcca-license	25,000	applicationReference
Bank Account Verification	bank-account	5,000	bankName (select), accountNumber
AML/PEP Screening	aml	5,000	surname, givenName, gender (select), dateOfBirth
Business AML Check	business-aml	7,500	companyName
CRB Score Check	crb-score	12,000	identityType (select), identifier, reasonCode (select)
CRB Full Report	crb-report	16,000	identityType (select), identifier, reasonCode (select)
Enhanced CRB Report	crb-enhanced	20,000	identityType (select), identifier, reasonCode (select)
Phone Verification	phone	1,200	phone

National ID Verification

Verify a Ugandan national ID using the NIN and card details.

Field	Type	Description
nin	text	National Identification Number
cardNumber	text	ID card number
surname	text	Surname
givenNames	text	Given names
dateOfBirth	date	Date of birth (YYYY-MM-DD)

Example fields

{
  "nin": "CM1234567890AB",
  "cardNumber": "1234567890",
  "surname": "Okello",
  "givenNames": "John Patrick",
  "dateOfBirth": "1990-05-15"
}

Individual TIN Verification

Verify a Tax Identification Number for an individual.

Field	Type	Description
tin	text	Tax Identification Number

Example fields

{
  "tin": "1001234567"
}

Business TIN Verification

Verify a Tax Identification Number for a business.

Field	Type	Description
tin	text	Business Tax Identification Number

Example fields

{
  "tin": "2007654321"
}

Business Verification

Verify a business registration.

Field	Type	Description
registrationNumber	text	Business registration number

Example fields

{
  "registrationNumber": "800123456789"
}

KCCA Trading Licence Verification

Verify a KCCA trading licence by application reference.

Field	Type	Description
applicationReference	text	KCCA application reference

Example fields

{
  "applicationReference": "KCCA-2024-123456"
}

Bank Account Verification

Verify a bank account. bankName must be a selection value returned by GET /catalog.

Field	Type	Description
bankName	select	Bank name (allowed values from catalog)
accountNumber	text	Bank account number

Example fields

{
  "bankName": "BANK_NAME_FROM_CATALOG",
  "accountNumber": "0123456789"
}

AML/PEP Screening

Screen an individual against AML and PEP lists.

Field	Type	Description
surname	text	Surname
givenName	text	Given name
gender	select	MALE or FEMALE
dateOfBirth	date	Date of birth (YYYY-MM-DD)

Example fields

{
  "surname": "Mukasa",
  "givenName": "Sarah",
  "gender": "FEMALE",
  "dateOfBirth": "1985-09-20"
}

Business AML Check

Screen a business against AML lists.

Field	Type	Description
companyName	text	Registered company name

Example fields

{
  "companyName": "Acme Uganda Ltd"
}

CRB products

CRB checks require an identity type, an identifier, and a reason code. These apply to CRB Score Check (crb-score), CRB Full Report (crb-report), and Enhanced CRB Report (crb-enhanced).

identityType values

Value	Meaning
IDT10	National ID (NIN)
IDT05	Passport number
IDT02	TIN
IDT01	Business registration number
IDT17	Work permit number

reasonCode values

Value	Meaning
RP01	New credit application
RP02	Review of existing credit
RP03	Customer report request
RP05	Stakeholder or guarantor report

CRB Score Check

Field	Type	Description
identityType	select	One of the identityType values
identifier	text	The identifier matching the selected type
reasonCode	select	One of the reasonCode values

Example fields

{
  "identityType": "IDT10",
  "identifier": "CM1234567890AB",
  "reasonCode": "RP01"
}

CRB Full Report

Same fields as CRB Score Check.

Example fields

{
  "identityType": "IDT05",
  "identifier": "AB123456",
  "reasonCode": "RP02"
}

Enhanced CRB Report

Same fields as CRB Score Check.

Example fields

{
  "identityType": "IDT01",
  "identifier": "800123456789",
  "reasonCode": "RP05"
}

Phone Verification

Verify a phone number.

Field	Type	Description
phone	tel	Phone number to verify

Example fields

{
  "phone": "[phone]"
}

Next steps

• GET /catalog: fetch the live product list and current prices.
• POST /verifications/consent: request consent wording before submitting a check.
• POST /verifications: submit a verification.