verification

Verify member

This endpoint gathers information about account and routing numbers. Partners may optionally choose to transaction data in this request, potentially avoiding a separate aggregate member request. The verification workflow is similar to standard aggregation. Start the verification, poll the member, answer MFA if necessary by using the list member MFA challenges endpoint and the update member endpoint, poll the status again, then read the member's account_numbers. Before making a request to this endpoint, partners must make sure verification is enabled for the member's institution. Specifically, the institution's supports_account_verification field must be true. If the institution does not support verification, a 400 Bad Request error will be returned with the message, Member's institution does not support instant account verification. If a request to this endpoint fails with a status of 403 Forbidden but the member's institution nevertheless shows that verification is enabled, please contact support.

post/members/{member_guid}/verify

Request

  • Base URL
    http://{baseurl}
  • URL
    http://{baseurl}/members/{member_guid}/verify
  • Auth
    HTTP basic

Path parameters

member_guidstring required

The unique identifier for the account. Defined by MX.

Request body

include_transactionsboolean

When set to true, the verification will gather transaction data along with account number data. Defaults to false.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.