StreamlineAppearance
Get Application
Endpoint for retrieving a customer onboarding application by Id.
Endpoints
| Environment | API Endpoint |
|---|---|
| Sandbox | https://onprem-test.streamline.laboremus.ug/api/onboarding/v1/applications/{applicationId} |
Request
Request Type : GET
Authorization
INFO
Always add your Subscription key to the request.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
Path Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| id | string(uuid) | yes | The Unique ID of an application |
Response
Content type
application/json
Response Body
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | A unique identifier for the record. |
| createdAt | string (ISO 8601 date-time) | The timestamp when the record was created in ISO 8601 format. |
| applicationId | string (uuid) | A unique identifier for the application associated with this record. |
| tenantId | string (uuid) | A unique identifier for the tenant associated with this record. |
| aggregatorId | string (uuid) | A unique identifier for the aggregator associated with this record. |
| profileId | string (uuid) | A unique identifier for the profile associated with this record. |
| externalReference | string | An external reference identifier for the record. |
| referenceNumber | string | A unique reference number for tracking purposes. |
| applicationDate | string (ISO 8601 date-time) | The date when the application was created in ISO 8601 format. |
| applicationSubmittedAt | string (ISO 8601 date-time) | The date when the application was submitted in ISO 8601 format. |
| status | string | The current status of the application (e.g., Received). |
| approvalRequestDate | string (ISO 8601 date-time) | The date when the approval request was made in ISO 8601 format. |
| approvalDate | string (ISO 8601 date-time) | The date when the application was approved in ISO 8601 format. |
| declineDate | string (ISO 8601 date-time) | The date when the application was declined in ISO 8601 format. |
| channel | string | The channel through which the application was submitted. |
| checkStatus | string | The current status of the verification check (e.g., Pending). |
| applicationData | object | An object containing detailed information about the application data. |
| documents | array of objects | An array of documents associated with the application, each containing document details. |
| comments | array of objects | An array of comments related to the application, each containing comment details. |
Application Data
| Name | Type | Description |
|---|---|---|
| dateCreated | string (datetime) | The date when the application data was created. |
| createdAt | string (datetime) | The creation timestamp of the record. |
| dateUpdated | string (datetime) | The date when the application data was last updated. |
| dateDeleted | string (datetime) | The date when the application data was deleted. |
| createdBy | string | The user or system that created the application data. |
| updatedBy | string | The user or system that last updated the application data. |
| deletedBy | string | The user or system that deleted the application data. |
| isDeleted | boolean | Indicates whether the application data is marked as deleted. |
| lastUpdated | string (datetime) | The timestamp of the last update to the record. |
| id | string (uuid) | A unique identifier for the application data. |
| channel | string | The channel through which the application was submitted. |
| accountName | string | The name of the account associated with the application. |
| surname | string | The surname of the applicant. |
| otherName | string | The other name(s) of the applicant. |
| givenName | string | The given name (first name) of the applicant. |
| fullName | string | The full name of the applicant. |
| gender | string | The gender of the applicant. |
| dateOfBirth | string | The date of birth of the applicant. |
| maritalStatus | string | The marital status of the applicant. |
| district | string | The district of residence of the applicant. |
| village | string | The village of residence of the applicant. |
| parish | string | The parish of residence of the applicant. |
| occupation | string | The occupation of the applicant. |
| monthlyIncome | string | The monthly income of the applicant. |
| currency | string | The currency in which the income is measured. |
| accountType | string | The type of account associated with the application. |
| alternativeMobileMoneyNumber | string | The alternative mobile money number of the applicant. |
| tin | string | The Tax Identification Number (TIN) of the applicant. |
| phoneNumber | string | The primary phone number of the applicant. |
| alternativePhoneNumber | string | The alternative phone number of the applicant. |
| alternativeAccountType | string | The type of alternative account. |
| alternativeBankAccountNumber | string | The alternative bank account number. |
| alternativeBankName | string | The name of the alternative bank. |
| cardNumber | string | The card number associated with the application. |
| nin | string | The National Identification Number (NIN) of the applicant. |
| expiryDate | string (datetime) | The expiry date of the document provided by the applicant. |
| issueDate | string (datetime) | The issue date of the document provided by the applicant. |
| submittedBy | object | An object containing submittedBy data |
| livenessStatus | boolean | Indicates whether the liveness check was successful. |
| customerPhotoMatchStatus | boolean | Indicates whether the customer's photo matched the records. |
| photoMatchScore | string | The score of the photo match, if applicable. |
| numberOfFrames | integer | The number of frames used for photo matching. |
| isPep | boolean | Indicates whether the applicant is a Politically Exposed Person (PEP). |
| pepType | string | The type of PEP, if applicable. |
| nextOfKinName | string | The name of the applicant's next of kin. |
| nextOfKinPhoneNumber | string | The phone number of the applicant's next of kin. |
| nationality | string | The nationality of the applicant. |
| memberOrAssociateDetails | array of objects | An array of memberOrAssociateDetails objects |
Submitted By
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | A unique identifier for the entity or record. |
| tenantId | string | A unique identifier for the tenant. |
| aggregatorId | string | A unique identifier for the aggregator associated with the record. |
| aggregatorName | string | The name of the aggregator. |
| agentCode | string | A unique code identifying the agent involved. |
Member Or Associate Details
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | A unique identifier for the member or associate. |
| applicationDataId | string (uuid) | A unique identifier for the associated application data. |
| surname | string | The surname (last name) of the member or associate. |
| givenName | string | The given name (first name) of the member or associate. |
| relationship | string | The relationship between the member/associate and the applicant. |
Documents
| Name | Type | Description |
|---|---|---|
| dateCreated | string (ISO 8601 date-time) | The date and time when the document was created. |
| createdAt | string (ISO 8601 date-time) | The timestamp of when the document was officially recorded in the system. |
| dateUpdated | string (ISO 8601 date-time) | The timestamp of when the document was last updated. |
| dateDeleted | string (ISO 8601 date-time) | The timestamp of when the document was deleted. |
| createdBy | string | The user or process that created the document. |
| updatedBy | string | The user or process that last updated the document. |
| deletedBy | string | The user or process that deleted the document. |
| isDeleted | boolean | Indicates whether the document has been deleted. |
| lastUpdated | string (ISO 8601 date-time) | The timestamp of when the document was most recently updated, regardless of other timestamps. |
| id | string (uuid) | A unique identifier for the document. |
| name | string | The name of the document. |
| documentType | string | The type of document (e.g., PDF, JPEG, etc.). |
| contentType | string | The MIME type of the document (e.g., application/pdf, image/jpeg). |
| description | string | A brief description of the document's contents. |
| size | string | The size of the document (e.g., in bytes or MB). |
| reference | string | A reference identifier for the document. |
Comments
| Name | Type | Description |
|---|---|---|
| applicationId | string (uuid) | A unique identifier for the application. |
| action | string | The action taken (e.g., "Approve", "Reject", etc.). |
| comment | string | Any additional comments or notes related to the action. |
| tenantId | string (uuid) | A unique identifier for the tenant. |
| initiatorId | string (uuid) | A unique identifier for the person who initiated the action. |
| initiatorName | string | The name of the person who initiated the action. |
| createdAt | string (ISO 8601 date-time) | The timestamp when the action or comment was created. |
Example Response Body
json
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2024-09-30T13:39:27.057Z",
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"aggregatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalReference": "string",
"referenceNumber": "string",
"applicationDate": "2024-09-30T13:39:27.057Z",
"applicationSubmittedAt": "2024-09-30T13:39:27.057Z",
"status": "Received",
"approvalRequestDate": "2024-09-30T13:39:27.057Z",
"approvalDate": "2024-09-30T13:39:27.057Z",
"declineDate": "2024-09-30T13:39:27.057Z",
"channel": "string",
"checkStatus": "Pending",
"applicationData": {
"dateCreated": "2024-09-30T13:39:27.057Z",
"createdAt": "2024-09-30T13:39:27.057Z",
"dateUpdated": "2024-09-30T13:39:27.057Z",
"dateDeleted": "2024-09-30T13:39:27.057Z",
"createdBy": "string",
"updatedBy": "string",
"deletedBy": "string",
"isDeleted": true,
"lastUpdated": "2024-09-30T13:39:27.057Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"channel": "string",
"accountName": "string",
"surname": "string",
"otherName": "string",
"givenName": "string",
"fullName": "string",
"gender": "string",
"dateOfBirth": "string",
"maritalStatus": "string",
"district": "string",
"village": "string",
"parish": "string",
"occupation": "string",
"monthlyIncome": "string",
"currency": "string",
"accountType": "string",
"alternativeMobileMoneyNumber": "string",
"tin": "string",
"phoneNumber": "string",
"alternativePhoneNumber": "string",
"alternativeAccountType": "string",
"alternativeBankAccountNumber": "string",
"alternativeBankName": "string",
"cardNumber": "string",
"nin": "string",
"expiryDate": "string",
"issueDate": "string",
"submittedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "string",
"aggregatorId": "string",
"aggregatorName": "string",
"agentCode": "string"
},
"livenessStatus": true,
"customerPhotoMatchStatus": true,
"photoMatchScore": "string",
"numberOfFrames": 0,
"isPep": true,
"pepType": "string",
"nextOfKinName": "string",
"nextOfKinPhoneNumber": "string",
"nationality": "string",
"memberOrAssociateDetails": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"surname": "string",
"givenName": "string",
"relationship": "string"
}
]
},
"documents": [
{
"dateCreated": "2024-09-30T13:39:27.057Z",
"createdAt": "2024-09-30T13:39:27.057Z",
"dateUpdated": "2024-09-30T13:39:27.057Z",
"dateDeleted": "2024-09-30T13:39:27.057Z",
"createdBy": "string",
"updatedBy": "string",
"deletedBy": "string",
"isDeleted": true,
"lastUpdated": "2024-09-30T13:39:27.057Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"documentType": "string",
"contentType": "string",
"description": "string",
"size": "string",
"reference": "string"
}
],
"comments": [
{
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"action": "string",
"comment": "string",
"tenantId": "string",
"initiatorId": "string",
"initiatorName": "string",
"createdAt": "2024-09-30T13:39:27.057Z"
}
]
}{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2024-09-30T13:39:27.057Z",
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"aggregatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"externalReference": "string",
"referenceNumber": "string",
"applicationDate": "2024-09-30T13:39:27.057Z",
"applicationSubmittedAt": "2024-09-30T13:39:27.057Z",
"status": "Received",
"approvalRequestDate": "2024-09-30T13:39:27.057Z",
"approvalDate": "2024-09-30T13:39:27.057Z",
"declineDate": "2024-09-30T13:39:27.057Z",
"channel": "string",
"checkStatus": "Pending",
"applicationData": {
"dateCreated": "2024-09-30T13:39:27.057Z",
"createdAt": "2024-09-30T13:39:27.057Z",
"dateUpdated": "2024-09-30T13:39:27.057Z",
"dateDeleted": "2024-09-30T13:39:27.057Z",
"createdBy": "string",
"updatedBy": "string",
"deletedBy": "string",
"isDeleted": true,
"lastUpdated": "2024-09-30T13:39:27.057Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"channel": "string",
"accountName": "string",
"surname": "string",
"otherName": "string",
"givenName": "string",
"fullName": "string",
"gender": "string",
"dateOfBirth": "string",
"maritalStatus": "string",
"district": "string",
"village": "string",
"parish": "string",
"occupation": "string",
"monthlyIncome": "string",
"currency": "string",
"accountType": "string",
"alternativeMobileMoneyNumber": "string",
"tin": "string",
"phoneNumber": "string",
"alternativePhoneNumber": "string",
"alternativeAccountType": "string",
"alternativeBankAccountNumber": "string",
"alternativeBankName": "string",
"cardNumber": "string",
"nin": "string",
"expiryDate": "string",
"issueDate": "string",
"submittedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "string",
"aggregatorId": "string",
"aggregatorName": "string",
"agentCode": "string"
},
"livenessStatus": true,
"customerPhotoMatchStatus": true,
"photoMatchScore": "string",
"numberOfFrames": 0,
"isPep": true,
"pepType": "string",
"nextOfKinName": "string",
"nextOfKinPhoneNumber": "string",
"nationality": "string",
"memberOrAssociateDetails": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"surname": "string",
"givenName": "string",
"relationship": "string"
}
]
},
"documents": [
{
"dateCreated": "2024-09-30T13:39:27.057Z",
"createdAt": "2024-09-30T13:39:27.057Z",
"dateUpdated": "2024-09-30T13:39:27.057Z",
"dateDeleted": "2024-09-30T13:39:27.057Z",
"createdBy": "string",
"updatedBy": "string",
"deletedBy": "string",
"isDeleted": true,
"lastUpdated": "2024-09-30T13:39:27.057Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"documentType": "string",
"contentType": "string",
"description": "string",
"size": "string",
"reference": "string"
}
],
"comments": [
{
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"action": "string",
"comment": "string",
"tenantId": "string",
"initiatorId": "string",
"initiatorName": "string",
"createdAt": "2024-09-30T13:39:27.057Z"
}
]
}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 |