From 0cc72410e330fbce5b1e6778dc626be3e5b892e8 Mon Sep 17 00:00:00 2001 From: Nicki Nixon Date: Tue, 3 Feb 2026 15:10:31 -0700 Subject: [PATCH 1/2] update member create description, add 201 response sample with error object --- openapi/v20250224.yml | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/openapi/v20250224.yml b/openapi/v20250224.yml index fb8a0ea..86e4bc0 100644 --- a/openapi/v20250224.yml +++ b/openapi/v20250224.yml @@ -1509,7 +1509,7 @@ paths: tags: - members post: - description: This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, you'll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions. + description: This endpoint allows you to create a new member using the required parameters `institution_code`, `credentials` (if creating a non-OAuth member), and `data_request.products`. When creating a non-OAuth member, include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data. A status of 200 indicates the member was created successfully, and no aggregation was requested. A status of 201 indicates the member was created, but a product within `data_request` failed to aggregate. A status of 202 indicates the member was successfully created, and standard aggregation (no `data_request`) was requested (does not indicate success or failure). operationId: createMember parameters: - $ref: '#/components/parameters/acceptVersion' @@ -1529,6 +1529,12 @@ paths: schema: $ref: '#/components/schemas/MemberResponseBody' description: OK + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/MemberResponseWithJobErrorBody' + description: Created '202': content: application/json: @@ -6770,6 +6776,29 @@ components: nullable: true type: string type: object + MemberResponseWithJobError: + allOf: + - $ref: '#/components/schemas/MemberResponse' + - type: object + properties: + error: + type: object + properties: + error_type: + type: string + example: "MEMBER" + error_code: + type: integer + example: 3003 + error_message: + type: string + example: "There was an error attempting to process your request. The Member was created but we were unable to fulfill the data request." + user_message: + type: string + example: "We're having trouble connecting right now. Please try again later." + locale: + type: string + example: "en" MembersResponseBody: properties: members: @@ -6810,6 +6839,11 @@ components: member: $ref: '#/components/schemas/MemberResponse' type: object + MemberResponseWithJobErrorBody: + properties: + member: + $ref: '#/components/schemas/MemberResponseWithJobError' + type: object ManagedMemberUpdateRequest: properties: id: From 6a88de7c32034126a8a8814f5466791c9795fbe9 Mon Sep 17 00:00:00 2001 From: Nicki Nixon Date: Tue, 3 Feb 2026 15:36:34 -0700 Subject: [PATCH 2/2] add error nullable to member response --- openapi/v20250224.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/openapi/v20250224.yml b/openapi/v20250224.yml index 86e4bc0..f6f85bf 100644 --- a/openapi/v20250224.yml +++ b/openapi/v20250224.yml @@ -6675,6 +6675,9 @@ components: example: Connected to MX Bank nullable: true type: string + error: + nullable: true + type: object guid: description: The unique identifier for the member. Defined by MX. example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b