secuveriAPI docs
OpenAPIMarkdown

Read a read a proof of address check

GET/v1/proof-of-address/read/{id}

For the organization and environment that started it, for 24 hours.

Send your API key in the x-api-key header.

Path parameters

  • idstringuuidrequired

Responses

  • 200The check.
    • check_idstringuuidrequired
    • productstring
    • environmentstring | null
    • statusstringrequired

      One ofPROCESSINGCOMPLETEDFAILED

    • sandboxboolean
    • created_atstringdate-time
    • completed_atstring | nulldate-time
    • reference_idstring
    • poll_urlstring
    • resultobject
      Show 20 child properties
      • check_idstringuuid
      • productstring
      • environmentstring | null
      • sandboxboolean
      • checked_atstringdate-time
      • reference_idstring
      • signed_resultstring

        The same answer as an ES256 JWS, verifiable with /.well-known/jwks.json.

      • statestring

        One ofPASSREVIEWERROR

      • readboolean

        Whether the reader read the file (what is charged).

      • consistentboolean
      • findingsarray of string
      • document_typestring | null
      • issuerstring | null
      • issued_onstring | null
      • age_daysinteger | null
      • name_scorenumber | null
      • addressobject | null
      • postcode_matchboolean | null
      • qr_billobject | null
      • pdfobject | null
    • errorobject
      Show 2 child properties
      • codestring
      • messagestring
  • 401Missing, unknown or expired API key.
  • 403The key lacks the product's scope.
  • 404No such check for this organization and environment.
curl https://api-verify.secuveri.com/v1/proof-of-address/read/6f1c2e0a-8f43-4f7e-9a51-2b7c1d9e4a10 \
  -H "x-api-key: $SECUVERI_API_KEY"
Response · 200
{
  "check_id": "6f1c2e0a-8f43-4f7e-9a51-2b7c1d9e4a10",
  "environment": "<environment>",
  "status": "PROCESSING",
  "completed_at": "2026-10-23T09:12:44.120Z"
}