A Member represents an individual (i.e. employee) who has access to Recuro Health services.\

Endpoint

https://platform.wellviasolutions.com/user/v1/member\

The Member Object

Attributes

id string : required

The unique identifier of the member.

memberType string : required

The unique type identifier of the member. Possible values can be found in the Member Type Dictionary.

profile object : required

The member's profile.

firstName string : required

The first name of the member.

lastName string : required

The last name of the member.

gender string : required

The gender of the member. Possible values can be found in the Gender Type Dictionary.

dateOfBirth date : optional

The member's date of birth.

mobileNumber string : optional

The member's mobile phone number. Value will be in E-164 format.

emailAddress string : optional

The member's email address.

postalAddress object : optional

The member's postal address.

id string : required

The unique identifier.

type string : required

The unique type identifier. Possible values can be found in the Postal Address Type Dictionary.

addressLine1 string : required

The first line of the address.

addressLine2 string : optional

The second line of the address.

city string : required

The city.

state string : required

The USPS 2 character state abbreviation.

zipCode string : required

The USPS zip code.

countryCode string : required

The country code is in ISO 3166-1 format.

isDefault boolean : required

Specifies if this address is the member's primary address.

sortPriority numeric : optional

Specifies the priority order this address should be listed.

alternativeIds dictionary : optional

A dictionary containing additional unique identifiers for the member.

key string : required

The unique type identifier. Possible values can be found in the Member Identifier Type Dictionary.

value string : required

The unique member identifier.

serviceOfferingId string : required

The unique identifier for the service offering the member is assigned to.

organization object : required

Details about the organizational structure the member belongs to.

clientId string : required

The unique client identifier.

clientName string : required

The client's displayed name.

groupId string : required

The unique group identifier.

groupName string : required

The group's displayed name.

family dictionary : required

A dictionary containing family members under the same account.

key string : required

The unique member identifier.

value string : required

The unique type identifier. Possible values can be found in the Member Type Dictionary.

Example

{
	"id": "mem_3a272fa3c9634ebfab2ef8e494d663fb",
	"type": "primary",
	"profile": {
		"firstName": "John",
		"lastName": "Doe",
		"gender": "M",
		"dateOfBirth": "1970-01-01T00:00:00",
		"emailAddress": "[email protected]",
		"mobileNumber": "+15551234567",
		"postalAddress": {
			"id": null,
			"type": null,
			"addressLine1": "555 Nowhere Ln",
			"addressLine2": "Apt 12",
			"city": "Dallas",
			"state": "TX",
			"zipCode": "75063",
			"countryCode": "US",
			"isDefault": false,
			"sortPriority": null
		}
	},
	"alternativeIds": {
		"clientmemberid": "d6d9c46b6b2d4c12bca09e46d7f4c938",
		"secondaryclientmemberid": "84e214d834984db59fa415a9974f873b",
		"friendlyid": "1234567"
	},
	"serviceOfferingId": "srvo_efb154ed229f4d0b8017f4390d385f23",
	"organization": {
		"clientId": "clnt_6c7e5e4e171b4b929d52e109abc388e7",
		"clientName": "Dunder Mifflin",
		"groupId": "grp_bcbeed73f9a544e28f6714b63e6ee510",
		"groupName": "Scranton Office"
	},
	"family": {
		"mem_3a272fa3c9634ebfab2ef8e494d663fb": "primary",
		"mem_217d89b15f5949dba1742a16c90ddb58": "spouse",
		"mem_bdb779039fe549f9a03749f516d9e42c": "child"
	}
}