Get ID Validation Requests Details.

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

Endpoints

Environment	URL
Sandbox	`https://api-test.streamline.laboremus.ug/idv/api/validations/details/{id}?v=2.0`
Production	`https://api.streamline.laboremus.ug/idv/api/validations/details/{id}?v=2.0`

Request

Request Type : GET

Authorization

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

BearerClient credentials

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}`
  }
)

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.

As a headerAs a query parameter

axios.get(API_ENDPOINT, 
  headers: {
    'Ocp-Apim-Subscription-Key': 'd484a1f0d34f43019'
  }
)

axios.get(API_ENDPOINT, 
  headers: {
    'Ocp-Apim-Subscription-Key': 'd484a1f0d34f43019'
  }
)

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

Name	Type	Required	Description
id	string(uuid)	yes	The Unique ID of the id validation request

Query Parameters

Name	Type	Required	Description
api-version	string	yes	The API Version
v	string	no	The API Version

Header Parameters

Name	Type	Required	Description
x-version	string	no	The API Version
Bearer	string(JwtToken)	no	The Token required for authorization

Response

Response Values

Name	Type	Description
id	string (uuid)	The unique id for the request
initiator	string or null	The names for the request initiator
externalReference	string or null	The external reference id for the request
receivedAt	string or null (date-time)	Date the request was created
submittedAt	string or null (date-time)	Date the request was submitted
requestStatus	string (Enum: `Pending`, `Completed`, `Failed`)	The stage of processing at which the request is
idNumber	string or null	ID card number on the card that was validated
idValue	string or null	Identification Number on the card that was validated
expiryDate	string or null	Expiry Date of the document that was validated
issueDate	string or null	Issue Date of the document that was validated
dateOfBirth	string(date)	Date of birth on the card that was validated
surname	string or null	Surname on the card that was validated
givenNames	string or null	Given names on the card that was validated
nationality	string or null	Nationality on the document that was validated
gender	string	Gender on the document that was validated
idTypeSubmitted	string or null	ID Type that was submitted when creating validation request
idTypeFound	string or null	ID Type that was found on the card that was validated
additionalInformation	string	Contains detailed data that is specific to the validated document
validationStatus	string or null	The validation status of the validated document

Example Response Body

Content type

application/json

json

{
	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
	"initiator": "string",
	"externalReference": "string",
	"receivedAt": "2019-08-24T14:15:22Z",
	"submittedAt": "2019-08-24T14:15:22Z",
	"requestStatus": "Pending",
	"idNumber": "string",
	"idValue": "string",
	"expiryDate": "string",
	"issueDate": "string",
	"dateOfBirth": "string",
	"surname": "string",
	"givenNames": "string",
	"nationality": "string",
	"gender": "string",
	"idTypeSubmitted": "string",
	"idTypeFound": "string",
	"additionalInformation": "string",
  "validationStatus": "declined",
}

{
	"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
	"initiator": "string",
	"externalReference": "string",
	"receivedAt": "2019-08-24T14:15:22Z",
	"submittedAt": "2019-08-24T14:15:22Z",
	"requestStatus": "Pending",
	"idNumber": "string",
	"idValue": "string",
	"expiryDate": "string",
	"issueDate": "string",
	"dateOfBirth": "string",
	"surname": "string",
	"givenNames": "string",
	"nationality": "string",
	"gender": "string",
	"idTypeSubmitted": "string",
	"idTypeFound": "string",
	"additionalInformation": "string",
  "validationStatus": "declined",
}

INFO

additionalInformation field contains detailed data related to each validation document type Nationalid, Passport ,DrivingLicence ,RefugeeId

National ID

Name	Type	Description
placeOfBirth	string or null	The place of birth as shown on national id
parish	string or null	The parish as shown on national id
district	string or null	The district as shown on national id
village	string or null	The village as shown on national id
county	string or null	The county as shown on national id
concerns	array of strings or null	This shows areas of concern after validating the national id

Passport

Name	Type	Description
placeOfBirth	string or null	The place of birth as shown on the passport
documentClassCode	string or null	The document class code as shown on the passport
country	string or null	The country as shown on the passport
issuingStateName	string or null	The issuing state name as shown on the passport
concerns	array of strings or null	This shows areas of concern after validating the passport

Driving Licence

Name	Type	Description
country	string or null	The country as shown on the driving licence
issuingStateName	string or null	The state name as shown on the driving licence
dlClass	string or null	The class as shown on the driving licence
dlRestrictionCode	string or null	The restriction code as shown on the driving licence
placeOfIssue	string or null	The place of issue as shown on the driving licence
numberOfDuplicates	string or null	The number of duplicates as shown on the driving licence
bookletNumber	string or null	The booklet as shown on the driving licence
firstIssueDate	string or null	The first issue date as shown on the driving licence
issueCountry	string or null	The country issuing the document as shown on the driving licence
documentType	string or null	The document type that was discovered
concerns	array of strings or null	This shows areas of concern after validating the driving licence

Refugee ID

Name	Type	Description
country	string or null	The country of the refugee
issuingStateName	string or null	The state issuing the refugee identification card
issueCountry	string or null	The country issuing the refugee identification card
concerns	array of strings or null	This shows areas of concern after validating the refugee identification card

National IDPassportDriving LicenceRefugee ID

json

{
  "placeOfBirth": "string",
  "parish": "string",
  "district": "string",
  "village": "string",
  "subCounty": "string",
  "county": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string"
    }
  ]
}

{
  "placeOfBirth": "string",
  "parish": "string",
  "district": "string",
  "village": "string",
  "subCounty": "string",
  "county": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string"
    }
  ]
}

json

{
  "placeOfBirth": "string",
  "documentClassCode": "string",
  "country": "string",
  "authority": "string",
  "issuingStateName": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string"
    }
  ]
}

{
  "placeOfBirth": "string",
  "documentClassCode": "string",
  "country": "string",
  "authority": "string",
  "issuingStateName": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string"
    }
  ]
}

json

{
  "country": "string",
  "issuingStateName": "string",
  "dlClass": "string",
  "dlRestrictionCode": "string",
  "placeOfIssue": "string",
  "numberOfDuplicates": "string",
  "bookletNumber": "string",
  "firstIssueDate": "string",
  "issueCountry": "string",
  "documentType": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string",
    }
	]  
}

{
  "country": "string",
  "issuingStateName": "string",
  "dlClass": "string",
  "dlRestrictionCode": "string",
  "placeOfIssue": "string",
  "numberOfDuplicates": "string",
  "bookletNumber": "string",
  "firstIssueDate": "string",
  "issueCountry": "string",
  "documentType": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string",
    }
	]  
}

json

{
  "country": "string",
  "issuingStateName": "string",
  "issueCountry": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string"
    }
  ]
}

{
  "country": "string",
  "issuingStateName": "string",
  "issueCountry": "string",
  "concerns": [
    {
      "message": "string",
      "service": "string",
      "status": "string"
    }
  ]
}

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

V1

V2

V1

V2

V1

V2

V1

V2

Photo match

V1

V2

V3

V1

V2

V1

V2

V3

V1

V2

Person

Company

Get ID Validation Requests Details. ​

Endpoints ​

Request ​

Request Type : GET ​

Authorization ​

Path Parameters ​

Query Parameters ​

Header Parameters ​

Response ​

Response Values ​

Example Response Body ​

National ID ​

Passport ​

Driving Licence ​

Refugee ID ​

Error Response ​

errors ​

Error ​

Error ​

Error ​

Error ​

Get ID Validation Requests Details.

Endpoints

Request

Request Type : GET

Authorization

Path Parameters

Query Parameters

Header Parameters

Response

Response Values

Example Response Body

National ID

Passport

Driving Licence

Refugee ID

Error Response

errors

Error

Error

Error

Error