Before requesting income and employment verification, create a case and share data either by uploading one or more payslips to the case.

Create a Case

Create a case using the create case endpoint. A case can optionally contain people. You can share data and request an Income and Employment verification at the case or person level.

For unique insights for individual applicants within a case, add each person as a person entity, upload relevant documents and request the verification per person.
For joint applications or to generate insights on multliple applicants, add all necessary documents or connections to the case and request insights for the entire case.

Upload Payslips

Upload payslips using the upload document endpoint. Ensure the entity_id and entity_type are specified in the request. For more accurate results, upload at least three complete months payslips.

Payslips must meet the following criteria:

Documents must be unaltered and unencrypted.
Documents should have a good resolution. If they are scanned or are an image then the image should not be blurry and all text must be clear.

Webhook Integration

When a payslip has been uploaded and we have attempted to extract the data from it we will try to send a PayslipProcessing.Completed webhook if one has been configured in our API. For full details, please see the Payslip Processing Completed Webhook section.

Upload Bank Statements

Upload bank statements using the upload document endpoint. Ensure the entity_id and entity_type are specified in the request. For accurate insights, upload at least three complete months of statements.

Bank statements must meet the following criteria:

Statements must be from a supported UK bank. You can find a list of supported banks here.
Statements must be in PDF format, base64 encoded.
Statements must be downloaded directly from the official bank website or mobile application. Photos or scanned copies are not supported.
Statements must be unaltered and unencrypted.
Statements must be for a joint or individual bank account. Mortgage statements, credit card statements and loan statements are not supported.

⚠️
Safari, Firefox and Edge browsers may alter the documents if viewed in the browser and then saved, either directly or via a “print to pdf” function.

Webhook Integration

When a bank statement has been uploaded and we have attempted to extract the data from it we will try to send a BankStatementProcessing.Completed webhook if one has been configured in our API. For full details, please see the Bank Statement Processing Completed Webhook section.

Create an Open Banking Connection

As an alternative to uploading bank statements, connect a bank account for a UK bank using open banking by utilising the relevant open banking connection endpoint.

You can find more information on the types of connected accounts that can be used to generate an affordability insights here.

You can also check the status of all open banking connections requested for an entity through the relevant endpoint.