identity

Identify

This endpoint gathers information about account owners. Partners may optionally choose to include transaction data in this request, potentially avoiding a separate aggregate member request. The identification workflow is similar to standard aggregation - Start the identification, 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_owners. <br></br> Before making a request to this endpoint, partners must make sure identification is enabled for the member's institution. Specifically, the institution's supports_account_identification field must be true. If the institution does not support identification, a 400 Bad Request error will be returned with the message, Member's institution does not support instant account identification.

post/members/{member_guid}/identify

Request

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

Path parameters

member_guidstring required

The unique identifier for a member. Defined by MX.

Request body

include_transactionsboolean

When set to true, the identification 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.