Parameters

Parameter Type Format Description
ClientFileId Int64   The ID of the ClientFile
Type String   The type of the document

The following values are valid:

Other
Mortgage Statement
Bank/Building Society Statement
Utility Bill
Council Tax Bill
Pay Slip
P60
P45
Tax Return
HMRC Letter
DWP Letter
Rent Card/Book
Phone Bill
Solicitors Letter
Employers Letter

TypeOther String   Used to add additional type context to the document, particularly if Type is 'Other'
Description String   The user given description of the document during verification
OriginalImageUrl String   The URL for the original document image, see GetClientDocument
CroppedImageUrl String   The URL for the cropped document image, see GetClientDocument
IsVerified Boolean   Whether the not document data has been confirmed as correct