Banking Verifications

Use a banking verification when the user will connect financial accounts and share the information required for an asset, income, or transaction report.

Order a banking verification

voa — Verification of Assets.
voai — Verification of Assets and Income.
voi — Verification of Income.
voe-transactions — Verification of Employment based on transaction data.

Send the following body to POST /partners/v2/verifications. Select the report type in report.type. The optional report.configuration object can define the history start date, income confidence threshold, and report custom fields.

{
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "report": {
    "type": "voai",
    "configuration": {
      "from_date": "2024-01-01T00:00:00Z",
      "income_stream_confidence_minimum": 50,
      "report_custom_fields": [
        {
          "label": "loanID",
          "value": "12345",
          "shown": true
        }
      ]
    }
  }
}

Choose a session type

After ordering the verification, create an embedded session or send an invite.

A user connects financial accounts for a banking verification.

Embedded banking

Create a session with POST /partners/v2/sessions, then pass the returned session link to the banking SDK as connectURL.

Banking SDK example

<div id="connect-container"></div>

<script type="module">
  import { Connect } from 'https://cdn.openbanking.mastercard.com/js/connect-web-sdk@2.2.0/mastercard-connect-esm.min.js'

  const connectURL = 'SESSION_LINK'
  const eventHandlers = {
    onDone: event => console.log('Connection successful', event),
    onCancel: event => console.log('User cancelled', event),
    onError: event => console.log('Banking flow error', event)
  }

  Connect.launch(connectURL, eventHandlers, {
    popup: false,
    selector: '#connect-container'
  })
</script>

Use SDK callbacks for immediate frontend handling. Subscribe to the verifications.updated webhook for backend lifecycle tracking. For SDK installation and configuration options, see the banking SDK documentation.

Email or SMS invite

Create an invite session with type = invite, the user ID, and an email address, phone number, or both. The user must have an active banking verification. The invitation opens a hosted connection flow, so no frontend SDK initialization is required.

Banking invites and other hosted or no-SDK banking paths must be enabled by Argyle before use. Contact your Argyle Customer Success Manager before using one of these paths.

See the Quickstart invite example.

Result

Wait for the verifications.updated webhook. When the verification reaches completed or completed_with_errors, retrieve the report from report.file_url or report.json_url.

​Order a banking verification

​Choose a session type

​Embedded banking

​Email or SMS invite

​Result

Order a banking verification

Choose a session type

Embedded banking

Email or SMS invite

Result