Verification Reports#

A Verification Report contains all the results from a completed verification session. Reports include identity verification, credit data, income analysis, and cash flow scoring.

The Verification Report object#

Attribute	Type	Description
`id`	string	Unique identifier with `vr_` prefix
`object`	string	Always `"verification_report"`
`session`	string	Linked Verification Session ID
`status`	enum	`pending`, `processing`, `completed`, `error`
`identity`	object	Identity verification results
`identity.verified`	boolean	Whether identity was successfully verified
`identity.full_name`	string	Verified full name
`identity.date_of_birth`	string	Verified date of birth
`identity.documents`	array	Verified identity documents
`identity.selfie_match`	number	Selfie-to-document match score (0–1)
`credit_data`	object	Credit bureau data
`credit_data.tradelines`	array	Credit accounts
`credit_data.public_records`	array	Public records (bankruptcies, liens)
`credit_data.collections`	array	Collection accounts
`credit_data.inquiries`	array	Credit inquiries
`credit_data.bureau_scores`	array	Credit scores from bureaus
`income`	object	Income verification results
`income.annual_gross`	integer	Annual gross income in smallest currency unit
`income.annual_net`	integer	Annual net income
`income.sources`	array	Income sources
`income.employment`	object	Employment details
`income.pay_frequency`	string	Pay frequency
`cash_flow`	object	Cash flow analysis
`cash_flow.accounts`	array	Connected bank accounts
`cash_flow.attributes`	array	Cash flow attributes
`cash_flow.scores`	array	Cash flow scores
`sources`	array	Data sources used
`created`	timestamp	Time at which the object was created

{
  "id": "vr_9z8y7x6w5v",
  "object": "verification_report",
  "session": "vs_1a2b3c4d5e6f",
  "status": "completed",
  "identity": {
    "verified": true,
    "full_name": "Jane Marie Doe",
    "date_of_birth": "1990-05-15",
    "documents": [
      {
        "type": "passport",
        "number": "***6789",
        "country": "GB",
        "expiry_date": "2030-03-15"
      }
    ],
    "selfie_match": 0.98
  },
  "credit_data": {
    "tradelines": [
      {
        "creditor": "High Street Bank",
        "type": "credit_card",
        "balance": 125000,
        "limit": 500000,
        "status": "current",
        "opened": "2018-06-01"
      }
    ],
    "bureau_scores": [
      { "bureau": "experian", "score": 742, "date": "2025-01-10" }
    ],
    "public_records": [],
    "collections": [],
    "inquiries": [
      { "creditor": "Mortgage Co", "date": "2024-12-01", "type": "hard" }
    ]
  },
  "income": {
    "annual_gross": 7200000,
    "annual_net": 5400000,
    "pay_frequency": "monthly",
    "employment": {
      "employer": "Acme Corporation",
      "title": "Software Engineer",
      "start_date": "2021-03-01",
      "status": "active"
    },
    "sources": [
      {
        "type": "employment",
        "employer": "Acme Corporation",
        "amount": 600000,
        "frequency": "monthly",
        "currency": "gbp"
      }
    ]
  },
  "cash_flow": {
    "accounts": [
      {
        "institution": "High Street Bank",
        "account_type": "checking",
        "balance": 850000,
        "currency": "gbp"
      }
    ],
    "scores": [
      { "type": "cash_flow_score", "value": 78, "risk_indicator": "low_risk" }
    ],
    "attributes": [
      { "name": "avg_monthly_income", "value": 540000 },
      { "name": "avg_monthly_expenses", "value": 380000 },
      { "name": "avg_monthly_balance", "value": 720000 }
    ]
  },
  "sources": [
    { "source_id": "src_exp_01", "source_type": "credit_bureau", "status": "completed" },
    { "source_id": "src_ob_01", "source_type": "open_banking", "status": "completed" }
  ],
  "created": 1706140800
}

Retrieve a Verification Report#

GET /v1/verification_reports/:id

curl https://api.casapay.com/v1/verification_reports/vr_9z8y7x6w5v \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

List Verification Reports#

GET /v1/verification_reports

Parameter	Type	Description
`session`	string	Filter by Verification Session ID
`status`	string	Filter by status
`limit`	integer	Number of objects to return (1–100)
`starting_after`	string	Cursor for pagination

curl https://api.casapay.com/v1/verification_reports?session=vs_1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"