Skip to content

income-verification

idstring

Unique identifier for the report item.

Example:"rpi_F3hQ7wEsLp2xBnVcRuMyTk"
statusstring or null

Resolved status of this report item:

  • clear — no findings that warrant adjudication
  • consider — findings present; the result should be reviewed before making a decision

Null while the report item is still being assembled and no results have been recorded yet.

Enum:"clear""consider"null
created_atstring, (date-time)

Timestamp the report item was created.

updated_atstring, (date-time)

Timestamp the report item was last updated.

verification_methodstring or null

How the income was verified. bank when the applicant linked their accounts, document when they uploaded proof of income. Null before verification begins.

Example:"document"
current_as_ofstring or null, (date)

How current the findings are. For a bank connection, the date the account data was last refreshed. For documents, the last day the documents cover, which is not the date they were uploaded: documents[].submitted_at says that.

Null when only tax forms were supplied, which report a completed tax year rather than recent activity.

current_month_incomeincome-current-month (object) or null
One of:

Income across all active streams for the current month.

summaryincome-summary (object) or null
One of:

Aggregate income across all active and inactive streams.

Twelve months for a bank connection. For documents, the monthly averages divide whatever the documents cover, and the totals come from a single tax year, so the two are never comparable and must not be summed. The window behind each figure is on the streams that produced it.

accountsArray of objects(income-account)

One entry per financial-institution account the applicant connected. Empty when the income was verified by document, and when no results are available yet.

income_streamsArray of objects(income-stream)

Every income stream identified, whichever method established it. A stream a connected account produced names that account in account_id; one a document established names its evidence in document_ids.

Streams from a connected account also appear under that account in accounts[].income_streams. The two are the same objects, so read one or the other, never both, or the totals double.

documentsArray of objects(income-document)

Proof-of-income documents the applicant uploaded, oldest first. Empty when the income was verified by bank connection, and when document income verification is not enabled for your account.

consider_reasonsArray of objects(income-consider-reason)

Reasons the verification resulted in a consider status. Empty when status is clear or null. Each entry represents a distinct category explaining why the verification did not pass.

{
  "id": "rpi_F3hQ7wEsLp2xBnVcRuMyTk",
  "status": "clear",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "verification_method": "document",
  "current_as_of": "2019-08-24",
  "current_month_income": {
    "month": "2024-11",
    "net_cents": 224546,
    "estimated_gross_cents": 269455
  },
  "summary": {
    "average_monthly_net_cents": 393492,
    "total_past_12_months_net_cents": 4721906,
    "average_monthly_estimated_gross_cents": 472191,
    "total_past_12_months_estimated_gross_cents": 5666287
  },
  "accounts": [
    { … }
  ],
  "income_streams": [
    { … }
  ],
  "documents": [
    { … }
  ],
  "consider_reasons": [
    { … }
  ]
}