Appearance
Make MTN Customer Data Match Request.
Submits customer details in real time to perform an immediate data matching lookup against MTN system records.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/mtn-verify/api/v1/kyc-verify?v=1.0 |
Sandbox testing
See the Sandbox Context page for scoring behaviour and field rules.
Request
Request Type : POST
Authorization
All requests must be authenticated using OAuth 2.0 Client Credentials. Follow the steps in the Authentication section to obtain an access token.
Request Body
INFO
All fields except phone number are optional.
| Name | Type | Required | Description |
|---|---|---|---|
| phoneNumber | string | yes | Phone number starting with prefix (256) |
| country | string | no | Country name |
| nationalIdNumber | string | no | National ID number |
| surName | string | no | Surname |
| givenName | string | no | Given name |
| emailAddress | string | no | Email address |
| streetAddress | string | no | Street address |
| city | string | no | City |
| postCode | string | no | Post code |
Example Request Body
Content type
application/json
json
{
"phoneNumber": "256781289630",
"country": "Uganda",
"nationalIdNumber": "CF942YG108HGRE",
"surName": "JORINE",
"givenName": "SYLVIA",
"emailAddress": "jorine.sylvia@example.com",
"streetAddress": "123 Kampala Road",
"city": "Kampala",
"postCode": "256"
}{
"phoneNumber": "256781289630",
"country": "Uganda",
"nationalIdNumber": "CF942YG108HGRE",
"surName": "JORINE",
"givenName": "SYLVIA",
"emailAddress": "jorine.sylvia@example.com",
"streetAddress": "123 Kampala Road",
"city": "Kampala",
"postCode": "256"
}Response
Response Values
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | The unique id for the request |
| createdAt | string (date-time) | Date the request was created. |
| status | string (Enum: Pending, Completed, Error) | The status of the execution |
| sentAt | string (date-time) | Date the request was sent. |
| processedAt | string (date-time) | Date at which the verification request was processed. |
| statusMessage | string | Status message from the verification service |
| supportMessage | string | Support message from the verification service |
| initiator | string | The unique Id for the request initiator |
| lastUpdated | string (date-time) | Date the request was last updated |
| data | object | The verification results for each scorable identity field |
data
| Name | Type | Description |
|---|---|---|
| surName | string | Surname |
| surNameVerificationScore | integer | Surname verification score |
| givenName | string | Given name |
| givenNameVerificationScore | integer | Given name verification score |
| phoneNumber | string | Phone number |
| phoneNumberVerificationScore | integer | Phone number verification score |
| emailAddress | string | Email address |
| emailAddressVerificationScore | integer | Email address verification score |
| nationalIdNumber | string | National ID number |
| nationalIdNumberVerificationScore | integer | National ID number verification score |
| streetAddress | string | Street address |
| streetAddressVerificationScore | integer | Street address verification score |
| city | string | City |
| cityVerificationScore | integer | City verification score |
| postCode | string | Post code |
| postCodeVerificationScore | integer | Post code verification score |
| country | string | Country |
| countryVerificationScore | integer | Country verification score |
Example Response Body
Content type
application/json
json
{
"statusMessage": "Success.",
"supportMessage": null,
"data": {
"surName": "JORINE",
"surNameVerificationScore": 100,
"givenName": "SYLVIA",
"givenNameVerificationScore": 100,
"phoneNumber": "256781289630",
"phoneNumberVerificationScore": 100,
"emailAddress": "",
"emailAddressVerificationScore": -1,
"nationalIdNumber": "CF94068108HGXG",
"nationalIdNumberVerificationScore": 100,
"streetAddress": "",
"streetAddressVerificationScore": -1,
"city": "",
"cityVerificationScore": -1,
"postCode": "",
"postCodeVerificationScore": -1,
"country": "Uganda",
"countryVerificationScore": 100
},
"status": "Successful",
"sentAt": "2026-08-27T13:05:58.4307552Z",
"processedAt": "2026-08-27T13:05:50.6377905Z",
"initiator": "fbaf86d684e643dba131c05bede98b2f",
"id": "01a04353-c2c7-7564-beaa-697f5b5fb020",
"createdAt": "2026-08-27T16:05:50.6364498Z",
"lastUpdated": "2026-08-27T16:06:04.8418887Z"
}{
"statusMessage": "Success.",
"supportMessage": null,
"data": {
"surName": "JORINE",
"surNameVerificationScore": 100,
"givenName": "SYLVIA",
"givenNameVerificationScore": 100,
"phoneNumber": "256781289630",
"phoneNumberVerificationScore": 100,
"emailAddress": "",
"emailAddressVerificationScore": -1,
"nationalIdNumber": "CF94068108HGXG",
"nationalIdNumberVerificationScore": 100,
"streetAddress": "",
"streetAddressVerificationScore": -1,
"city": "",
"cityVerificationScore": -1,
"postCode": "",
"postCodeVerificationScore": -1,
"country": "Uganda",
"countryVerificationScore": 100
},
"status": "Successful",
"sentAt": "2026-08-27T13:05:58.4307552Z",
"processedAt": "2026-08-27T13:05:50.6377905Z",
"initiator": "fbaf86d684e643dba131c05bede98b2f",
"id": "01a04353-c2c7-7564-beaa-697f5b5fb020",
"createdAt": "2026-08-27T16:05:50.6364498Z",
"lastUpdated": "2026-08-27T16:06:04.8418887Z"
}