Create Person Verification Requests.

Accepts requests for performing KYC Verifications on a Person Profile.

Endpoints

Environment	API Endpoint
Sandbox	`https://onprem-test.streamline.laboremus.ug/routing/v1/person-verifications`

Request

Request Type : POST

Authorization

INFO

Always add your Subscription key to the request.

Query Parameters

Name	Type	Required	Description
v	string	no	The version of the API

Content type

multipart/form-data

Request Body

Name	Type	Required	Description
profileId	string	yes	A unique identifier for the profile.
referenceId	string	yes	A reference identifier.
tenantId	string	yes	The tenant identifier.
verification	object	yes	The verifications to be performed.

verification

Name	Type	Required	Description
identityDocuments	array of objects	yes	List of identity documents for verification.
phoneNumbers	array of objects	no	List of phone numbers associated with verification.
tins	array of objects	no	List of Tax Identification Numbers (TINs) for verification.
amlPepScreening	object	no	Anti-Money Laundering (AML) and Politically Exposed Persons (PEP) screening details.
biometrics	object	no	Biometrics information for verification.
riskProfile	object	no	The risk profile of the individual being verified.

identityDocuments

Name	Type	Required	Description
idType	string	yes	The type of identification document (e.g., NationalID).
idNumber	string	no	The identification number.
documentNumber	string	no	The document number.
country	string	no	The country that issued the document.
dateOfBirth	string (datetime)	no	Date of birth.
dateOfExpiry	string (datetime)	no	Document expiration date.
surname	string	yes	The surname of the individual.
givenNames	string	yes	The given names of the individual.
otherNames	string	no	Other names of the individual.
dateOfIssue	string (datetime)	no	Document issue date.
requiresValidation	boolean	yes	Whether the document requires validation.
useFingerprint	boolean	yes	Whether fingerprints are used for verification.
fingerprintPosition	string	no	Position of the captured fingerprint.
fingerprintCaptured	string	no	Captured fingerprint data.
fingerprintFormat	string	no	Format of the fingerprint.
documentFiles	array	no	List of document files associated with the identity.
identificationId	string	yes	A unique identifier for the identification document.

documentFiles

Name	Type	Required	Description
id	string	yes	Unique identifier for the document file.
name	string	yes	Name of the document.
contentType	string	yes	The content type of the document file.
documentType	string	yes	Type of the document (e.g., ID, Passport).

phoneNumbers

Name	Type	Required	Description
value	string	yes	The phone number.
nationalIdNumber	string	no	The national ID number associated with the phone number.
vendorCode	string	no	Vendor code for the phone number (e.g., STRM_01).
country	string	yes	Country of the phone number.

tins

Name	Type	Required	Description
number	string	yes	The TIN (Tax Identification Number).
country	string	yes	Country of the TIN.

amlPepScreening

Name	Type	Required	Description
surname	string	yes	The surname of the individual.
givenName	string	yes	The given name of the individual.
otherName	string	no	Any other name of the individual.
gender	string	yes	The gender of the individual.
dateOfBirth	string (datetime)	yes	Date of birth.

biometrics

Name	Type	Required	Description
customerPhotoMatch	boolean	yes	Indicates if the customer photo matches the records.
photoMatchScore	string	no	Score for the photo match.
numberOfFrames	integer	yes	Number of frames used for the photo match.
livenessDetection	boolean	yes	Whether liveness detection was successful.
livenessScore	string	no	Score for liveness detection.
fingerprintVerification	boolean	yes	Whether fingerprint verification was successful.
customerPhotoMatchSubmittedAt	string (datetime)	yes	Timestamp of photo match submission.
livenessDetectionSubmittedAt	string (datetime)	yes	Timestamp of liveness detection submission.
fingerprintVerificationSubmittedAt	string (datetime)	yes	Timestamp of fingerprint verification submission.

riskProfile

Name	Type	Required	Description
nationality	string	yes	Nationality of the individual.
occupation	string	yes	Occupation of the individual.
district	string	yes	District of the individual's residence.
monthlyIncome	string	yes	Monthly income of the individual.
usePhoneNumber	boolean	no	Indicates if the phone number is used in the risk profile.
useTin	boolean	no	Indicates if the TIN is used in the risk profile.
usePep	boolean	no	Indicates if PEP (Politically Exposed Person) status is used in the risk profile.
useIdentityDocument	boolean	no	Indicates if the identity document is used in the risk profile.

Example Request Body

json

{
  "profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenantId": "string",
  "verification": {
    "identityDocuments": [
      {
        "idType": "NationalID",
        "idNumber": "string",
        "documentNumber": "string",
        "country": "string",
        "dateOfBirth": "2024-10-01T07:56:15.124Z",
        "dateOfExpiry": "2024-10-01T07:56:15.124Z",
        "surname": "string",
        "givenNames": "string",
        "otherNames": "string",
        "dateOfIssue": "2024-10-01T07:56:15.124Z",
        "requiresValidation": true,
        "useFingerprint": true,
        "fingerprintPosition": "string",
        "fingerprintCaptured": "string",
        "fingerprintFormat": "string",
        "documentFiles": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "contentType": "string",
            "documentType": "string"
          }
        ],
        "identificationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "phoneNumbers": [
      {
        "value": "string",
        "nationalIdNumber": "string",
        "vendorCode": "STRM_01",
        "country": "string"
      }
    ],
    "tins": [
      {
        "number": "string",
        "country": "string"
      }
    ],
    "amlPepScreening": {
      "surname": "string",
      "givenName": "string",
      "otherName": "string",
      "gender": "string",
      "dateOfBirth": "2024-10-01T07:56:15.124Z"
    },
    "biometrics": {
      "customerPhotoMatch": true,
      "photoMatchScore": "string",
      "numberOfFrames": 0,
      "livenessDetection": true,
      "livenessScore": "string",
      "fingerprintVerification": true,
      "customerPhotoMatchSubmittedAt": "2024-10-01T07:56:15.124Z",
      "livenessDetectionSubmittedAt": "2024-10-01T07:56:15.124Z",
      "fingerprintVerificationSubmittedAt": "2024-10-01T07:56:15.124Z"
    },
    "riskProfile": {
      "nationality": "string",
      "occupation": "string",
      "district": "string",
      "monthlyIncome": "string",
      "usePhoneNumber": true,
      "useTin": true,
      "usePep": true,
      "useIdentityDocument": true
    }
  }
}

{
  "profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenantId": "string",
  "verification": {
    "identityDocuments": [
      {
        "idType": "NationalID",
        "idNumber": "string",
        "documentNumber": "string",
        "country": "string",
        "dateOfBirth": "2024-10-01T07:56:15.124Z",
        "dateOfExpiry": "2024-10-01T07:56:15.124Z",
        "surname": "string",
        "givenNames": "string",
        "otherNames": "string",
        "dateOfIssue": "2024-10-01T07:56:15.124Z",
        "requiresValidation": true,
        "useFingerprint": true,
        "fingerprintPosition": "string",
        "fingerprintCaptured": "string",
        "fingerprintFormat": "string",
        "documentFiles": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "contentType": "string",
            "documentType": "string"
          }
        ],
        "identificationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "phoneNumbers": [
      {
        "value": "string",
        "nationalIdNumber": "string",
        "vendorCode": "STRM_01",
        "country": "string"
      }
    ],
    "tins": [
      {
        "number": "string",
        "country": "string"
      }
    ],
    "amlPepScreening": {
      "surname": "string",
      "givenName": "string",
      "otherName": "string",
      "gender": "string",
      "dateOfBirth": "2024-10-01T07:56:15.124Z"
    },
    "biometrics": {
      "customerPhotoMatch": true,
      "photoMatchScore": "string",
      "numberOfFrames": 0,
      "livenessDetection": true,
      "livenessScore": "string",
      "fingerprintVerification": true,
      "customerPhotoMatchSubmittedAt": "2024-10-01T07:56:15.124Z",
      "livenessDetectionSubmittedAt": "2024-10-01T07:56:15.124Z",
      "fingerprintVerificationSubmittedAt": "2024-10-01T07:56:15.124Z"
    },
    "riskProfile": {
      "nationality": "string",
      "occupation": "string",
      "district": "string",
      "monthlyIncome": "string",
      "usePhoneNumber": true,
      "useTin": true,
      "usePep": true,
      "useIdentityDocument": true
    }
  }
}

Response

Content type

application/json

Response Body

Name	Type	Description
profileId	string	A unique identifier for the profile.
referenceId	string	A reference identifier.
message	string	A message associated with the request.

Example Response Body

json

{
  "profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string"
}

{
  "profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string"
}

Error Response

400 Bad Request

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 Unauthorized

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 Forbidden

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 Not Found

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 Server 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

Create Person Verification Requests. ​

Endpoints ​

Request ​

Request Type : POST ​

Authorization ​

Query Parameters ​

Request Body ​

verification ​

identityDocuments ​

documentFiles ​

phoneNumbers ​

tins ​

amlPepScreening ​

biometrics ​

riskProfile ​

Example Request Body ​

Response ​

Response Body ​

Example Response Body ​

Error Response ​

errors ​

Error ​

Error ​

Error ​

Error ​

Create Person Verification Requests.

Endpoints

Request

Request Type : POST

Authorization

Query Parameters

Request Body

verification

identityDocuments

documentFiles

phoneNumbers

tins

amlPepScreening

biometrics

riskProfile

Example Request Body

Response

Response Body

Example Response Body

Error Response

errors

Error

Error

Error

Error