StreamlineAppearance
Create National ID Verification Requests.
Accepts requests for verifying Ugandan National ID details. All requests are queued and processed as soon as possible.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/idv/api/requests?v=2.0 |
| Production | https://api.streamline.laboremus.ug/idv/api/requests?v=2.0 |
Request
Request Type : POST
Authorization
There are two ways to be authorized when making this request.
js
const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.post(API_ENDPOINT,
headers: {
Authorization: `Bearer ${token}`
}
)const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.post(API_ENDPOINT,
headers: {
Authorization: `Bearer ${token}`
}
)js
import axios from 'axios'
import oauth from 'axios-oauth-client'
const getClientCredentials = oauth.clientCredentials(
axios.create(),
'https://oauth.com/2.0/token',
'CLIENT_ID',
'CLIENT_SECRET'
)
const auth = await getClientCredentials('OPTIONAL_SCOPES')
axios.post(API_ENDPOINT,
headers: {
Authorization: `Bearer ${auth.access_token}`
}
)import axios from 'axios'
import oauth from 'axios-oauth-client'
const getClientCredentials = oauth.clientCredentials(
axios.create(),
'https://oauth.com/2.0/token',
'CLIENT_ID',
'CLIENT_SECRET'
)
const auth = await getClientCredentials('OPTIONAL_SCOPES')
axios.post(API_ENDPOINT,
headers: {
Authorization: `Bearer ${auth.access_token}`
}
)INFO
Always add your Subscription key to the request.
js
axios.post(API_ENDPOINT,
headers: {
'Ocp-Apim-Subscription-Key': 'd484a1f0d34f4301916d0f2c9e9106a2'
}
)axios.post(API_ENDPOINT,
headers: {
'Ocp-Apim-Subscription-Key': 'd484a1f0d34f4301916d0f2c9e9106a2'
}
)js
const res = await axios.post(API_ENDPOINT, {
params: {
Ocp-Apim-Subscription-Key: 'd484a1f0d34f4301916d0f2c9e9106a2'
}
});const res = await axios.post(API_ENDPOINT, {
params: {
Ocp-Apim-Subscription-Key: 'd484a1f0d34f4301916d0f2c9e9106a2'
}
});Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | no | The API Version |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| surname | string or null | no* | Surname on the card |
| givenNames | string or null | no* | Given names on the card |
| otherNames | string or null | no | Other names on the card |
| dateOfBirth | string(date) | no* | Date of birth on the card |
| nin | string(14) | yes | National ID Number on the card |
| cardNumber | string(9) | yes | Card number of the card |
INFO
One of the 3 surname, givenNames and dateOfBirth is needed to make this verification
Example Request Body
Content type
application/json
json
{
"surname": "string",
"givenNames": "string",
"otherNames": "string",
"dateOfBirth": "2019-08-24",
"nin": "string",
"cardNumber": "string"
}{
"surname": "string",
"givenNames": "string",
"otherNames": "string",
"dateOfBirth": "2019-08-24",
"nin": "string",
"cardNumber": "string"
}Response
Response Values
| Name | Type | Description |
|---|---|---|
| id | string | Unique Id of the request |
| requestUri | string or null | The Url to find the request |
| status | string (Enum: Pending, Completed, Failed) | The stage of processing at which the request is |
Example Response Body
Content type
application/json
json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestUri": "string",
"status": "Pending"
}{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestUri": "string",
"status": "Pending"
}Error Response
400 The request data is invalid
application/json
| Name | Type | Description |
|---|---|---|
| type | string or null | Type of error response |
| title | string or null | The title of the error response |
| status | integer(int32) | The status of the error response |
| traceId | string or null | The traceId of the error request producing the error |
| errors | object | Object defining the errors |
errors
| Name | Type | Description |
|---|---|---|
| property | Array of strings | The definition of the errors |
401 Not authorized to access the endpoint
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
403 Refuse to authorize access to the endpoint
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
404 Request does not exist
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
500 The server encountered an unexpected error
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |