Streamline

Appearance

On this page

Get National ID Verification Requests Details. ​

Endpoint for getting details of a specific ID Verification request by unique id.

Endpoints ​

EnvironmentURL
Sandboxhttps://api-test.streamline.laboremus.ug/idv/api/requests/{id}?v=2.0
Productionhttps://api.streamline.laboremus.ug/idv/api/requests/{id}?v=2.0

Request ​

Request Type : GET ​

Authorization ​

There are two ways to be authorized when making this request.

js
const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.get(API_ENDPOINT, 
  headers: {
    Authorization: `Bearer ${token}`
  }
)
const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.get(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')
    // => { "access_token": "...", "expires_in": 900, ... }

    axios.get(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')
    // => { "access_token": "...", "expires_in": 900, ... }

    axios.get(API_ENDPOINT, 
      headers: {
        Authorization: `Bearer ${auth.access_token}`
      }
    )

INFO

Always add your Subscription key to the request.

js
axios.get(API_ENDPOINT, 
  headers: {
    'Ocp-Apim-Subscription-Key': 'd484a1f0d34f43019'
  }
)
axios.get(API_ENDPOINT, 
  headers: {
    'Ocp-Apim-Subscription-Key': 'd484a1f0d34f43019'
  }
)
js
const res = await axios.get(API_ENDPOINT, { 
  params: { 
    Ocp-Apim-Subscription-Key: 'd484a1f0d34f43019' 
  } 
});
const res = await axios.get(API_ENDPOINT, { 
  params: { 
    Ocp-Apim-Subscription-Key: 'd484a1f0d34f43019' 
  } 
});

Path Parameters ​

NameTypeRequiredDescription
idstring(uuid)yesThe Unique ID of the id verification request

Query Parameters ​

NameTypeRequiredDescription
api-versionstringyesThe API Version
vstringnoThe API Version

Header Parameters ​

NameTypeRequiredDescription
x-versionstringnoThe API Version
Bearerstring(JwtToken)noThe Token required for authorization

Response ​

Response Values ​

NameTypeDescription
idstring (uuid)The unique id for the request
initiatorstring or nullThe names for the request initiator
initiatorIdstring or nullThe unique id for the request initiator
initiatorEmailstring or nullThe API consumer for user that initiated the request
participantIdstring (uuid)The unique id for the participant that initiated the request
receivedAtstring or null (date-time)Date the request was created
submittedAtstring or null (date-time)Date the request was submitted to NIRA
receivedFromNirastring or null (date-time)Date the response was received from NIRA
requestStatusstring (Enum: Pending, Completed, Failed)The stage of processing at which the request is
surnamestring or nullSurname on the card that was verified
givenNamesstring or nullGiven names on the card that was verified
otherNamesstring or nullOther names on the card that was verified
cardNumberstring or nullID card number on the card that was verified
maskedCardNumberstring or nullMasked ID Card number on the card that was verified
ninstring or nullNational Identification Number on the card that was verified
maskedNinstring or nullMasked National Identification Number on the card that was verified
multipleReferenceIdstring or null (uuid)ID to show multiple requests
dateOfBirthstring(date)Date of birth on the card that was verified
resultJsonobjectThe response from NIRA based on the card details provided

resultJson ​

NameTypeDescription
matchingStatusbooleanWhether the card details matched those at NIRA
cardStatusstring or nullWhether the card is valid or not.
statusstring or nullThe NIN request status as returned from NIRA
errorobjectError from NIRA. When isError is false, its null
isErrorbooleanWhen true, it means that NIRA found an error with the request. See for more information.
ninStatusstring or nullThe Nin status field for the request

error ​

NameTypeDescription
codestring or nullThe code of the error returned
messagestring or nullThe message of the error returned

Example Response Body ​

Content type

application/json

json
{
	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
	"initiator": "string",
	"initiatorId": "b631b8d8-c217-4b56-82fc-36ea91cf342a",
	"initiatorEmail": "string",
	"participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
	"receivedAt": "2019-08-24T14:15:22Z",
	"submittedAt": "2019-08-24T14:15:22Z",
	"receivedFromNira": "2019-08-24T14:15:22Z",
	"requestStatus": "Pending",
	"surname": "string",
	"givenNames": "string",
	"otherNames": "string",
	"cardNumber": "string",
	"maskedCardNumber": "string",
	"nin": "string",
	"maskedNin": "string",
	"multipleReferenceId": "d2df34d1-f938-4240-9d1b-a11677d881e0",
	"dateOfBirth": "2019-08-24",
	"resultJson": {
		"matchingStatus": true,
		"cardStatus": "string",
		"status": "string",
		"error": {
			"code": "string",
			"message": "string"
		},
		"isError": true,
		"ninStatus": "string"
	}
}
{
	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
	"initiator": "string",
	"initiatorId": "b631b8d8-c217-4b56-82fc-36ea91cf342a",
	"initiatorEmail": "string",
	"participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
	"receivedAt": "2019-08-24T14:15:22Z",
	"submittedAt": "2019-08-24T14:15:22Z",
	"receivedFromNira": "2019-08-24T14:15:22Z",
	"requestStatus": "Pending",
	"surname": "string",
	"givenNames": "string",
	"otherNames": "string",
	"cardNumber": "string",
	"maskedCardNumber": "string",
	"nin": "string",
	"maskedNin": "string",
	"multipleReferenceId": "d2df34d1-f938-4240-9d1b-a11677d881e0",
	"dateOfBirth": "2019-08-24",
	"resultJson": {
		"matchingStatus": true,
		"cardStatus": "string",
		"status": "string",
		"error": {
			"code": "string",
			"message": "string"
		},
		"isError": true,
		"ninStatus": "string"
	}
}

Error Response ​

400 The request data is invalid

application/json

NameTypeDescription
typestring or nullType of error response
titlestring or nullThe title of the error response
statusinteger(int32)The status of the error response
traceIdstring or nullThe traceId of the error request producing the error
errorsobjectObject defining the errors

errors ​

NameTypeDescription
propertyArray of stringsThe definition of the errors

401 Not authorized to access the endpoint

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error ​

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

403 Refuse to authorize access to the endpoint

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error ​

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

404 Request does not exist

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error ​

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

500 The server encountered an unexpected error

application/json

NameTypeDescription
errorobject(Error)Type of error response

Error ​

NameTypeDescription
codestring or nullThe Error code
messagestring or nullThe Error message

Tech served right

© 2023-present Laboremus Uganda Ltd