Income verification data structure for Universal Credit
After each successful transaction you will be provided with a response including the following data set and the respective print screen file provided by the Universal Credit platform.
Note: The data model structure is similar to the regular income verification response, so the employment data block will be re-utilized for the users basic information such as name etc.
Employment Data
- Employee Name and Address
- Employer name is Universal Credit
Universal Credit Data
- Pay Month
- Amount paid
- Reported Income
- Print of the Statement
You can find a link to the print screen files inside the transaction response. That link will be downloadable for at least 3 months.
{
"status": "COMPLETED",
"_id": "yjXXXXXXyncegj1lc",
"client_id": "630e35XXXXXX6dd",
"ref_id": "XXXX",
"environment": "production",
"created_at": "2022-11-17T15:13:49.063Z",
"updated_at": "2022-11-17T15:19:35.707Z",
"__v": 0,
"provider": "Universal Credit",
"additional_income": {
"payments": [
{
"type": "universal_credit",
"date": "26 October 2022",
"value": "£1549.84",
"reported_income": "1096.18",
"payment_file": "xXXX/payment_123455-65c5-4eac-b54f-1234556_1668698373957.pdf"
},
{
"type": "universal_credit",
"date": "26 September 2022",
"value": "£1528.85",
"reported_income": "1096.18",
"payment_file": "xXXX/payment_123455-65c5-4eac-b54f-1234556_1668698373957.pdf"
},
{
"type": "universal_credit",
"date": "26 August 2022",
"value": "£1528.85",
"reported_income": "N/A",
"payment_file": "xXXX/payment_123455-65c5-4eac-b54f-1234556_1668698373957.pdf"
}
],
"summaries": [
{
"type": "universal_credit",
"summary_file": "yj517ngb564t296yncegj1lc/payments_all_1668698373031.pdf"
}
]
},
"employer": {
"name": "Universal Credit"
},
"finished_at": "2022-11-17T15:19:35.682Z",
"id": "yj517n12345XXXyncegj1lc"
}