Nexus API
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.
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.
Path Parameters
| Field | Required | Type |
|---|---|---|
member_guid The unique identifier for a member. Defined by MX. | Required | String |
Request Body
| Field | Required | Type |
|---|---|---|
include_transactions When set to true, the identification will gather transaction data along with account number data. Defaults to false. | Optional | Boolean |