Skip to main content

VerifySupportingDocument

POST 
/verify/supporting-documents

Experimental (beta): This feature is new and currently in beta.

Extract and validate a supporting document.

This endpoint accepts a document file (PDF, JPG, or PNG) and extracts personal identity information and address details.

Extracted addresses are returned both as a flat first_line_of_address/postcode pair and as structured addresses_formatted (residence_number, building_name, street, city, postcode, region) — the same name and shape as in the postcode search endpoint. Extraction produces at most one address; addresses_formatted is empty when no address fields were extracted.

Request format: This endpoint accepts multipart/form-data with:

  • document - The document file (PDF, JPG, or PNG, max 10MB)
  • sub_type (required) - The type of document (e.g., BankStatement, UtilityBill). See "Supported document types" below.
  • minimum_document_length (optional) - Minimum document age in months. Documents older than this will fail the document_age_valid check.

Supported document types (sub_type):

  • Payslip - Employment payslips
  • PensionAnnualStatement - Pension statements
  • BenefitsLetter - Government benefits letters
  • HMPPSLetter - Probation service letters
  • NHSLetter - NHS correspondence
  • BankStatement - Bank account statements
  • CreditCardStatement - Credit card statements
  • MortgageStatement - Mortgage statements
  • UtilityBill - Gas, electricity, water bills
  • MobilePhoneBill - Mobile phone bills

Validations performed:

  • required_fields_extracted - Key identity fields were successfully extracted. These are: first_name, last_name, first_line_of_address and postcode
  • category_match - Document matches the specified sub_type
  • document_age_valid - Document is within acceptable age range (only if minimum_document_length provided)
  • document_complete_and_legible - Document is complete and readable
  • tampering_signals_check - No signs of document tampering detected

Sandbox testing: In sandbox mode, the endpoint returns a mock "pass" response with sandbox values. No actual document processing occurs.

Request behaviour: This is a synchronous endpoint. Processing typically takes 5-15 seconds depending on document complexity.

This endpoint supports sandbox mode. See how sandbox mode works.

Request​

Responses​

Verification completed successfully