NAV Navbar
cURL C# Go Java Node PHP Python Ruby
  • What's in this guide
  • Whitelisting
  • Resource structure
  • Creating users
  • Creating members
  • Aggregating data and dealing with MFA
  • Pulling data
  • Tools to get you running
  • Testing your setup
  • Support
  • Product mailing list
  • Getting started with Atrium

    What's in this guide

    In this guide, you'll find lots of information to help you get up and running with Atrium. It includes material on about how the API works, common terminology, common problem scenarios, a Postman collection and downloadable examples in multiple languages, steps on how to test certain Atrium features, broad workflows for common tasks, and more.

    This is not designed to be comprehensive but to provide a broad overview of common tasks and issues. Refer to our detailed API reference for more specific information about Atrium resources, endpoints, and configuration options.

    Whitelisting

    Before you can work within Atrium's production environment, your IP addresses must be whitelisted. If you haven't been whitelisted, you'll see 403 Forbidden errors. Contact support to have your addresses whitelisted.

    Atrium's vestibule environment does not require any whitelisting.

    Resource structure

    Atrium is structured around five major resources, each with its own attributes and endpoints:

    Resource Description
    institution An institution represents a financial institution (FI) like Chase or Wells Fargo. It's important to point out that many real-world FI will actually have several different institution objects within Atrium. This is because, for example, the mortgage division of Wells Fargo might use a separate system than its everyday banking division, which is different from its credit card division, etc.
    user A user represents a person using Atrium via your application, be it a mobile app, web app, desktop app, etc.
    member A member represents the relationship between a user and an institution. A user may have one member each for their bank, their mortgage broker, their credit card provider, etc. Aggregation takes place via members.
    account An account represents a financial account held by an FI, e.g., a user's checking or savings account. A member may have more than one account associated with it. For instance, a user may have both a checking and savings account associated with one Chase login and therefore would have two accounts associated with one member.
    transaction A transaction represents any instance in which money moves into or out of an account, such as a purchase at a business, a payroll deposit, a transfer from one account to another, an ATM withdrawal, etc. Each transaction belongs to only one account.

    Creating users

    Example request

    $ curl -i -X POST 'https://vestibule.mx.com/users' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "user": {
              "identifier": "unique_id",
              "metadata": "{\"first_name\": \"Steven\"}"
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class CreateUserExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var body = new UserCreateRequestBody(); // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
                try
                {
                    // Create user
                    UserResponseBody response = client.users.CreateUser(body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling UsersApi.CreateUser: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      body := atrium.UserCreateRequestBody{} // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
      response, _, err := client.Users.CreateUser(ctx, body)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class UsersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            UserCreateRequestBody body = new UserCreateRequestBody(); // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
            try {
                UserResponseBody response = client.users.createUser(body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling UsersApi#createUser");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var body = new atrium.UserCreateRequestBody(); // UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    var response = client.users.createUser(body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $body = new \atrium\model\UserCreateRequestBody(); // \atrium\model\UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    try {
        $result = $client->users->createUser($body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling UsersApi->createUser: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    body = atrium.UserCreateRequestBody() # UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    try:
        # Create user
        response = client.users.create_user(body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling UsersApi->create_user: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    body = Atrium::UserCreateRequestBody.new # UserCreateRequestBody | User object to be created with optional parameters (identifier, is_disabled, metadata)
    
    begin
      #Create user
      response = client.users.create_user(body)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling UsersApi->create_user: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "user": {
        "guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
        "identifier": "unique_id",
        "is_disabled": false,
        "metadata": "{\"first_name\": \"Steven\"}"
      }
    }
    
    class UserResponseBody {
      User:
        class User {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    {
      User:
        {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    class UserResponseBody {
      user:
        class User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    UserResponseBody {
      user:
        User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    atrium/model/UserResponseBody Object (
      [user] =>
        atrium/model/User Object (
          [guid] => USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          [identifier] => My-Unique-ID
          [is_disabled] => false
          [metadata] => {"first_name": "Steven", "last_name": "Universe"}
        )
    )
    
    {
      'user':
        {
          'guid': USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          'identifier': My-Unique-ID
          'is_disabled': false
          'metadata': {"first_name": "Steven", "last_name": "Universe"}
        }
    }
    
    #<MX::UserResponseBody
      @user=
        #<MX::User
          @guid= USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          @identifier= My-Unique-ID
          @is_disabled= false
          @metadata= {"first_name": "Steven", "last_name": "Universe"}
        >
    >
    

    To create a new user, call the create user endpoint. It's a good idea to send along a unique identifier with your request to create a new user. Atrium will also give each new user a unique GUID in the guid field within the user object. The Atrium user GUID also appears in the user_guid field when not inside the user object. The identifier and guid allow you to easily map between your system and Atrium.

    You may also include metadata, such as the date the user was created, if desired. You can read more on identifiers and metadata on our API reference page.

    An example request for creating a user is shown to the right.

    Creating members

    POST /users/{user_guid}/members
    

    Example request

    $ curl -i -X POST 'https://vestibule.mx.com/users/{user_guid}/members' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member": {
              "institution_code": "chase",
              "credentials": [
                {
                  "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
                  "value": "ExampleUsername"
                },
                {
                  "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
                  "value": "Pa$$vv@Rd"
                }
              ],
              "skip_aggregation": true
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class CreateMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
                try
                {
                    // Create member
                    MemberResponseBody response = client.members.CreateMember(userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.CreateMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      body := atrium.MemberCreateRequestBody{} // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
      response, _, err := client.Members.CreateMember(ctx, userGUIDbody)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            MemberCreateRequestBody body = new MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
            try {
                MemberResponseBody response = client.members.createMember(userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#createMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    var response = client.members.createMember(userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberCreateRequestBody(); // \atrium\model\MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    try {
        $result = $client->members->createMember($user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->createMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.MemberCreateRequestBody() # MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    try:
        # Create member
        response = client.members.create_member(user_guid, body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->create_member: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    body = Atrium::MemberCreateRequestBody.new # MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    begin
      #Create member
      response = client.members.create_member(user_guidbody)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->create_member: #{e}"
    end
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-10-13T17:57:36+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "chase",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "Chase Bank",
        "status": "INITIATED",
        "successfully_aggregated_at": null,
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Once a user is created, we recommend creating a member with our MX Connect widget. MX Connect allows end users to easily choose an institution to connect to, enter credentials, update credentials, and answer multi-factor authentication.

    If your system or application is unable to support MX Connect, you can always call the endpoint directly in your code. To create a member via endpoints, you'll follow the workflow below:

    Once your member has been created, you'll want to call the read member status endpoint to determine whether answering MFA is required or to update credentials as needed.

    A step-by-step walkthrough on creating a member via endpoints can be found below.

    Aggregating data and dealing with MFA

    Aggregating data about accounts and transactions belonging to a member is a multi-step process. It involves attempting an aggregation request using the aggregate member endpoint, polling the member for changes in the aggregation status, possibly answering additional challenges as required by the institution, then resuming the aggregation.

    If an end user is present, you may call the aggregate member endpoint in order to run a foreground aggregation. End users must be present during foreground aggregations because they may run into MFA, credential update requests, terms and conditions agreements, or any number of other actions required of the end user at an online banking portal.

    Both foreground and background aggregation may be manually disabled by disabling a user. A user must be re-enabled before any aggregation can be attempted.

    Atrium may suspend background aggregation on a particular member in some circumstances, such as when several consecutive aggregation attempts fail. However, you may always attempt a foreground aggregation on a suspended member.

    MFA and connection statuses

    Some institutions require multiple steps for authentication; this process is called multi-factor authentication (MFA). Basically, it is a back and forth dialogue between the end user, the partner's application, and the institution. After the initial credentials are provided, the institution can either grant access or present an MFA challenge.

    When an MFA challenge is presented, you must get the correct value from the end user and send it to MX so the aggregation can continue. More than one MFA cycle may occur. Partners must continue to answer the institution's challenges until the institution grants access to the end user's account.

    Financial institutions will typically have multiple MFA questions and may ask a new question in future aggregations.

    A single aggregation may also enter multiple CHALLENGED states. A typical scenario for this is when a list of options is presented along with a question such as, "Where should we send an authentication token?"

    More details on how to deal with multi-factor authentication are below.

    Member connection statuses

    The connection_status field appears on all member resources and indicates the current state of aggregation for that particular member. Partners can poll a particular member using the read member connection status endpoint to follow changes in the connection_status throughout an aggregation. Partners can use the list members endpoint to get a list of connection statuses for all members.

    The connection_status should be used in conjunction with several other member fields to determine future actions, including aggregated_at, is_being_aggregated, and successfully_aggregated_at. Definitions for these fields appear at the end of this section. Definitions for all member fields are available here.

    For example, when the connection_status is CONNECTED and the is_being_aggregated field is false, this means the latest aggregation attempt has finished and data for accounts and transactions should be pulled. Partners can use the field successfully_aggregated_at to determine when the last successful aggregation occurred.

    When the status is CHALLENGED, an MFA challenge has been issued, requiring a separate workflow and end-user input.

    The statuses CREATED, UPDATED, DELAYED, and RESUMED represent transient states for different points in the aggregation process and generally do not require a specific action or end-user input. They may, however, require continued polling until an end state is reached.

    The statuses PREVENTED, DENIED, IMPEDED, IMPAIRED, REJECTED, EXPIRED, LOCKED, IMPORTED, DISABLED, DISCONTINUED, and CLOSED, represent end states that will require a new aggregation, and possibly end-user input for future success.

    Member fields to poll during aggregation

    Field Name Data Type Description
    aggregated_at String The date and time the member the last aggregation was initiated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-06:00).
    connection_status String This field indicates the state of a member's aggregation, provided as a string. See member connection statuses below for more information on possible values.
    is_being_aggregated Boolean This field will be true if the member is being aggregated at the time of the request. Otherwise, this field will be false.
    successfully_aggregated_at String The date and time the account was last successfully aggregated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-06:00).

    Dealing with a CHALLENGED status

    When a member comes back with a status of CHALLENGED, the aggregation will require MFA credentials from the end user; specifically, the answers to challenges presented by the institution.

    Partners must make a request to the list member challenges endpoint to obtain the challenges to be presented to the end user.

    Resume the aggregation

    Once the MFA credentials have been gathered for the CHALLENGED member, a request to the resume aggregation endpoint will add these MFA credentials to the member and automatically resume the aggregation process. It will run until it either completes in an end state or enters into a state that requires action, as described above.

    It is not uncommon for an aggregation to be CHALLENGED more than once.

    Dealing with multiple CHALLENGED states in one aggregation

    A single aggregation may enter multiple CHALLENGED states. A typical scenario for this is when a list of options is presented along with a question such as, "Where should we send an authentication token?"

    The end user should be prompted for the answer and the answer provided to MX. The aggregation will move to a RESUMED state, but then will go back into a CHALLENGED state. This time, the end user should be prompted to enter the access token. If the MFA challenge is answered successfully, the aggregation will typically proceed to an end state.

    Dealing with a DENIED, PREVENTED, or EXPIRED status

    If a member has a PREVENTED or a DENIED status, it means the authentication credentials are invalid; the end user must provide new credentials, and the member must be updated. A request to the list member credentials endpoint (as distinct from the separate list institution credentials endpoint) will return a list of the authentication credentials required for that member; corresponding input should be gathered from the end user, and that input should be passed to the update member endpoint.

    Pulling data

    When an aggregation is initiated, the member field aggregated_at will update. If it completes successfully, the successfully_aggregated_at field will be updated. These will help you determine when to pull the latest data after a foreground aggregation.

    Transaction data can be accessed though three different endpoints: /users/{user_guid}/transactions, /users/{user_guid}/members/{member_guid}/transactions, and /users/{user_guid}/accounts/{account_guid}/transactions. The first will list all the transactions that belong to the user object. The second will return all transactions that belong to a member object. The third will return all transactions that belong to an 'account' object.

    We recommend first listing available accounts, then listing transactions for a specific account.

    Tools to get you running

    The Postman collection below will allow you to start experimenting with Atrium immediately. The GitHub collections below demonstrate recommended workflows.

    Postman

    To easily get up and running, we recommend using Postman to experiment with Atrium. To do so you should:

    1. Download Postman.
    2. Install the Atrium Postman collection as explained here.
    3. Add the following fields and your own values to a new Postman environment as explained here.
      • MX-API-Key
      • MX-Client-ID
      • Accept
      • Content-Type
      • baseURL
      • User
      • Member
      • Account

    Wrapper libraries on GitHub

    To see example workflows, please download one of our Atrium wrapper libraries in the language of your choice.

    Testing your setup

    The next few sections will take you through the process of creating and aggregating a member as well as aggregating a member that has been challenged by MFA and multiple-question MFA. This process involves many of the important tasks possible with Atrium — and therefore illuminates many of the places where you might trip up.

    These are the basic steps involved:

    Testing for multiple-question MFA is very similar to single-question MFA explained above for MX bank, and the same general steps should be followed. These are outlined below.

    1. Aggregate the member (or create a new member)
    2. Poll the member connection status.
      • With MX Bank, this will return a challenge.
    3. Answer the challenge using the resume aggregation endpoint
    4. Poll the status until an end state is reached.

    MX provides credentials in our development environment that can be used with the MX Bank institution (institution code: mxbank) to test different aggregation responses. These can be used when creating a test member or answering MFA questions. To test the same behavior, aggregate the member again using the appropriate test credentials.

    The test credentials for different situations are as follows:

    Username Password Description
    test_atrium password This mimics successful aggregation with no MFA.
    test_atrium challenge This mimics a text-based MFA challenge. Answer with the word correct to successfully progress through MFA.
    test_atrium options This mimics the "option list" type of MFA challenge. Select "correct" to successfully progress through MFA.
    test_atrium image This mimics the image type of MFA challenge. Answer with the word "correct" to successfully progress through MFA.
    test_atrium BAD_REQUEST This mimics not having a username and password on the member. The member status will go to HALTED.
    test_atrium UNAUTHORIZED This mimics the member having invalid credentials. The member status will go to DENIED.
    test_atrium INVALID This mimics the member having invalid login and/or password fields. The member status will go to DENIED.
    test_atrium LOCKED This mimics a user being locked out of their banking institution. The member status will go to DENIED.
    test_atrium SERVER_ERROR This mimics the financial institution having a server error. The member status will go to HALTED.
    test_atrium UNAVAILABLE This mimics the financial institution having a "service unavailable" error. The member status will go to HALTED.

    Creating a member

    Step one: Search for an institution

    GET /institutions/{institution_code}
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/institutions/mxbank' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadInstitutionExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var institutionCode = "example_institution_code";  // string | The institution_code of the institution.
    
                try
                {
                    // Read institution
                    InstitutionResponseBody response = client.institutions.ReadInstitution(institutionCode);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling InstitutionsApi.ReadInstitution: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      institutionCode := "example_institution_code" // string | The institution_code of the institution.
    
      response, _, err := client.Institutions.ReadInstitution(ctx, institutionCode)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class InstitutionsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String institutionCode = "example_institution_code"; // String | The institution_code of the institution.
    
            try {
                InstitutionResponseBody response = client.institutions.readInstitution(institutionCode);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling InstitutionsApi#readInstitution");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var institutionCode = "example_institution_code"; // string | The institution_code of the institution.
    
    var response = client.institutions.readInstitution(institutionCode);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $institution_code = "example_institution_code"; // string | The institution_code of the institution.
    
    try {
        $result = $client->institutions->readInstitution($institution_code);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling InstitutionsApi->readInstitution: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # str | The institution_code of the institution.
    
    try:
        # Read institution
        response = client.institutions.read_institution(institution_code)
        pprint(response)
    except ApiException as e:
        print("Exception when calling InstitutionsApi->read_institution: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # String | The institution_code of the institution.
    
    begin
      #Read institution
      response = client.institutions.read_institution(institution_code)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling InstitutionsApi->read_institution: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "institution": {
        "code": "mxbank",
        "medium_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png",
        "name": "MX Bank",
        "small_logo_url": "https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png",
        "supports_account_identification": true,
        "supports_account_verification": true,
        "url": "https://www.mx.com"
      }
    }
    
    class InstitutionResponseBody {
      Institution:
        class Institution {
          Code: Mxbank
          MediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          Name: mx Bank
          SmallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          SupportsAccountIdentification: true
          SupportsAccountVerification: true
          Url: https://www.mx.com
        }
    }
    
    {
      Institution:
        {
          Code: mx
          MediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          Name: mx Bank
          SmallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          SupportsAccountIdentification: true
          SupportsAccountVerification: true
          Url: https://www.mx.com
        }
    }
    
    class InstitutionResponseBody {
      institution:
        class Institution {
          code: mxbank
          mediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          name: mx Bank
          smallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          supportsAccountIdentification: true
          supportsAccountVerification: true
          url: https://www.mx.com
        }
    }
    
    InstitutionResponseBody {
      institution:
        Institution {
          code: mxbank
          mediumLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          name: mx Bank
          smallLogoUrl: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          supportsAccountIdentification: true
          supportsAccountVerification: true
          url: https://www.mx.com
        }
    }
    
    atrium/model/InstitutionResponseBody Object (
      [institution] =>
        atrium/model/Institution Object (
          [code] => mxbank
          [medium_logo_url] => https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          [name] => mx Bank
          [small_logo_url] => https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          [supports_account_identification] => true
          [supports_account_verification] => true
          [url] => https://www.mx.com
        )
    )
    
    {
      'institution':
        {
          'code': mxbank
          'medium_logo_url': https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          'name': mx Bank
          'small_logo_url': https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          'supports_account_identification': true
          'supports_account_verification': true
          'url': https://www.mx.com
        }
    }
    
    #<MX::InstitutionResponseBody
      @institution=
        #<MX::Institution
          @code= mxbank
          @medium_logo_url= https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          @name= mx Bank
          @small_logo_url= https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          @supports_account_identification= true
          @supports_account_verification= true
          @url= https://www.mx.com
        >
    >
    

    Step two: Get institution required credentials

    GET /institutions/{institution_code}/credentials
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/institutions/mxbank/credentials' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadInstitutionCredentialsExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var institutionCode = "example_institution_code";  // string | The institution_code of the institution.
    
                try
                {
                    // Read institution credentials
                    CredentialsResponseBody response = client.institutions.ReadInstitutionCredentials(institutionCode);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling InstitutionsApi.ReadInstitutionCredentials: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      institutionCode := "example_institution_code" // string | The institution_code of the institution.
    
      response, _, err := client.Institutions.ReadInstitutionCredentials(ctx, institutionCode)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class InstitutionsApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String institutionCode = "example_institution_code"; // String | The institution_code of the institution.
    
            try {
                CredentialsResponseBody response = client.institutions.readInstitutionCredentials(institutionCode);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling InstitutionsApi#readInstitutionCredentials");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var institutionCode = "example_institution_code"; // string | The institution_code of the institution.
    
    var response = client.institutions.readInstitutionCredentials(institutionCode);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $institution_code = "example_institution_code"; // string | The institution_code of the institution.
    
    try {
        $result = $client->institutions->readInstitutionCredentials($institution_code);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling InstitutionsApi->readInstitutionCredentials: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # str | The institution_code of the institution.
    
    try:
        # Read institution credentials
        response = client.institutions.read_institution_credentials(institution_code)
        pprint(response)
    except ApiException as e:
        print("Exception when calling InstitutionsApi->read_institution_credentials: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    institution_code = "example_institution_code" # String | The institution_code of the institution.
    
    begin
      #Read institution credentials
      response = client.institutions.read_institution_credentials(institution_code)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling InstitutionsApi->read_institution_credentials: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
        "credentials": [
            {
                "field_name": "login_email",
                "guid": "CRD-12ce94ad-032b-5441-8cb3-d7ebe3a35676",
                "label": "Email Address",
                "display_order": 0,
                "type": "LOGIN"
            },
            {
                "field_name": "login_password",
                "guid": "CRD-305767e4-f464-765b-8f83-881b5bd307ec",
                "label": "PayPal password",
                "display_order": 1,
                "type": "PASSWORD"
            }
        ]
    }
    
    class CredentialsResponseBody {
      Credentials: [
        class CredentialResponse {
          FieldName: LOGIN
          Guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          Label: Username
          Options: [
            class CredentialOption {
              Label: option_label
              Value: option_value
            }      
          ]
          Type: LOGIN
        }  
      ]
    }
    
    {
      Credentials: [
        {
          FieldName: LOGIN
          Guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          Label: Username
          Options: [
            {
              Label: option_label
              Value: option_value
            }      
          ]
          Type: LOGIN
        }  
      ]
    }
    
    class CredentialsResponseBody {
      credentials: [
        class CredentialResponse {
          fieldName: LOGIN
          guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          label: Username
          options: [
            class CredentialOption {
              label: option_label
              value: option_value
            }      
          ]
          type: LOGIN
        }  
      ]
    }
    
    CredentialsResponseBody {
      credentials: [
        CredentialResponse {
          fieldName: LOGIN
          guid: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          label: Username
          options: [
            CredentialOption {
              label: option_label
              value: option_value
            }      
          ]
          type: LOGIN
        }  
      ]
    }
    
    atrium/model/CredentialsResponseBody Object (
      [credentials] => Array (
        atrium/model/CredentialResponse Object (
          [field_name] => LOGIN
          [guid] => CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          [label] => Username
          [options] => Array (
            atrium/model/CredentialOption Object (
              [label] => option_label
              [value] => option_value
            )      
          )
          [type] => LOGIN
        )  
      )
    )
    
    {
      'credentials': [
        {
          'field_name': LOGIN
          'guid': CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          'label': Username
          'options': [
            {
              'label': option_label
              'value': option_value
            }      
          ]
          'type': LOGIN
        }  
      ]
    }
    
    #<MX::CredentialsResponseBody
      @credentials= [
        #<MX::CredentialResponse
          @field_name= LOGIN
          @guid= CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          @label= Username
          @options= [
            #<MX::CredentialOption
              @label= option_label
              @value= option_value
            >      
          ]
          @type= LOGIN
        >  
      ]
    >
    

    Step three: List users

    GET /users
    

    Example request

    
    # Here, we're checking to see what users are available for testing.
    # Note that this endpoint returns paginated results and accepts optional pagination parameters.
    
    $ curl -i -X GET 'https://vestibule.mx.com/users' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ListUsersExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var page = 1;  // int? | Specify current page. (optional)
                var recordsPerPage = 12;  // int? | Specify records per page. (optional)
    
                try
                {
                    // List users
                    UsersResponseBody response = client.users.ListUsers(page, recordsPerPage);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling UsersApi.ListUsers: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
      "github.com/antihax/optional"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      opts := &atrium.ListUsersOpts{
        Page: optional.NewInt32(1), // int32 | Specify current page.
        RecordsPerPage: optional.NewInt32(12), // int32 | Specify records per page.
      }
    
      response, _, err := client.Users.ListUsers(ctx, opts)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class UsersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            Integer page = 1; // Integer | Specify current page.
            Integer recordsPerPage = 12; // Integer | Specify records per page.
    
            try {
                UsersResponseBody response = client.users.listUsers(page, recordsPerPage);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling UsersApi#listUsers");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var page = 1; // number | Specify current page. (optional)
    var recordsPerPage = 12; // number | Specify records per page. (optional)
    
    var response = client.users.listUsers(page, recordsPerPage);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $page = 1; // int | Specify current page.
    $records_per_page = 12; // int | Specify records per page.
    
    try {
        $result = $client->users->listUsers($page, $records_per_page);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling UsersApi->listUsers: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    page = 1 # int | Specify current page. (optional)
    records_per_page = 12 # int | Specify records per page. (optional)
    
    try:
        # List users
        response = client.users.list_users(page=page, records_per_page=records_per_page)
        pprint(response)
    except ApiException as e:
        print("Exception when calling UsersApi->list_users: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    opts = {
      page: 1, # Integer | Specify current page.
      records_per_page: 12, # Integer | Specify records per page.
    }
    
    begin
      #List users
      response = client.users.list_users(opts)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling UsersApi->list_users: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "users": [
        {
          "guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
          "identifier": "unique_id",
          "is_disabled": false,
          "metadata": "{\"first_name\": \"Steven\"}"
        },
        {
          "guid": "USR-7c6f361b-e582-15b6-60c0-358f12466b4b",
          "identifier": "unique_id",
          "is_disabled": false,
          "metadata": "{\"first_name\": \"Barb\"}"
        }
      ]
    }
    
    class UsersResponseBody {
      Users: [
        class User {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      Pagination:
        class Pagination {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    {
      Users: [
        {
          Guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          Identifier: My-Unique-ID
          IsDisabled: false
          Metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      Pagination:
        {
          CurrentPage: 1
          PerPage: 25
          TotalEntries: 1
          TotalPages: 1
        }
    }
    
    class UsersResponseBody {
      users: [
        class User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      pagination:
        class Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    UsersResponseBody {
      users: [
        User {
          guid: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          identifier: My-Unique-ID
          isDisabled: false
          metadata: {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      pagination:
        Pagination {
          currentPage: 1
          perPage: 25
          totalEntries: 1
          totalPages: 1
        }
    }
    
    atrium/model/UsersResponseBody Object (
      [users] => Array (
        atrium/model/User Object (
          [guid] => USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          [identifier] => My-Unique-ID
          [is_disabled] => false
          [metadata] => {"first_name": "Steven", "last_name": "Universe"}
        )  
      )
      [pagination] =>
        atrium/model/Pagination Object (
          [current_page] => 1
          [per_page] => 25
          [total_entries] => 1
          [total_pages] => 1
        )
    )
    
    {
      'users': [
        {
          'guid': USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          'identifier': My-Unique-ID
          'is_disabled': false
          'metadata': {"first_name": "Steven", "last_name": "Universe"}
        }  
      ]
      'pagination':
        {
          'current_page': 1
          'per_page': 25
          'total_entries': 1
          'total_pages': 1
        }
    }
    
    #<MX::UsersResponseBody
      @users= [
        #<MX::User
          @guid= USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          @identifier= My-Unique-ID
          @is_disabled= false
          @metadata= {"first_name": "Steven", "last_name": "Universe"}
        >  
      ]
      @pagination=
        #<MX::Pagination
          @current_page= 1
          @per_page= 25
          @total_entries= 1
          @total_pages= 1
        >
    >
    

    Step four: Create a member

    POST /users/{user_guid}/members
    

    Example request

    $ curl -i -X POST 'https://vestibule.mx.com/users/{user_guid}/members' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member": {
              "institution_code": "chase",
              "credentials": [
                {
                  "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
                  "value": "ExampleUsername"
                },
                {
                  "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
                  "value": "Pa$$vv@Rd"
                }
              ],
              "skip_aggregation": true
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class CreateMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
                try
                {
                    // Create member
                    MemberResponseBody response = client.members.CreateMember(userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.CreateMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      body := atrium.MemberCreateRequestBody{} // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
      response, _, err := client.Members.CreateMember(ctx, userGUIDbody)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            MemberCreateRequestBody body = new MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
            try {
                MemberResponseBody response = client.members.createMember(userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#createMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.MemberCreateRequestBody(); // MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    var response = client.members.createMember(userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberCreateRequestBody(); // \atrium\model\MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    try {
        $result = $client->members->createMember($user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->createMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.MemberCreateRequestBody() # MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    try:
        # Create member
        response = client.members.create_member(user_guid, body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->create_member: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    body = Atrium::MemberCreateRequestBody.new # MemberCreateRequestBody | Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
    
    begin
      #Create member
      response = client.members.create_member(user_guidbody)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->create_member: #{e}"
    end
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-10-13T17:57:36+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "chase",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "Chase Bank",
        "status": "INITIATED",
        "successfully_aggregated_at": null,
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: chase
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: Chase Bank
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: chase
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: Chase Bank
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => chase
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => Chase Bank
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': chase
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': Chase Bank
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= chase
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= Chase Bank
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Step five: Poll the member status

    GET /users/{user_guid}/members/{member_guid}/status
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/status' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadMemberStatusExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read member connection status
                    MemberConnectionStatusResponseBody response = client.members.ReadMemberStatus(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ReadMemberStatus: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ReadMemberStatus(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberConnectionStatusResponseBody response = client.members.readMemberStatus(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#readMemberStatus");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.readMemberStatus(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->readMemberStatus($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->readMemberStatus: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read member connection status
        response = client.members.read_member_status(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->read_member_status: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    
    begin
      #Read member connection status
      response = client.members.read_member_status(member_guid, user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->read_member_status: #{e}"
    end
    

    Example response

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at": "2016-10-13T18:07:57+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "has_processed_accounts": true,
        "has_processed_transactions": false,
        "identifier": "unique_id",
        "institution_code": "chase",
        "is_being_aggregated": false,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "Chase Bank",
        "status": "COMPLETED",
        "successfully_aggregated_at": "2016-10-13T17:57:38+00:00",
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberConnectionStatusResponseBody {
      Member:
        class MemberConnectionStatus {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            class Challenge {
              FieldName: Who is this guy?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              ImageData: Who is this guy?
              Label: Who is this guy?
              Options: [
                class ChallengeOption {
                  ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
                  Label: IMAGE_1
                  Value: image_data
                }          
              ]
              Type: IMAGE_DATA
            }      
          ]
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: false
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            {
              FieldName: Who is this guy?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              ImageData: Who is this guy?
              Label: Who is this guy?
              Options: [
                {
                  ImageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
                  Label: IMAGE_1
                  Value: image_data
                }          
              ]
              Type: IMAGE_DATA
            }      
          ]
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: false
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    class MemberConnectionStatusResponseBody {
      member:
        class MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            class Challenge {
              fieldName: Who is this guy?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              imageData: Who is this guy?
              label: Who is this guy?
              options: [
                class ChallengeOption {
                  imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
                  label: IMAGE_1
                  value: image_data
                }          
              ]
              type: IMAGE_DATA
            }      
          ]
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: false
          isBeingAggregated: false
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    MemberConnectionStatusResponseBody {
      member:
        MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            Challenge {
              fieldName: Who is this guy?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              imageData: Who is this guy?
              label: Who is this guy?
              options: [
                ChallengeOption {
                  imageData: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
                  label: IMAGE_1
                  value: image_data
                }          
              ]
              type: IMAGE_DATA
            }      
          ]
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: false
          isBeingAggregated: false
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    atrium/model/MemberConnectionStatusResponseBody Object (
      [member] =>
        atrium/model/MemberConnectionStatus Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [challenges] => Array (
            atrium/model/Challenge Object (
              [field_name] => Who is this guy?
              [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              [image_data] => Who is this guy?
              [label] => Who is this guy?
              [options] => Array (
                atrium/model/ChallengeOption Object (
                  [image_data] => data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
                  [label] => IMAGE_1
                  [value] => image_data
                )          
              )
              [type] => IMAGE_DATA
            )      
          )
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [has_processed_accounts] => true
          [has_processed_transactions] => false
          [is_being_aggregated] => false
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'challenges': [
            {
              'field_name': Who is this guy?
              'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              'image_data': Who is this guy?
              'label': Who is this guy?
              'options': [
                {
                  'image_data': data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
                  'label': IMAGE_1
                  'value': image_data
                }          
              ]
              'type': IMAGE_DATA
            }      
          ]
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'has_processed_accounts': true
          'has_processed_transactions': false
          'is_being_aggregated': false
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
        }
    }
    
    #<MX::MemberConnectionStatusResponseBody
      @member=
        #<MX::MemberConnectionStatus
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @challenges= [
            #<MX::Challenge
              @field_name= Who is this guy?
              @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              @image_data= Who is this guy?
              @label= Who is this guy?
              @options= [
                #<MX::ChallengeOption
                  @image_data= data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...
                  @label= IMAGE_1
                  @value= image_data
                >          
              ]
              @type= IMAGE_DATA
            >      
          ]
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @has_processed_accounts= true
          @has_processed_transactions= false
          @is_being_aggregated= false
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
        >
    >
    

    Example response for status CHALLENGED

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at":"2016-10-13T18:24:37+00:00",
        "challenges": [
          {
            "field_name": null,
            "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
            "label": "What city were you born in?",
            "type": "TEXT"
          }
        ],
        "connection_status": "CHALLENGED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "has_processed_accounts": false,
        "has_processed_transactions": false,
        "is_being_aggregated": true,
        "status": "CHALLENGED",
        "successfully_aggregated_at": "2016-10-13T18:08:04+00:00"
      }
    }
    
    class MemberConnectionStatusResponseBody {
      Member:
        class MemberConnectionStatus {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            class Challenge {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }      
          ]
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: false
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }      
          ]
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: false
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    class MemberConnectionStatusResponseBody {
      member:
        class MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            class Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }      
          ]
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: false
          isBeingAggregated: false
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    MemberConnectionStatusResponseBody {
      member:
        MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }      
          ]
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: false
          isBeingAggregated: false
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    atrium/model/MemberConnectionStatusResponseBody Object (
      [member] =>
        atrium/model/MemberConnectionStatus Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [challenges] => Array (
            atrium/model/Challenge Object (
              [field_name] => What city were you born in?
              [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              [label] => What city were you born in?
              [type] => TEXT
            )      
          )
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [has_processed_accounts] => true
          [has_processed_transactions] => false
          [is_being_aggregated] => false
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'challenges': [
            {
              'field_name': What city were you born in?
              'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              'label': What city were you born in?
              'type': TEXT
            }      
          ]
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'has_processed_accounts': true
          'has_processed_transactions': false
          'is_being_aggregated': false
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
        }
    }
    
    #<MX::MemberConnectionStatusResponseBody
      @member=
        #<MX::MemberConnectionStatus
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @challenges= [
            #<MX::Challenge
              @field_name= What city were you born in?
              @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              @label= What city were you born in?
              @type= TEXT
            >      
          ]
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @has_processed_accounts= true
          @has_processed_transactions= false
          @is_being_aggregated= false
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
        >
    >
    

    Testing single-question MFA

    Step one: Create a member

    POST /users/{user_guid}/members
    

    Example request

    
    # The login credentials given below will mimic an aggregation challenged by MFA.
    
    $ curl -i -X POST 'https://vestibule.mx.com/users/{user_guid}/members' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member": {
              "institution_code": "mxbank",
              "credentials": [
                {
                  "guid": "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
                  "value": "test_atrium"
                },
                {
                  "guid": "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
                  "value": "challenge"
                }
              ]
            }
          }'
    
    using System;
    using System.Collections.Generic;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class CreateMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberCreateRequestBody(
                  member: new MemberCreateRequest(
                      institutionCode: "mxbank",
                      credentials: new List<CredentialRequest>(){
                          new CredentialRequest(
                              guid: "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
                              value: "test_atrium"
                          ),
                          new CredentialRequest(
                              guid: "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
                              value: "challenge"
                          )
                      }
                  )
                );
    
                try
                {
                    // Create member
                    MemberResponseBody response = client.members.CreateMember(userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.CreateMember: " + e.Message);
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      body := atrium.MemberCreateRequestBody{
        Member: &atrium.MemberCreateRequest{
          InstitutionCode: "mxbank",
          Credentials: [2]CredentialRequest{
            &atrium.CredentialRequest{
              GUID: "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
              Value: "test_atrium"
            },
            &atrium.CredentialRequest{
              GUID: "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
              Value: "challenge"
            }
          }
        }
      }
    
      response, _, err := client.Members.CreateMember(ctx, userGUIDbody)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            List credentials = new ArrayList<CredentialRequest>();
    
            CredentialRequest username = new CredentialRequest();
            username.setGuid("CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1");
            username.setValue("test_atrium");
    
            CredentialRequest password = new CredentialRequest();
            password.setGuid("CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d");
            password.setValue("challenge");
    
            credentials.add(username);
            credentials.add(password);
    
            MemberCreateRequest request = new MemberCreateRequest();
            request.setCredentials(credentials);
            request.setInstitutionCode("mxbank");
    
            MemberCreateRequestBody body = new MemberCreateRequestBody();
            body.setMember(request);
    
            try {
                MemberResponseBody response = client.members.createMember(userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#createMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var username = new atrium.CredentialRequest();
    username.guid = "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1";
    username.value = "test_atrium";
    
    var password = new atrium.CredentialRequest();
    password.guid = "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d";
    password.value = "challenge";
    
    var credentials = [username, password];
    
    var request = new atrium.MemberCreateRequest();
    request.credentials = credentials;
    request.institutionCode = "mxbank";
    
    var body = new atrium.MemberCreateRequestBody();
    body.member = request;
    
    console.log(body);
    
    var response = client.members.createMember(userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberCreateRequestBody(
      array(
        "member" => new \atrium\model\MemberCreateRequest(
          array(
            "institution_code"=>"mxbank",
            "credentials"=>array(
              new \atrium\model\CredentialRequest(
                array(
                  "guid"=>"CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
                  "value"=>"test_atrium"
                )
              ),
              new \atrium\model\CredentialRequest(
                array(
                  "guid"=>"CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
                  "value"=>"challenge"
                )
              )
            )
          )
        )
      )
    );
    
    try {
        $result = $client->members->createMember($user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->createMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    body = atrium.MemberCreateRequestBody(
        member = atrium.MemberCreateRequest(
            institution_code = "mxbank",
            credentials = [
                atrium.CredentialRequest(
                    guid = "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
                    value = "test_atrium"
                ),
                atrium.CredentialRequest(
                    guid = "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
                    value = "challenge"
                )
            ]
        )
    )
    
    try:
        # Create member
        response = client.members.create_member(user_guid, body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->create_member: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    body = Atrium::MemberCreateRequestBody.new(
      :member => Atrium::MemberCreateRequest.new(
        :institution_code => "mxbank",
        :credentials => [
          CredentialRequest.new(
            :guid => "CRD-9f61fb4c-912c-bd1e-b175-ccc7f0275cc1",
            :value => "test_atrium"
          ),
          CredentialRequest.new(
            :guid => "CRD-e3d7ea81-aac7-05e9-fbdd-4b493c6e474d",
            :value => "challenge"
          )
        ]
      )
    )
    
    begin
      #Create member
      response = client.members.create_member(user_guid, body)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->create_member: #{e}"
    end
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2019-01-10T18:26:34Z",
        "connection_status": "CREATED",
        "identifier": null,
        "status": "INITIATED",
        "successfully_aggregated_at": null,
        "guid": "MBR-a4652b66-3ee5-cb9f-295a-72eddef61db5",
        "institution_code": "mxbank",
        "is_being_aggregated": true,
        "metadata": null,
        "name": "MX Bank",
        "user_guid": "USR-72aba5cc-8c74-b22c-227c-4b1c095fa12e"
            }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CREATED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: INITIATED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CREATED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: INITIATED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CREATED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: true
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: INITIATED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CREATED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: true
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: INITIATED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CREATED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => mxbank
          [is_being_aggregated] => true
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => MX Bank
          [status] => INITIATED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CREATED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': mxbank
          'is_being_aggregated': true
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': MX Bank
          'status': INITIATED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CREATED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= mxbank
          @is_being_aggregated= true
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= MX Bank
          @status= INITIATED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Either create a new member to connect to the same MX Bank institution, or use update member to update an existing test member's credentials.

    Step two: Check the member status

    GET /users/{user_guid}/members/{member_guid}/status
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/status' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadMemberStatusExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read member connection status
                    MemberConnectionStatusResponseBody response = client.members.ReadMemberStatus(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ReadMemberStatus: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ReadMemberStatus(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberConnectionStatusResponseBody response = client.members.readMemberStatus(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#readMemberStatus");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.readMemberStatus(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->readMemberStatus($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->readMemberStatus: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read member connection status
        response = client.members.read_member_status(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->read_member_status: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    
    begin
      #Read member connection status
      response = client.members.read_member_status(member_guid, user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->read_member_status: #{e}"
    end
    

    Example response:

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at":"2016-10-13T18:24:37+00:00",
        "challenges": [
          {
            "field_name": null,
            "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
            "label": "What city were you born in?",
            "type": "TEXT"
          }
        ],
        "connection_status": "CHALLENGED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "has_processed_accounts": false,
        "has_processed_transactions": false,
        "is_being_aggregated": true,
        "status": "CHALLENGED",
        "successfully_aggregated_at": "2016-10-13T18:08:04+00:00"
      }
    }
    
    class MemberConnectionStatusResponseBody {
      Member:
        class MemberConnectionStatus {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            class Challenge {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }      
          ]
          ConnectionStatus: CHALLENGED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: false
          HasProcessedTransactions: false
          IsBeingAggregated: true
          Status: CHALLENGED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }      
          ]
          ConnectionStatus: CHALLENGED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: false
          HasProcessedTransactions: false
          IsBeingAggregated: true
          Status: CHALLENGED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    class MemberConnectionStatusResponseBody {
      member:
        class MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            class Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }      
          ]
          connectionStatus: CHALLENGED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: false
          hasProcessedTransactions: false
          isBeingAggregated: true
          status: CHALLENGED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    MemberConnectionStatusResponseBody {
      member:
        MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }      
          ]
          connectionStatus: CHALLENGED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: false
          hasProcessedTransactions: false
          isBeingAggregated: true
          status: CHALLENGED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    atrium/model/MemberConnectionStatusResponseBody Object (
      [member] =>
        atrium/model/MemberConnectionStatus Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [challenges] => Array (
            atrium/model/Challenge Object (
              [field_name] => What city were you born in?
              [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              [label] => What city were you born in?
              [type] => TEXT
            )      
          )
          [connection_status] => CHALLENGED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [has_processed_accounts] => false
          [has_processed_transactions] => false
          [is_being_aggregated] => false
          [status] => CHALLENGED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'challenges': [
            {
              'field_name': What city were you born in?
              'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              'label': What city were you born in?
              'type': TEXT
            }      
          ]
          'connection_status': CHALLENGED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'has_processed_accounts': false
          'has_processed_transactions': false
          'is_being_aggregated': true
          'status': CHALLENGED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
        }
    }
    
    #<MX::MemberConnectionStatusResponseBody
      @member=
        #<MX::MemberConnectionStatus
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @challenges= [
            #<MX::Challenge
              @field_name= What city were you born in?
              @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              @label= What city were you born in?
              @type= TEXT
            >      
          ]
          @connection_status= CHALLENGED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @has_processed_accounts= false
          @has_processed_transactions= false
          @is_being_aggregated= true
          @status= CHALLENGED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
        >
    >
    

    Step three: Resume aggregation

    Answer the MFA question incorrectly. Clearly, the idea is to answer challenges correctly; however, it is still important to test this situation.

    Example request (answering the question incorrectly for testing)

    curl -i -X PUT 'https://vestibule.mx.com/users/{user_guid}/members/MBR-69691bf0-fc09-d876-284e-a8ea0165c04f/resume' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member":{
              "challenges":[
                {
                   "guid": "CRD-f61b2add-df2e-3ac0-b7ee-a7d5cbfad3f7",
                   "value": "asdf"
                }
              ]
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ResumeMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberResumeRequestBody(
                  member new MemberResumeRequest(
                    challenges: new List<ChallengeRequest>(){
                      new ChallengeRequest(
                        guid: "CRD-f61b2add-df2e-3ac0-b7ee-a7d5cbfad3f7",
                        value: "asdf"
                      ),
                    }
                  )
                ); // MemberResumeRequestBody | Member object with MFA challenge answers
    
                try
                {
                    // Resume aggregation from MFA
                    MemberResponseBody response = client.members.ResumeMember(memberGuid, userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ResumeMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      body := atrium.MemberResumeRequestBody{
        Member: &atrium.MemberResumeRequest{
          Challenges: ChallengeRequest{
            &atrium.ChallengeRequest{
              GUID: "CRD-f61b2add-df2e-3ac0-b7ee-a7d5cbfad3f7"
              Value: "asdf"
            }
          }
        }
      } // MemberResumeRequestBody | Member object with MFA challenge answers
    
      response, _, err := client.Members.ResumeMember(ctx, memberGUID, userGUID, body)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            MemberResumeRequestBody body = new MemberResumeRequestBody(); // MemberResumeRequestBody | Member object with MFA challenge answers
    
            try {
                MemberResponseBody response = client.members.resumeMember(memberGuid, userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#resumeMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.MemberResumeRequestBody(); // MemberResumeRequestBody | Member object with MFA challenge answers
    
    var response = client.members.resumeMember(memberGuid, userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberResumeRequestBody(
      array(
        "member" => new \atrium\model\MemberResumeRequest
          array(
            "challenges"=>array(
              "guid"=>"CRD-f61b2add-df2e-3ac0-b7ee-a7d5cbfad3f7",
              "value"=>"asdf"
            )
          )
      )
    ); // \atrium\model\MemberResumeRequestBody | Member object with MFA challenge answers
    
    try {
        $result = $client->members->resumeMember($member_guid, $user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->resumeMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.MemberResumeRequestBody(
      member = atrium.MemberResumeRequest(
        challenges = [
          atrium.ChallengesRequest(
            guid = "CRD-f61b2add-df2e-3ac0-b7ee-a7d5cbfad3f7",
            value = "asdf"
            )
          ]
        )
      ) # MemberResumeRequestBody | Member object with MFA challenge answers
    
    try:
        # Resume aggregation from MFA
        response = client.members.resume_member(member_guid, user_guid, body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->resume_member: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    body = Atrium::MemberResumeRequestBody.new(
      :member => MemberResumeRequest.new(
        :challenges => [
          ChallengesRequest.new(
          guid => "CRD-f61b2add-df2e-3ac0-b7ee-a7d5cbfad3f7",
          value => "asdf"
            )
          ]
        )
      ) # MemberResumeRequestBody | Member object with MFA challenge answers
    
    begin
      #Resume aggregation from MFA
      response = client.members.resume_member(member_guid, user_guidbody)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->resume_member: #{e}"
    end
    

    Response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-09-30T14:31:45-06:00",
        "connection_status": "RESUMED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier":"unique_id",
        "institution_code": "mxbank",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "MX Bank",
        "status": "REQUESTED",
        "successfully_aggregated_at": null,
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: RESUMED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: REQUESTED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: RESUMED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: REQUESTED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: RESUMED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: true
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: REQUESTED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: RESUMED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: true
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: REQUESTED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => RESUMED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => mxbank
          [is_being_aggregated] => true
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => MX Bank
          [status] => REQUESTED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': RESUMED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': mxbank
          'is_being_aggregated': true
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': MX Bank
          'status': REQUESTED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= RESUMED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= mxbank
          @is_being_aggregated= true
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= MX Bank
          @status= REQUESTED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Step four: Poll the member status

    Request

    # Poll the member status to determine next steps.
    curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/MBR-69691bf0-fc09-d876-284e-a8ea0165c04f/status' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadMemberStatusExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read member connection status
                    MemberConnectionStatusResponseBody response = client.members.ReadMemberStatus(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ReadMemberStatus: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ReadMemberStatus(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberConnectionStatusResponseBody response = client.members.readMemberStatus(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#readMemberStatus");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.readMemberStatus(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->readMemberStatus($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->readMemberStatus: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read member connection status
        response = client.members.read_member_status(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->read_member_status: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    
    begin
      #Read member connection status
      response = client.members.read_member_status(member_guid, user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->read_member_status: #{e}"
    end
    

    Response

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at": "2016-10-13T18:07:57+00:00",
        "connection_status": "REJECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "mxbank",
        "is_being_aggregated": false,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "MX Bank",
        "status": "REJECTED",
        "successfully_aggregated_at": "2016-10-13T17:57:38+00:00",
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"    
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: REJECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: REJECTED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: REJECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: false
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: REJECTED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: REJECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: REJECTED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: REJECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: REJECTED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => REJECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => mxbank
          [is_being_aggregated] => false
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => MX Bank
          [status] => REJECTED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': REJECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': mxbank
          'is_being_aggregated': false
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': MX Bank
          'status': Rejected
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= REJECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= mxbank
          @is_being_aggregated= false
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= MX Bank
          @status= REJECTED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Step five: Re-aggregate the member

    $ curl -i -X POST 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/aggregate' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class AggregateMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Aggregate member
                    MemberResponseBody response = client.members.AggregateMember(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.AggregateMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.AggregateMember(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberResponseBody response = client.members.aggregateMember(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#aggregateMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.aggregateMember(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->aggregateMember($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->aggregateMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Aggregate member
        response = client.members.aggregate_member(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->aggregate_member: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    
    begin
      #Aggregate member
      response = client.members.aggregate_member(member_guid, user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->aggregate_member: #{e}"
    end
    

    Example response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-10-13T18:07:57+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier": "unique_id",
        "institution_code": "mxbank",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "MX Bank",
        "status": "INITIATED",
        "successfully_aggregated_at": "2016-10-13T17:57:38+00:00",
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: INITIATED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: INITIATED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: false
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: INITIATED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: true
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: INITIATED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => mxbank
          [is_being_aggregated] => true
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => MX Bank
          [status] => INITIATED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': mxbank
          'is_being_aggregated': true
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': MX Bank
          'status': INITIATED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= mxbank
          @is_being_aggregated= true
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= MX Bank
          @status= INITIATED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Step six: Poll the status again

    GET /users/{user_guid}/members/{member_guid}/status
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/status' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadMemberStatusExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read member connection status
                    MemberConnectionStatusResponseBody response = client.members.ReadMemberStatus(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ReadMemberStatus: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ReadMemberStatus(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberConnectionStatusResponseBody response = client.members.readMemberStatus(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#readMemberStatus");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.readMemberStatus(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->readMemberStatus($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->readMemberStatus: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read member connection status
        response = client.members.read_member_status(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->read_member_status: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    
    begin
      #Read member connection status
      response = client.members.read_member_status(member_guid, user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->read_member_status: #{e}"
    end
    

    Example response:

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at":"2016-10-13T18:24:37+00:00",
        "challenges": [
          {
            "field_name": null,
            "guid": "CRD-1ec152cd-e628-e81a-e852-d1e7104624da",
            "label": "What city were you born in?",
            "type": "TEXT"
          }
        ],
        "connection_status": "CHALLENGED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "has_processed_accounts": false,
        "has_processed_transactions": false,
        "is_being_aggregated": true,
        "status": "CHALLENGED",
        "successfully_aggregated_at": "2016-10-13T18:08:04+00:00"
      }
    }
    
    class MemberConnectionStatusResponseBody {
      Member:
        class MemberConnectionStatus {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            class Challenge {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }      
          ]
          ConnectionStatus: CHALLENGED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: false
          HasProcessedTransactions: false
          IsBeingAggregated: true
          Status: CHALLENGED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          Challenges: [
            {
              FieldName: What city were you born in?
              Guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              Label: What city were you born in?
              Type: TEXT
            }      
          ]
          ConnectionStatus: CHALLENGED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: false
          HasProcessedTransactions: false
          IsBeingAggregated: true
          Status: CHALLENGED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    class MemberConnectionStatusResponseBody {
      member:
        class MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            class Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }      
          ]
          connectionStatus: CHALLENGED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: false
          hasProcessedTransactions: false
          isBeingAggregated: true
          status: CHALLENGED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    MemberConnectionStatusResponseBody {
      member:
        MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          challenges: [
            Challenge {
              fieldName: What city were you born in?
              guid: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              label: What city were you born in?
              type: TEXT
            }      
          ]
          connectionStatus: CHALLENGED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: false
          hasProcessedTransactions: false
          isBeingAggregated: true
          status: CHALLENGED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    atrium/model/MemberConnectionStatusResponseBody Object (
      [member] =>
        atrium/model/MemberConnectionStatus Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [challenges] => Array (
            atrium/model/Challenge Object (
              [field_name] => What city were you born in?
              [guid] => CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              [label] => What city were you born in?
              [type] => TEXT
            )      
          )
          [connection_status] => CHALLENGED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [has_processed_accounts] => false
          [has_processed_transactions] => false
          [is_being_aggregated] => false
          [status] => CHALLENGED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'challenges': [
            {
              'field_name': What city were you born in?
              'guid': CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              'label': What city were you born in?
              'type': TEXT
            }      
          ]
          'connection_status': CHALLENGED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'has_processed_accounts': false
          'has_processed_transactions': false
          'is_being_aggregated': true
          'status': CHALLENGED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
        }
    }
    
    #<MX::MemberConnectionStatusResponseBody
      @member=
        #<MX::MemberConnectionStatus
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @challenges= [
            #<MX::Challenge
              @field_name= What city were you born in?
              @guid= CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
              @label= What city were you born in?
              @type= TEXT
            >      
          ]
          @connection_status= CHALLENGED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @has_processed_accounts= false
          @has_processed_transactions= false
          @is_being_aggregated= true
          @status= CHALLENGED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
        >
    >
    

    Step seven: Answer MFA correctly

    Example request (answering the question correctly for testing)

    curl -i -X PUT 'https://vestibule.mx.com/users/{user_guid}/members/MBR-69691bf0-fc09-d876-284e-a8ea0165c04f/resume' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'Content-Type: application/json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}' \
      -d '{
            "member":{
              "challenges":[
                {
                  "guid": "CRD-9226a95d-1d14-0a28-6907-03b2aed082dc",
                  "value": "correct"
                }
              ]
            }
          }'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ResumeMemberExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
                var body = new MemberResumeRequestBody(
                  member new MemberResumeRequest(
                    challenges: new List<ChallengeRequest>(){
                      new ChallengeRequest(
                        guid: "CRD-9226a95d-1d14-0a28-6907-03b2aed082dc",
                        value: "correct"
                      ),
                    }
                  )
                ); // MemberResumeRequestBody | Member object with MFA challenge answers
    
                try
                {
                    // Resume aggregation from MFA
                    MemberResponseBody response = client.members.ResumeMember(memberGuid, userGuid, body);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ResumeMember: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
      body := atrium.MemberResumeRequestBody{
        Member: &atrium.MemberResumeRequest{
          Challenges: ChallengeRequest{
            &atrium.ChallengeRequest{
              GUID: "CRD-9226a95d-1d14-0a28-6907-03b2aed082dc"
              Value: "correct"
            }
          }
        }
      } // MemberResumeRequestBody | Member object with MFA challenge answers
    
      response, _, err := client.Members.ResumeMember(ctx, memberGUID, userGUID, body)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
            MemberResumeRequestBody body = new MemberResumeRequestBody(); // MemberResumeRequestBody | Member object with MFA challenge answers
    
            try {
                MemberResponseBody response = client.members.resumeMember(memberGuid, userGuid, body);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#resumeMember");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    var body = new atrium.MemberResumeRequestBody(); // MemberResumeRequestBody | Member object with MFA challenge answers
    
    var response = client.members.resumeMember(memberGuid, userGuid, body);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    $body = new \atrium\model\MemberResumeRequestBody(
      array(
        "member" => new \atrium\model\MemberResumeRequest
          array(
            "challenges"=>array(
              "guid"=>"CRD-f61b2add-df2e-3ac0-b7ee-a7d5cbfad3f7",
              "value"=>"correct"
            )
          )
      )
    ); // \atrium\model\MemberResumeRequestBody | Member object with MFA challenge answers
    
    try {
        $result = $client->members->resumeMember($member_guid, $user_guid, $body);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->resumeMember: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    body = atrium.MemberResumeRequestBody(
      member = atrium.MemberResumeRequest(
        challenges = [
          atrium.ChallengesRequest(
            guid = "CRD-9226a95d-1d14-0a28-6907-03b2aed082dc",
            value = "correct"
            )
          ]
        )
      ) # MemberResumeRequestBody | Member object with MFA challenge answers
    
    try:
        # Resume aggregation from MFA
        response = client.members.resume_member(member_guid, user_guid, body)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->resume_member: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    body = Atrium::MemberResumeRequestBody.new(
      :member => MemberResumeRequest.new(
        :challenges => [
          ChallengesRequest.new(
          guid => "CRD-9226a95d-1d14-0a28-6907-03b2aed082dc",
          value => "correct"
            )
          ]
        )
      ) # MemberResumeRequestBody | Member object with MFA challenge answers
    
    begin
      #Resume aggregation from MFA
      response = client.members.resume_member(member_guid, user_guidbody)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->resume_member: #{e}"
    end
    

    Response

    Status: 202 Accepted
    
    {
      "member": {
        "aggregated_at": "2016-09-30T14:31:45-06:00",
        "connection_status": "RESUMED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "identifier":"unique_id",
        "institution_code": "mxbank",
        "is_being_aggregated": true,
        "metadata": "{\"credentials_last_refreshed_at\": \"2015-10-15\"}",
        "name": "MX Bank",
        "status": "REQUESTED",
        "successfully_aggregated_at": null,
        "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54"
      }
    }
    
    class MemberResponseBody {
      Member:
        class Member {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: RESUMED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: REQUESTED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: RESUMED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          Identifier: unique_id
          InstitutionCode: mxbank
          IsBeingAggregated: true
          Metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          Name: MX Bank
          Status: REQUESTED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          UserGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    class MemberResponseBody {
      member:
        class Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: RESUMED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: true
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: REQUESTED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    MemberResponseBody {
      member:
        Member {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: RESUMED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          identifier: unique_id
          institutionCode: mxbank
          isBeingAggregated: true
          metadata: {"credentials_last_refreshed_at": "2015-10-15"}
          name: MX Bank
          status: REQUESTED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
          userGuid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    atrium/model/MemberResponseBody Object (
      [member] =>
        atrium/model/Member Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => RESUMED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [identifier] => unique_id
          [institution_code] => mxbank
          [is_being_aggregated] => true
          [metadata] => {"credentials_last_refreshed_at": "2015-10-15"}
          [name] => MX Bank
          [status] => REQUESTED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
          [user_guid] => USR-fa7537f3-48aa-a683-a02a-b18940482f54
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': RESUMED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'identifier': unique_id
          'institution_code': mxbank
          'is_being_aggregated': true
          'metadata': {"credentials_last_refreshed_at": "2015-10-15"}
          'name': MX Bank
          'status': REQUESTED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
          'user_guid': USR-fa7537f3-48aa-a683-a02a-b18940482f54
        }
    }
    
    #<MX::MemberResponseBody
      @member=
        #<MX::Member
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= RESUMED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @identifier= unique_id
          @institution_code= mxbank
          @is_being_aggregated= true
          @metadata= {"credentials_last_refreshed_at": "2015-10-15"}
          @name= MX Bank
          @status= REQUESTED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
          @user_guid= USR-fa7537f3-48aa-a683-a02a-b18940482f54
        >
    >
    

    Step eight: Poll the status yet again

    Keep polling until the status reaches an end state, e.g., the connection_status is CONNECTED and the is_being_aggregated field is false.

    Request

    GET /users/{user_guid}/members/{member_guid}/status
    

    Example request

    $ curl -i -X GET 'https://vestibule.mx.com/users/{user_guid}/members/{member_guid}/status' \
      -H 'Accept: application/vnd.mx.atrium.v1+json' \
      -H 'MX-API-Key: {mx_api_key}' \
      -H 'MX-Client-ID: {mx_client_id}'
    
    using System;
    using Atrium.Api;
    using Atrium.Model;
    
    namespace Example
    {
        public class ReadMemberStatusExample
        {
            public void main()
            {
                var client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
                var memberGuid = "MBR-123";  // string | The unique identifier for a `member`.
                var userGuid = "USR-123";  // string | The unique identifier for a `user`.
    
                try
                {
                    // Read member connection status
                    MemberConnectionStatusResponseBody response = client.members.ReadMemberStatus(memberGuid, userGuid);
                    Console.WriteLine(response);
                }
                catch (Exception e)
                {
                    Console.WriteLine("Exception when calling MembersApi.ReadMemberStatus: " + e.Message );
                }
            }
        }
    }
    
    package main
    
    import (
      "context"
      "fmt"
      "github.com/mxenabled/atrium-go"
    )
    
    func main() {
      client := atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
      ctx := context.Background()
    
      memberGUID := "MBR-123" // string | The unique identifier for a `member`.
      userGUID := "USR-123" // string | The unique identifier for a `user`.
    
      response, _, err := client.Members.ReadMemberStatus(ctx, memberGUID, userGUID)
      if err != nil {
        fmt.Printf("Error: %v\n", err)
      } else {
        fmt.Printf("Response: %s\n", response)
      }
    }
    
    import com.mx.atrium.*;
    import com.mx.model.*;
    
    public class MembersApiExample {
        public static void main(String[] args) {
            AtriumClient client = new AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
            String memberGuid = "MBR-123"; // String | The unique identifier for a `member`.
            String userGuid = "USR-123"; // String | The unique identifier for a `user`.
    
            try {
                MemberConnectionStatusResponseBody response = client.members.readMemberStatus(memberGuid, userGuid);
                System.out.println(response);
            } catch (ApiException e) {
                System.err.println("Exception when calling MembersApi#readMemberStatus");
                e.printStackTrace();
            }
        }
    }
    
    var atrium = require('./atrium.js');
    
    var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
    
    var memberGuid = "MBR-123"; // string | The unique identifier for a `member`.
    var userGuid = "USR-123"; // string | The unique identifier for a `user`.
    
    var response = client.members.readMemberStatus(memberGuid, userGuid);
    
    response.then(function(value) {
      console.log(value);
    });
    
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    $client = new atrium\Api\AtriumClient(
        "YOUR_API_KEY",
        "YOUR_CLIENT_ID",
        new GuzzleHttp\Client()
    );
    
    $member_guid = "MBR-123"; // string | The unique identifier for a `member`.
    $user_guid = "USR-123"; // string | The unique identifier for a `user`.
    
    try {
        $result = $client->members->readMemberStatus($member_guid, $user_guid);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling MembersApi->readMemberStatus: ', $e->getMessage(), PHP_EOL;
    }
    ?>
    
    from __future__ import print_function
    import time
    import atrium
    from atrium.rest import ApiException
    from pprint import pprint
    
    # create an instance of the AtriumClient
    client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # str | The unique identifier for a `member`.
    user_guid = "USR-123" # str | The unique identifier for a `user`.
    
    try:
        # Read member connection status
        response = client.members.read_member_status(member_guid, user_guid)
        pprint(response)
    except ApiException as e:
        print("Exception when calling MembersApi->read_member_status: %s\n" % e)
    
    # load the gem
    require 'atrium-ruby'
    
    client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
    
    member_guid = "MBR-123" # String | The unique identifier for a `member`.
    user_guid = "USR-123" # String | The unique identifier for a `user`.
    
    begin
      #Read member connection status
      response = client.members.read_member_status(member_guid, user_guid)
      p response
    rescue Atrium::ApiError => e
      puts "Exception when calling MembersApi->read_member_status: #{e}"
    end
    

    Example response:

    Status: 200 OK
    
    {
      "member": {
        "aggregated_at":"2016-10-13T18:24:37+00:00",
        "connection_status": "CONNECTED",
        "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
        "has_processed_accounts": true,
        "has_processed_transactions": true,
        "is_being_aggregated": false,
        "status": "COMPLETED",
        "successfully_aggregated_at": "2016-10-13T18:08:04+00:00"
      }
    }
    
    class MemberConnectionStatusResponseBody {
      Member:
        class MemberConnectionStatus {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: true
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    {
      Member:
        {
          AggregatedAt: 2016-10-13T18:07:57+00:00
          ConnectionStatus: CONNECTED
          Guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          HasProcessedAccounts: true
          HasProcessedTransactions: true
          IsBeingAggregated: false
          Status: COMPLETED
          SuccessfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    class MemberConnectionStatusResponseBody {
      member:
        class MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: true
          isBeingAggregated: false
          status: COMEPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    MemberConnectionStatusResponseBody {
      member:
        MemberConnectionStatus {
          aggregatedAt: 2016-10-13T18:07:57+00:00
          connectionStatus: CONNECTED
          guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          hasProcessedAccounts: true
          hasProcessedTransactions: true
          isBeingAggregated: false
          status: COMPLETED
          successfullyAggregatedAt: 2016-10-13T17:57:38+00:00
        }
    }
    
    atrium/model/MemberConnectionStatusResponseBody Object (
      [member] =>
        atrium/model/MemberConnectionStatus Object (
          [aggregated_at] => 2016-10-13T18:07:57+00:00
          [connection_status] => CONNECTED
          [guid] => MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          [has_processed_accounts] => true
          [has_processed_transactions] => true
          [is_being_aggregated] => false
          [status] => COMPLETED
          [successfully_aggregated_at] => 2016-10-13T17:57:38+00:00
        )
    )
    
    {
      'member':
        {
          'aggregated_at': 2016-10-13T18:07:57+00:00
          'connection_status': CONNECTED
          'guid': MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          'has_processed_accounts': true
          'has_processed_transactions': true
          'is_being_aggregated': false
          'status': COMPLETED
          'successfully_aggregated_at': 2016-10-13T17:57:38+00:00
        }
    }
    
    #<MX::MemberConnectionStatusResponseBody
      @member=
        #<MX::MemberConnectionStatus
          @aggregated_at= 2016-10-13T18:07:57+00:00
          @connection_status= CONNECTED
          @guid= MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          @has_processed_accounts= true
          @has_processed_transactions= true
          @is_being_aggregated= false
          @status= COMPLETED
          @successfully_aggregated_at= 2016-10-13T17:57:38+00:00
        >
    >
    

    Testing multiple-question MFA

    Testing for multiple-question MFA is very similar to single-question MFA explained above for MX bank, and the same general steps should be followed. These are outlined below.

    1. Aggregate the member (or create a new member)
    2. Poll the member connection status.
      • With MX Bank, this will return with a challenge.
    3. Answer the challenge using the resume aggregation endpoint
      • On MX Bank, responding with "value": "challenge" will answer the first question correctly and trigger a follow-up challenge.
    4. Poll the status again
      • This will return another challenge.
    5. Answer the second challenge
      • On MX Bank, answering with "value": "correct" will result in a successful aggregation.
    6. Poll the status until an end state is reached.

    Support

    When you go to contact MX Support, please include the following information for the various member statuses:

    Issue type Associated member status Resolution
    MFA REJECTED
    EXPIRED
    Use the workflows given above to resolve any MFA issues. Contact support only if you have trouble successfully implementing them. If you do contact support, please send the following information:

    • Member GUID;
    • MFA type;
    • Attempted API request and response — with any personally-identifiable information removed.
    Credentials DENIED
    PREVENTED
    IMPAIRED
    Use the workflows given above to resolve credential-related issues. Contact support only if a user can successfully log in to their FI's online portal, but has tried unsuccessfully to update their credentials using Atrium. If you contact support, please send the following information:

    • Member GUID;
    • FI website login URL;
    • Credential character lengths;
    • Screenshots of a successful log in at the FI website.
    FI website LOCKED
    IMPEDED
    End-user action is required to address these situations; the end user must log in to their FI website and address the issue.
    Aggregation issues DEGRADED
    DISCONNECTED
    Most aggregation issues are temporary and resolve themselves within 24 hours. Contact MX Support only after a member has landed on one of these statuses for more than two days. If you do contact support, please send the following information:

    • Member GUID.
    Failed update na If you believe a member is missing transactions or failing to update, please send MX Support the following information:

    • Member GUID;
    • Account GUID;
    • Date, amount, and payee of missing transaction(s);
    •Screenshots of missing transition(s) from FI website.

    Product mailing list

    For updates on new features and developments with Atrium, make sure to check back here and on the documentation website regularly.

    You can also sign up to be notified of important changes by email or RSS at our product website, product.mx.com.