StreamlineAppearance
Generate PDF
Accepts requests for generating PDF Report.
Endpoints
| Environment | API Endpoint |
|---|---|
| Sandbox | https://onprem-test.streamline.laboremus.ug/doc-generator/api/pdfs |
Request
Request Type : POST
Authorization
INFO
Always add your Subscription key to the request.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
Content type
application/json
Request Body
| Name | Type | Description |
|---|---|---|
| type | string | The type of PDF document |
| data | dynamic object or null | The data to be displayed in pdf document |
| fileName | string | The name the file shall have after download |
| version | string | The version of the file requested |
Example Request Body
json
{
"type": "KycPerson",
"data": {
"generatedBy": "*********",
"profileCreationDate": "2024-07-09T11:03:32.830437",
"profileLastUpdated": "2024-07-24T14:51:24.771336",
"fullName": "*********",
"identifications": [
{
"additionalInformation": "",
"requiresValidation": null,
"type": "Passport",
"idValue": "*********",
"idNumber": "*********",
"surname": "*******",
"givenName": "***************",
"otherName": null,
"sex": "******",
"nationality": "***********",
"dateOfBirth": "****-**-**T**:**:**",
"issueDate": "****-**-**",
"expiryDate": "****-**-**T**:**:**",
"isPrimary": false,
"isDeleted": false,
"id": "************************************",
"createdAt": "****-**-**T**:**:**.********",
"lastUpdated": "****-**-**T**:**:**.********",
"kyc": {
"id": "************************************",
"verifiedAt": "****-**-**T**:**:**.******+**:**",
"matchingStatus": null,
"cardStatus": null,
"ninStatus": null,
"status": "ID Document is not authentic",
"validationStatus": "invalid"
}
}
],
"phoneNumberDetails": [],
"screeningDetails": {
"amlStatus": null,
"amlScreenedData": null,
"pepStatus": null,
"pepScreenedData": null,
"lastVerified": null
},
"taxPayerDetails": {
"tin": null,
"tinStatus": null,
"taxpayerName": null,
"email": null,
"contactNumber": null,
"district": null,
"county": null,
"subCounty": null,
"village": null,
"postalAddress": null,
"summary": null
},
"biometricVerificationDetails": {
"customerPhotoMatch": "Unavailable",
"customerPhotoMatchChecked": null,
"livenessDetection": "Unavailable",
"livenessDetectionChecked": null,
"fingerprintVerification": null,
"fingerprintVerificationChecked": null
},
"biometrics": [
{
"type": "photoMatch",
"result": "Unavailable",
"action": null,
"performedBy": null,
"comment": null
},
{
"type": "livenessdetection",
"result": "Unavailable",
"action": null,
"performedBy": null,
"comment": null
},
{
"type": "fingerprint",
"result": null,
"lastVerified": null,
"action": null,
"performedBy": null,
"comment": null
}
],
"riskProfileVerificationDetails": {
"riskScore": null,
"riskClass": null,
"lastVerified": null,
"nationality": null,
"pepCheck": null
},
"homeAddress": {
"country": null,
"coordinates": null,
"checked": null
},
"workAddress": {
"country": null,
"district": null,
"county": null,
"town": null,
"coordinates": null,
"checked": null
},
"pepType": null,
"memberOrAssociateDetails": [],
"documents": [
{
"id": "******************************",
"name": "Nationalid-idBackPhoto",
"documentType": "nationalid",
"description": "ID Photo",
"contentType": "image/jpeg",
"size": "160 KB",
"reference": "******************************",
"dateCreated": "2024-07-22T12:45:03.043Z"
},
{
"id": "******************************",
"name": "Nationalid-idBackPhoto",
"documentType": "nationalid",
"description": "ID Photo",
"contentType": "image/jpeg",
"size": "160 KB",
"reference": "******************************",
"dateCreated": "2024-07-22T11:41:23.409Z"
}
]
},
"fileName": "kycperson",
"version": "v4.2.0"
}{
"type": "KycPerson",
"data": {
"generatedBy": "*********",
"profileCreationDate": "2024-07-09T11:03:32.830437",
"profileLastUpdated": "2024-07-24T14:51:24.771336",
"fullName": "*********",
"identifications": [
{
"additionalInformation": "",
"requiresValidation": null,
"type": "Passport",
"idValue": "*********",
"idNumber": "*********",
"surname": "*******",
"givenName": "***************",
"otherName": null,
"sex": "******",
"nationality": "***********",
"dateOfBirth": "****-**-**T**:**:**",
"issueDate": "****-**-**",
"expiryDate": "****-**-**T**:**:**",
"isPrimary": false,
"isDeleted": false,
"id": "************************************",
"createdAt": "****-**-**T**:**:**.********",
"lastUpdated": "****-**-**T**:**:**.********",
"kyc": {
"id": "************************************",
"verifiedAt": "****-**-**T**:**:**.******+**:**",
"matchingStatus": null,
"cardStatus": null,
"ninStatus": null,
"status": "ID Document is not authentic",
"validationStatus": "invalid"
}
}
],
"phoneNumberDetails": [],
"screeningDetails": {
"amlStatus": null,
"amlScreenedData": null,
"pepStatus": null,
"pepScreenedData": null,
"lastVerified": null
},
"taxPayerDetails": {
"tin": null,
"tinStatus": null,
"taxpayerName": null,
"email": null,
"contactNumber": null,
"district": null,
"county": null,
"subCounty": null,
"village": null,
"postalAddress": null,
"summary": null
},
"biometricVerificationDetails": {
"customerPhotoMatch": "Unavailable",
"customerPhotoMatchChecked": null,
"livenessDetection": "Unavailable",
"livenessDetectionChecked": null,
"fingerprintVerification": null,
"fingerprintVerificationChecked": null
},
"biometrics": [
{
"type": "photoMatch",
"result": "Unavailable",
"action": null,
"performedBy": null,
"comment": null
},
{
"type": "livenessdetection",
"result": "Unavailable",
"action": null,
"performedBy": null,
"comment": null
},
{
"type": "fingerprint",
"result": null,
"lastVerified": null,
"action": null,
"performedBy": null,
"comment": null
}
],
"riskProfileVerificationDetails": {
"riskScore": null,
"riskClass": null,
"lastVerified": null,
"nationality": null,
"pepCheck": null
},
"homeAddress": {
"country": null,
"coordinates": null,
"checked": null
},
"workAddress": {
"country": null,
"district": null,
"county": null,
"town": null,
"coordinates": null,
"checked": null
},
"pepType": null,
"memberOrAssociateDetails": [],
"documents": [
{
"id": "******************************",
"name": "Nationalid-idBackPhoto",
"documentType": "nationalid",
"description": "ID Photo",
"contentType": "image/jpeg",
"size": "160 KB",
"reference": "******************************",
"dateCreated": "2024-07-22T12:45:03.043Z"
},
{
"id": "******************************",
"name": "Nationalid-idBackPhoto",
"documentType": "nationalid",
"description": "ID Photo",
"contentType": "image/jpeg",
"size": "160 KB",
"reference": "******************************",
"dateCreated": "2024-07-22T11:41:23.409Z"
}
]
},
"fileName": "kycperson",
"version": "v4.2.0"
}Response
Content type
application/pdf
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 |