A member represents the relationship between a user and an institution. A user may have multiple members, one each for their bank, their mortgage broker, their credit card provider, etc. Aggregation, verification, and many other processes are centered around a member, meaning this is probably the most important type of object you’ll be working with.


Delete Member

Endpoint: DELETE /users/:user_guid/members/:member_guid

Making a request to this endpoint will permanently delete the specified member.

A successful response will have the status 204 No Content.

Note: You should not use the delete member endpoint to resolve aggregation errors.

Parameters

For the Request

Example Request

curl -X DELETE /users/:user_guid/members/:member_guid \\
  -H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}" \\

Read Member

Endpoint: GET /users/:user_guid/members/:member_guid

This endpoint returns information about the specified member.

Parameters

For the Request

Example Request

curl -X GET /users/:user_guid/members/:member_guid \\
  -H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}" \\

Response